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): Support App Action Settings API #833

Merged
merged 9 commits into from
Apr 27, 2021
Merged

feat(rest-api-client): Support App Action Settings API #833

merged 9 commits into from
Apr 27, 2021
+302 −10

Conversation

tasshi-me
Copy link
Member

@tasshi-me tasshi-me commented Apr 23, 2021 •
edited by nakajmg
Loading

Why

Action Settings API was released in 2021 Mar update!
https://kintone.cybozu.co.jp/update/main/2021-03.html#point5

What

Get Action Settings

  • implement getAppActions method in AppClient
  • add tests
  • add example scripts
  • write documents

Update Action Settings

  • implement updateAppActions method in AppClient
  • add tests
  • add example scripts
  • write documents

How to test

$ yarn build
$ cd examples/rest-api-client-demo

# test GET /k/v1/app/actions.json
$ yarn run-script app getAppActions
# test GET /k/v1/preview/app/actions.json
$ yarn run-script app getAppActionsPreview
# test PUT /k/v1/preview/app/actions.json
$ yarn run-script app updateAppActions

Checklist

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

@tasshi-me tasshi-me added feature New feature pkg: rest-api-client @kintone/rest-api-client labels Apr 23, 2021
@tasshi-me tasshi-me self-assigned this Apr 23, 2021
@nakajmg nakajmg marked this pull request as ready for review April 23, 2021 07:48
@nakajmg nakajmg requested review from a team, nakajmg and b4h0-c4t and removed request for a team April 23, 2021 07:48
@zaki-yama zaki-yama requested review from zaki-yama and removed request for b4h0-c4t April 27, 2021 00:19
zaki-yama
zaki-yama reviewed Apr 27, 2021
View reviewed changes
packages/rest-api-client/src/client/types/app/action.ts Outdated
[actionName: string]: ActionPropertyForParameter;
};

type ActionProps = {
Copy link
Contributor

Choose a reason for hiding this comment

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

I was a little bit confused because both ActionProps and ActionPropertyForXXX seem to mean the properties for actions.
What about defining these properties (name, index, entities) directly into ActionPropertyForParameter, same as ActionPropertyForResposne ?

Copy link
Member Author

Choose a reason for hiding this comment

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

fixes in 242fbc7

zaki-yama
zaki-yama reviewed Apr 27, 2021
View reviewed changes
Copy link
Contributor

@zaki-yama zaki-yama left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@mshrtsr
Thank you for your great work! 👍
I left a few comments, will you check?

@tasshi-me @zaki-yama
test(data-loader): fix test description
f9a14c2 
Update packages/rest-api-client/src/client/__tests__/AppClient.test.ts

Co-authored-by: Shingo Yamazaki <shingoyamazaki00@gmail.com>
@tasshi-me
Copy link
Member Author

@zaki-yama
Thank you for the review!
I commited some fixes about it.

@zaki-yama
Copy link
Contributor

👍 👍 👍

@zaki-yama zaki-yama merged commit bca0d98 into master Apr 27, 2021
@zaki-yama zaki-yama deleted the feat/action-settings-api branch April 27, 2021 05:26
@shintaroNagata shintaroNagata mentioned this pull request Apr 27, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zaki-yama zaki-yama zaki-yama approved these changes

@nakajmg nakajmg Awaiting requested review from nakajmg

Assignees

@tasshi-me tasshi-me

Labels
feature New feature pkg: rest-api-client @kintone/rest-api-client
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@tasshi-me @zaki-yama @nakajmg