Skip to content

Commit e45c960

Browse files
committed
Updated API from documentation release
1 parent 591d5ea commit e45c960

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

api-specs/api/types/api-client/ApiClient.raml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ properties:
66
id:
77
type: string
88
description: |-
9-
The OAuth2 `client_id` that can be used to [obtain an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
9+
The OAuth2 `client_id` that can be used to [obtain an access token](/../api/authorization#request-an-access-token-using-the-composable-commerce-oauth-20-service).
1010
name:
1111
type: string
1212
description: Name of the APIClient.
1313
scope:
1414
type: string
1515
description: |-
16-
Whitespace-separated list of [OAuth scopes](/../api/scopes) that can be used when [obtaining an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
16+
Whitespace-separated list of [OAuth scopes](/../api/scopes) that can be used when [obtaining an access token](/../api/authorization#request-an-access-token-using-the-composable-commerce-oauth-20-service).
1717
secret?:
1818
type: string
1919
description: |-
2020
Only shown once in the response of creating the APIClient.
21-
This is the OAuth2 `client_secret` that can be used to [obtain an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
21+
This is the OAuth2 `client_secret` that can be used to [obtain an access token](/../api/authorization#request-an-access-token-using-the-composable-commerce-oauth-20-service).
2222
lastUsedAt?:
2323
type: date-only
24-
description: Date of the last day this APIClient was used to [obtain an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
24+
description: Date of the last day this APIClient was used to [obtain an access token](/../api/authorization#request-an-access-token-using-the-composable-commerce-oauth-20-service).
2525
deleteAt?:
2626
type: datetime
2727
description:

api-specs/api/types/api-client/ApiClientDraft.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ properties:
88
description: Name of the APIClient.
99
scope:
1010
type: string
11-
description: Whitespace-separated list of [OAuth scopes](/../api/scopes) that can be used when [obtaining an access token](/../api/authorization#requesting-an-access-token-using-the-composable-commerce-oauth-20-service).
11+
description: Whitespace-separated list of [OAuth scopes](/../api/scopes) that can be used when [obtaining an access token](/../api/authorization#request-an-access-token-using-the-composable-commerce-oauth-20-service).
1212
deleteDaysAfterCreation?:
1313
type: number
1414
format: int64

api-specs/api/types/error/ExternalOAuthFailedError.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: ErrorObject
44
displayName: ExternalOAuthFailedError
55
discriminatorValue: ExternalOAuthFailed
66
description: |
7-
Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
7+
Returned when an [external OAuth Introspection endpoint](/../api/authorization#request-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
88
properties:
99
code:
1010
type: string

api-specs/api/types/error/graphql/GraphQLExternalOAuthFailedError.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: GraphQLErrorObject
44
displayName: GraphQLExternalOAuthFailedError
55
discriminatorValue: ExternalOAuthFailed
66
description: |
7-
Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
7+
Returned when an [external OAuth Introspection endpoint](/../api/authorization#request-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
88
properties:
99
code:
1010
type: string

api-specs/api/types/project/ExternalOAuth.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
displayName: ExternalOAuth
44
type: object
55
description: |
6-
Represents a RFC 7662 compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint. For more information, see [Requesting an access token using an external OAuth 2.0 server](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server).
6+
Represents a RFC 7662 compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint. For more information, see [Requesting an access token using an external OAuth 2.0 server](/../api/authorization#request-an-access-token-using-an-external-oauth-server).
77
88
You can only configure **one** external OAuth 2.0 endpoint per Project. To authenticate using multiple external services (such as social network logins), use a middle layer authentication service.
99
properties:

0 commit comments

Comments
 (0)