Skip to content

Comments

feat: update plugin api spec#67

Merged
nameless-mc merged 4 commits intomasterfrom
feat/update-plugin-api-spec
Nov 26, 2025
Merged

feat: update plugin api spec#67
nameless-mc merged 4 commits intomasterfrom
feat/update-plugin-api-spec

Conversation

@nameless-mc
Copy link
Contributor

Why

2025年2月9日 kintone API アップデート情報に対応するため。

https://cybozu.dev/ja/kintone/news/api-updates/2025-02/

インストール済みのプラグインの一覧を取得するAPIに以下の仕様変更が追加されました:

  • リクエストパラメーターにidsが追加(最大100件のプラグインIDを指定可能)
  • レスポンスプロパティにdescriptionが追加(プラグインの説明を取得可能)

What

リクエスト側の対応

  • GetInstalledPluginsRequest.javaidsフィールドを追加
    • 最大100件のプラグインIDを指定可能
    • null または空配列の場合はパラメーターが省略される
  • PluginClient.javaに新しいメソッドオーバーロードを追加
    • getInstalledPlugins(List<String> ids): idsのみを指定
    • getInstalledPlugins(List<String> ids, Long offset, Long limit): ids、offset、limitを併用
    • 既存のメソッドもリファクタリングして、すべてのパラメーターが併用可能に

レスポンス側の対応

  • Plugin.javadescriptionフィールドを追加
    • プラグインの説明を格納
    • 未設定の場合は空文字列が返される

JavaDocの対応

  • com.kintone.client.api.pluginパッケージにpackage-info.javaを追加
    • JavaDocにパッケージ説明が表示されるように対応

テストの追加

  • PluginClientTest.javaに以下のテストケースを追加
    • getInstalledPlugins_Request(): idsを含むRequestオブジェクトのテスト(既存テストを更新)
    • getInstalledPlugins_List(): idsのみを指定するテスト
    • getInstalledPlugins_AllParams(): ids、offset、limitをすべて指定するテスト

How to test

Checklist

  • Read CONTRIBUTING.md at the repository.
  • Updated documentation if it is required.
  • Added/updated tests if it is required. (or tested manually)

@nameless-mc nameless-mc self-assigned this Nov 12, 2025
Copilot AI review requested due to automatic review settings November 12, 2025 06:01
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the Plugin API specification to support the kintone API update from February 9, 2025. The changes add support for filtering plugins by IDs and retrieving plugin descriptions.

  • Added ids request parameter to support retrieving up to 100 specific plugins by ID
  • Added description response field to include plugin descriptions in API responses
  • Refactored PluginClient methods to support all parameter combinations while maintaining backward compatibility

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
GetInstalledPluginsRequest.java Added ids field to support filtering by plugin IDs with appropriate documentation
Plugin.java Added description field to store plugin descriptions in response objects
PluginClient.java Added method overloads to support ids parameter and refactored existing methods for parameter flexibility
package-info.java Added JavaDoc package documentation following established codebase patterns
PluginClientTest.java Added comprehensive test coverage for new method overloads and updated existing tests

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nameless-mc nameless-mc merged commit b359c58 into master Nov 26, 2025
8 checks passed
@nameless-mc nameless-mc deleted the feat/update-plugin-api-spec branch November 26, 2025 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants