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.

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

feat(rest-api-client): add plugin.getPlugins, getRequiredPlugins, and getApps #2896

Merged
merged 9 commits into from
Aug 2, 2024

Conversation

shabaraba
Copy link
Member

@shabaraba shabaraba commented Jul 25, 2024

Why

  • Support plugin.getPlugins method to be able to get the list of plug-ins imported into Kintone.
  • Support plugin.getRequiredPlugins method to be able to get the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.
  • Support plugin.getApps method to be able to get the list of Apps that have the specified plug-in added. (#2900)

What

  • Add a document for the new methods.
  • Add new unit tests.
  • Add type for Plugin

NOTE: This PR also includes plugin.getApps (#2900)

How to test

  1. prepare installed plug-ins and required plug-ins in Kintone.
  2. run below code and check logs:
import {KintoneRestAPIClient} from '@kintone/rest-api-client';

const client = new KintoneRestAPIClient();

console.log(await client.plugin.getPlugins({
  offset: 0,
  limit: 2
}));

console.log(await client.plugin.getRequiredPlugins({
  offset: 0,
  limit: 2
}));

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 Jul 25, 2024
@shabaraba shabaraba force-pushed the feat/add-method-plugin-getPlugins branch 2 times, most recently from db2e432 to 1538ea5 Compare July 25, 2024 06:55
@shabaraba shabaraba force-pushed the feat/add-method-plugin-getPlugins branch from 1538ea5 to a877613 Compare July 25, 2024 07:10
@shabaraba shabaraba changed the title feat(rest-api-client): add method of plugin.getPlugins feat(rest-api-client): add methods of plugin.getPlugins and plugin.getRequiredPlugins Jul 25, 2024
@shabaraba shabaraba marked this pull request as ready for review July 25, 2024 07:40
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.

レビュー2箇所追加しました!
確認お願いします!

@shabaraba shabaraba requested a review from tasshi-me July 26, 2024 01:13
@tasshi-me tasshi-me changed the title feat(rest-api-client): add methods of plugin.getPlugins and plugin.getRequiredPlugins feat(rest-api-client): add plugin.getPlugins, plugin.getRequiredPlugins, and plugin.getApps Jul 30, 2024
@tasshi-me tasshi-me changed the title feat(rest-api-client): add plugin.getPlugins, plugin.getRequiredPlugins, and plugin.getApps feat(rest-api-client): add plugin.getPlugins, getRequiredPlugins, and getApps Jul 30, 2024
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.

LGTM!

@hisasami hisasami merged commit 4b0d2d2 into main Aug 2, 2024
17 checks passed
@hisasami hisasami deleted the feat/add-method-plugin-getPlugins branch August 2, 2024 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: rest-api-client @kintone/rest-api-client
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants