Updated API from documentation release

commercetools · Jan 16, 2025 · 21df863 · 21df863
1 parent 38f1853
commit 21df863
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/api-specs/connect/types/common.raml b/api-specs/connect/types/common.raml
@@ -108,6 +108,23 @@ types:
       securedConfiguration?:
         type: SecuredConfigurationKey[]
         description: Contains the name and description of secret environment variables.
+  ConnectorApiClient:
+    description: |
+      Configuration for generating API Client credentials.
+    properties:
+      scopes:
+        type: string[]
+        description: List of [scopes](/hosts-and-authorization#authorization) assigned to the API Client.
+  DeploymentApiClient:
+    description: |
+      API Client credentials used for deployment.
+    properties:
+      name:
+        type: string
+        description: Client ID of the API Client.
+      scopes:
+        type: string[]
+        description: List of [scopes](/hosts-and-authorization#authorization) assigned to the API Client.
   DeploymentConfigurationApplication:
     description: |
       Describes the configuration set of a given application.

diff --git a/api-specs/connect/types/connector/connector-staged.raml b/api-specs/connect/types/connector/connector-staged.raml
@@ -36,6 +36,9 @@ properties:
   globalConfiguration?:
     type: common.ConnectorGlobalConfiguration
     description: Global configuration applied to all applications in the Deployment.
+  apiClient?:
+    type: common.ConnectorApiClient
+    description: Configuration for the API Client used for generating API Client credentials.
   private:
     type: boolean
     description: If `true`, only Composable Commerce Projects specified in `privateProjects` can access the Connector.

diff --git a/api-specs/connect/types/connector/connector.raml b/api-specs/connect/types/connector/connector.raml
@@ -33,7 +33,9 @@ properties:
   configurations?:
     type: common.ConnectorConfigurationApplication[]
     description: Configurations needed by Connectors for hosting. Loaded as environment variables in the application.
-  # @todo: add apiClient when it's ready to be released
+  apiClient?:
+    type: common.ConnectorApiClient
+    description: Configuration for the API Client used for automatically generating API Client credentials.
   private:
     type: boolean
     description: If `true`, only Composable Commerce Projects specified in `privateProjects` can access the Connector.

diff --git a/api-specs/connect/types/deployment/deployment.raml b/api-specs/connect/types/deployment/deployment.raml
@@ -21,6 +21,9 @@ properties:
   globalConfiguration?:
     type: common.DeploymentGlobalConfiguration
     description: Global configuration applied to all applications in the deployment.
+  apiClient?:
+    type: common.DeploymentApiClient
+    description: API Client credentials used for deployment.
   details:
     type: common.DeploymentDetails
     description: Build reference id and outcome of the Deployment.