Updated API from documentation release

commercetools · May 23, 2024 · 74e57ff · 74e57ff
1 parent e3ea592
commit 74e57ff
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/api-specs/connect/types/common.raml b/api-specs/connect/types/common.raml
@@ -194,7 +194,7 @@ types:
       - Published
       - Failed
   ConnectorReference:
-    description: Reference to a Connector. Either `id` or `key` is required.
+    description: Reference to a [Connector](ctp:connect:type:Connector) or [ConnectorStaged](ctp:connect:type:ConnectorStaged). Either `id` or `key` is required.
     example: !include ../examples/connector/ConnectorReference.json
     properties:
       id?:
@@ -206,7 +206,7 @@ types:
       staged?:
         type: boolean
         default: false
-        description: If `true`, the previewable [ConnectorStaged](ctp:connect:type:ConnectorStaged) will be referenced instead of the published Connector. The `isPreviewable` field of the [ConnectorStaged](ctp:connect:type:ConnectorStaged) must be `true` to reference a previewable ConnectorStaged.
+        description: If `true`, a previewable [ConnectorStaged](ctp:connect:type:ConnectorStaged) must be referenced in `id` or `key` instead of the published Connector. The `isPreviewable` field of the [ConnectorStaged](ctp:connect:type:ConnectorStaged) must be `true` to reference a previewable ConnectorStaged.
       version?:
         type: number
         format: int64
@@ -391,6 +391,10 @@ types:
       - europe-west1.gcp
       - us-central1.gcp
       - australia-southeast1.gcp
+    (annotations.enumDescriptions):
+      europe-west1.gcp: Europe (Google Cloud, Belgium)
+      us-central1.gcp: North America (Google Cloud, Iowa)
+      australia-southeast1.gcp: Australia (Google Cloud, Sydney)
   IntegrationType:
     description: |
       Integration type of the Connector.
@@ -408,6 +412,20 @@ types:
       - analytics
       - shipping
       - other
+    (annotations.enumDescriptions):
+      tax: Tax.
+      marketplace: Marketplace.
+      oms: Order management.
+      psp: Payment service provider.
+      pim: Product information management.
+      promotion: Promotions and loyalty.
+      search: Search.
+      erp: Enterprise resource planning.
+      crm: Customer relationship management.
+      email: Email and marketing.
+      analytics: Analytics.
+      shipping: Shipping and delivery.
+      other: The Connector provides a service or functionality that is not covered by the other values.
   DeploymentType:
     description: |
       Deployment type of the Connector.

diff --git a/api-specs/connect/types/deployment/deployment-draft.raml b/api-specs/connect/types/deployment/deployment-draft.raml
@@ -11,7 +11,7 @@ properties:
     maxLength: 256
   connector:
     type: common.ConnectorReference
-    description: Reference to the [Connector](ctp:connect:type:Connector) being deployed.
+    description: Reference to the [Connector](ctp:connect:type:Connector) or [ConnectorStaged](ctp:connect:type:ConnectorStaged) being deployed.
   configurations?:
     type: common.DeploymentConfigurationApplication[]
     description: Configuration values needed by the [Connector](ctp:connect:type:Connector) for hosting. Keys should match those in the Connector's `configurations` field.