Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(rest-api-client): add get and update methods for admin notes #2849

Merged
merged 6 commits into from
Jul 24, 2024
Merged

feat(rest-api-client): add get and update methods for admin notes #2849

merged 6 commits into from
Jul 24, 2024

Conversation

shabaraba
Copy link
Member

@shabaraba shabaraba commented Jun 28, 2024 •
edited
Loading

Why

  • Support app.getAdminNotes method to be able to get a app admin notes.
  • Support app.updateAdminNotes method to be able to update the app admin notes.

What

  • Add new methods, app.getAdminNotes and app.updateAdminNotes
  • Add unit test
    • When I run pnpm fix, I faced the warning as below in AppClientTest:
      Arrow function has too many statements (41). Maximum allowed is 40 max-statements
      So I implemented the new unit tests separately from the existing root description method.
  • Add demo script
  • Add type for AdminNotes

How to test

Check test spec.

Checklist

  • Read CONTRIBUTING.md
  • Updated documentation if it is required.
  • Added tests if it is required.
  • Passed pnpm lint and pnpm test on the root directory.

@github-actions github-actions bot added the pkg: rest-api-client @kintone/rest-api-client label Jun 28, 2024
@shabaraba shabaraba force-pushed the feat/add-get-admin-notes-method branch from 89670b3 to 88a61d8 Compare June 28, 2024 12:58
@shabaraba shabaraba marked this pull request as ready for review June 28, 2024 13:00
@shabaraba shabaraba requested a review from tasshi-me June 28, 2024 13:02
tasshi-me
tasshi-me requested changes Jul 1, 2024
View reviewed changes
Copy link
Member

@tasshi-me tasshi-me left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some nitpick reviews.

In addition, can I ask you to rename the PR title to follow the conventional commit?

e.g. feat(rest-api-client): add get and update methods for admin notes

packages/rest-api-client/src/client/types/app/adminNotes.ts Outdated Show resolved Hide resolved
packages/rest-api-client/src/client/__tests__/AppClient.test.ts Outdated Show resolved Hide resolved
@shabaraba shabaraba changed the title Feat/add get and update method for admin notes feat(rest-api-client): add get and update methods for admin notes Jul 2, 2024
shabaraba and others added 4 commits July 2, 2024 10:39
@shabaraba
feat(rest-api-client): add app.getAdminNotes method
5c470a2
@shabaraba
feat(rest-api-client): add app.updateAdminNotes method
bedce26
@shabaraba @tasshi-me
fix(rest-api-client): fix type name
9a91117 
Co-authored-by: tasshi / Masaharu Tashiro <33759872+tasshi-me@users.noreply.github.com>
@shabaraba @tasshi-me
chore(rest-api-client): rewrite test describe
feb0ff1 
Co-authored-by: tasshi / Masaharu Tashiro <33759872+tasshi-me@users.noreply.github.com>
@shabaraba shabaraba force-pushed the feat/add-get-admin-notes-method branch from 5da38ab to feb0ff1 Compare July 2, 2024 01:41
@shabaraba shabaraba requested a review from tasshi-me July 4, 2024 02:15
@shabaraba shabaraba force-pushed the feat/add-get-admin-notes-method branch from fc150c9 to 50106ed Compare July 24, 2024 02:27
@shabaraba shabaraba merged commit 2a298e1 into main Jul 24, 2024
17 checks passed
@shabaraba shabaraba deleted the feat/add-get-admin-notes-method branch July 24, 2024 04:27
@trigger-github-actions-release trigger-github-actions-release bot mentioned this pull request Jul 24, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tasshi-me tasshi-me tasshi-me approved these changes

Assignees
No one assigned
Labels
pkg: rest-api-client @kintone/rest-api-client
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shabaraba @tasshi-me