docs(rest): add descriptions of functions and options #3267
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chihiro-adachi
requested review from
tasshi-me and
shabaraba
and removed request for
a team
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
packages/rest/README.md:143
- Replace the curly quotes with straight quotes for consistency, e.g. 'Please specify "oauth".'
| type | String | Yes | Please specify “oauth”. |
packages/rest/README.md
Outdated
Comment on lines
136
to
143
| | type | String | Yes | Please specify “apiToken”. | | ||
| | apiToken | String or String[] | Yes | You can pass multiple api tokens as an array of string. | | ||
|
|
||
| #### 3. Parameters for [OAuth authentication](https://kintone.dev/en/docs/common/authentication/how-to-add-oauth-clients/) | ||
|
|
||
| | Name | Type | Required | Description | | ||
| |------------|:------:| :------: |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | type | String | Yes | Please specify “oauth”. | |
There was a problem hiding this comment.
Replace the curly quotes with straight quotes for consistency, e.g. 'Please specify "apiToken".'
Suggested change
| | type | String | Yes | Please specify “apiToken”. | | |
| | apiToken | String or String[] | Yes | You can pass multiple api tokens as an array of string. | | |
| #### 3. Parameters for [OAuth authentication](https://kintone.dev/en/docs/common/authentication/how-to-add-oauth-clients/) | |
| | Name | Type | Required | Description | | |
| |------------|:------:| :------: |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |
| | type | String | Yes | Please specify “oauth”. | | |
| | type | String | Yes | Please specify "apiToken". | | |
| | apiToken | String or String[] | Yes | You can pass multiple api tokens as an array of string. | | |
| #### 3. Parameters for [OAuth authentication](https://kintone.dev/en/docs/common/authentication/how-to-add-oauth-clients/) | |
| | Name | Type | Required | Description | | |
| |------------|:------:| :------: |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |
| | type | String | Yes | Please specify "oauth". | |
Copilot uses AI. Check for mistakes.
chihiro-adachi
commented
Apr 10, 2025
| @@ -1,18 +1,17 @@ | |||
| # @kintone/rest | |||
|
|
|||
| [](https://badge.fury.io/js/@kintone%2Frest) | |||
|  | |||
|  | |||
There was a problem hiding this comment.
いったん静的で >= 20 を指定
|
|
||
| | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | | ||
| | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Latest version | Latest version | Latest version | Latest version | |
There was a problem hiding this comment.
Latest versionで問題ないか念の為確認
packages/rest/README.md
Outdated
| | certAuth.pfx | [Buffer](https://nodejs.org/api/buffer.html#buffer_class_buffer) | | The [client certificate file](https://jp.cybozu.help/general/en/user/list_access/remote/webbrowser.html). Required, unless you specify `pfxFilePath`. | | ||
| | certAuth.pfxFilePath | String | | The path to [client certificate file](https://jp.cybozu.help/general/en/user/list_access/remote/webbrowser.html). Required, unless you specify `pfx`. | | ||
| | certAuth.password | String | | The password of client certificate. | | ||
| | proxy | Object | | **This parameter is available only in Node.js environment.**<br />If you use a proxy, please specify its configuration. | |
There was a problem hiding this comment.
rest-api-clientはfalseも指定できたが、restでは不要
packages/rest/README.md
Outdated
| | basicAuth.username | String | | The username of Basic authentication. | | ||
| | basicAuth.password | String | | The password of Basic authentication. | | ||
| | httpsAgent | Object | | **This parameter is available only in Node.js environment.**<br />The custom HTTPS agent to be used when request.<br />The agent should be compatible with [undici.Agent](https://github.com/nodejs/undici/blob/main/docs/docs/api/Agent.md). | | ||
| | certAuth | Object | | **This parameter is available only in Node.js environment.**<br />**When `httpsAgent` parameter is given, this parameter is unavailable.**<br />If your Kintone environment uses [Client Certificate authentication](https://jp.cybozu.help/general/en/admin/list_security/list_access/secureaccess.html), please specify the certificate file and password. | |
There was a problem hiding this comment.
clientCertAuth -> certAuth に変更
There was a problem hiding this comment.
clientCertAuthが正
packages/rest/README.md
Outdated
| | basicAuth | Object | | If your Kintone environment uses Basic authentication, please specify its username and password. | | ||
| | basicAuth.username | String | | The username of Basic authentication. | | ||
| | basicAuth.password | String | | The password of Basic authentication. | | ||
| | httpsAgent | Object | | **This parameter is available only in Node.js environment.**<br />The custom HTTPS agent to be used when request.<br />The agent should be compatible with [undici.Agent](https://github.com/nodejs/undici/blob/main/docs/docs/api/Agent.md). | |
There was a problem hiding this comment.
http.Agent -> undici.Agentに変更
|
|
||
| | Name | Type | Required | Description | | ||
| |----------|:------:|:--------:|----------------------------| | ||
| | type | String | Yes | Please specify "password". | |
There was a problem hiding this comment.
typeパラメータで認証方式を指定するようになったので追加
chihiro-adachi
changed the title
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
shabaraba
approved these changes
Apr 14, 2025
# Conflicts: # packages/rest/README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
What
How to test
Checklist
pnpm lintandpnpm teston the root directory.