Skip to content

Commit 21df863

Browse files
committed
Updated API from documentation release
1 parent 38f1853 commit 21df863

File tree

4 files changed

+26
-1
lines changed

4 files changed

+26
-1
lines changed

api-specs/connect/types/common.raml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,23 @@ types:
108108
securedConfiguration?:
109109
type: SecuredConfigurationKey[]
110110
description: Contains the name and description of secret environment variables.
111+
ConnectorApiClient:
112+
description: |
113+
Configuration for generating API Client credentials.
114+
properties:
115+
scopes:
116+
type: string[]
117+
description: List of [scopes](/hosts-and-authorization#authorization) assigned to the API Client.
118+
DeploymentApiClient:
119+
description: |
120+
API Client credentials used for deployment.
121+
properties:
122+
name:
123+
type: string
124+
description: Client ID of the API Client.
125+
scopes:
126+
type: string[]
127+
description: List of [scopes](/hosts-and-authorization#authorization) assigned to the API Client.
111128
DeploymentConfigurationApplication:
112129
description: |
113130
Describes the configuration set of a given application.

api-specs/connect/types/connector/connector-staged.raml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ properties:
3636
globalConfiguration?:
3737
type: common.ConnectorGlobalConfiguration
3838
description: Global configuration applied to all applications in the Deployment.
39+
apiClient?:
40+
type: common.ConnectorApiClient
41+
description: Configuration for the API Client used for generating API Client credentials.
3942
private:
4043
type: boolean
4144
description: If `true`, only Composable Commerce Projects specified in `privateProjects` can access the Connector.

api-specs/connect/types/connector/connector.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ properties:
3333
configurations?:
3434
type: common.ConnectorConfigurationApplication[]
3535
description: Configurations needed by Connectors for hosting. Loaded as environment variables in the application.
36-
# @todo: add apiClient when it's ready to be released
36+
apiClient?:
37+
type: common.ConnectorApiClient
38+
description: Configuration for the API Client used for automatically generating API Client credentials.
3739
private:
3840
type: boolean
3941
description: If `true`, only Composable Commerce Projects specified in `privateProjects` can access the Connector.

api-specs/connect/types/deployment/deployment.raml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ properties:
2121
globalConfiguration?:
2222
type: common.DeploymentGlobalConfiguration
2323
description: Global configuration applied to all applications in the deployment.
24+
apiClient?:
25+
type: common.DeploymentApiClient
26+
description: API Client credentials used for deployment.
2427
details:
2528
type: common.DeploymentDetails
2629
description: Build reference id and outcome of the Deployment.

0 commit comments

Comments
 (0)