(api definitions) Document OpenAPI OAuth and clarify parameters #1278
Conversation
devalog
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| ## Multiple security schemes | ||
| ## OAuth client credentials |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'OAuth client credentials' should use sentence-style capitalization.
| <ParamField path="expires-in" type="string" required={false}> | ||
| The property name for the expires in property in the response. | ||
| <ParamField path="response-properties.expires-in" type="string" required={false}> | ||
| The response field name for token expiration time in seconds (e.g., `"expiresIn"`, `"expires_in"`). When present, the SDK automatically refreshes tokens before expiration. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'present' that become outdated
| <ParamField path="type" type="literal<'client-credentials'>" required={true}> | ||
| The OAuth flow type. Currently only `"client-credentials"` is supported. | ||
| <ParamField path="type" type="'client-credentials'" required={true}> | ||
| The OAuth 2.0 grant type. Currently only `"client-credentials"` is supported. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'Currently' that become outdated
| @@ -1,6 +1,6 @@ | |||
| Configuration for the token refresh endpoint. | |||
| Specifies the endpoint that exchanges a refresh token for a new access token. When configured, the SDK automatically uses this endpoint to renew expired tokens without re-sending credentials. If not configured, the SDK will re-authenticate using `get-token` when tokens expire. | |||
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'new' that become outdated
| <ParamField path="access-token" type="string" required={false}> | ||
| The property name for the access token in the response. | ||
| <ParamField path="response-properties.access-token" type="string" required={false}> | ||
| The response field name for the new access token (e.g., `"accessToken"`, `"access_token"`). |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'new' that become outdated
| <ParamField path="expires-in" type="string" required={false}> | ||
| The property name for the expires in property in the response. | ||
| <ParamField path="response-properties.expires-in" type="string" required={false}> | ||
| The response field name for the new token's expiration time in seconds (e.g., `"expiresIn"`, `"expires_in"`). |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'new' that become outdated
| <ParamField path="refresh-token" type="string" required={false}> | ||
| The property name for the refresh token in the response. | ||
| <ParamField path="response-properties.refresh-token" type="string" required={false}> | ||
| The response field name if your API issues a new refresh token with each refresh (token rotation). |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'new' that become outdated
No description provided.