Updated API from documentation release

Author: ct-sdks[bot]

api-specs/connect/api.raml

@@ -114,6 +114,8 @@ resourceTypes: !include types/resource-types.raml
         - [DeploymentUnsupportedRegion](ctp:connect:type:DeploymentUnsupportedRegionError)
         - [DeploymentUnknownApplicationConfiguration](ctp:connect:type:DeploymentUnknownApplicationConfigurationError)
         - [DeploymentUnknownApplicationConfigurationKey](ctp:connect:type:DeploymentUnknownApplicationConfigurationKeyError)
+        - [DeploymentInvalidType](ctp:connect:type:DeploymentInvalidTypeError)
+        - [DeploymentProductionDeactivated](ctp:connect:type:DeploymentProductionDeactivatedError)
       responses:
         201:
           body:

api-specs/connect/examples/deployment/minimal.json

@@ -2,6 +2,7 @@
   "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
   "key": "deployment-key",
   "version": 1,
+  "type": "preview",
   "connector": {
     "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
     "key": "connector-key",

api-specs/connect/examples/deployment/paged.json

@@ -8,6 +8,7 @@
       "id": "13c72c44-7a8e-44f2-a570-b5e991f7021a",
       "key": "deployment-key",
       "version": 1,
+      "type": "preview",
       "connector": {
         "id": "a49aa2c5-15b6-41c4-88af-4b7afdcc07a5",
         "key": "connector-key",

api-specs/connect/types/common.raml

@@ -486,10 +486,12 @@ types:
       Deployment type of the Connector.
     enum:
       - preview
+      - sandbox
       - production
     (annotations.enumDescriptions):
       preview: The deployed Connector is the previewable [ConnectorStaged](ctp:connect:type:ConnectorStaged).
-      production: The deployed Connector is the production [Connector](ctp:connect:type:Connector).
+      sandbox: The [Connector](ctp:connect:type:Connector) is deployed in the sandbox environment.
+      production: The [Connector](ctp:connect:type:Connector) is deployed in the production environment.
   Repository:
     example: !include ../examples/connector/Repository.json
     description: |

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

@@ -9,6 +9,9 @@ properties:
     pattern: ^[A-Za-z0-9_-]+$
     minLength: 2
     maxLength: 256
+  type?:
+    type: common.DeploymentType
+    description: Deployment type. If a [ConnectorStaged](ctp:connect:type:ConnectorStaged) is referenced in the `connector` field, you can send only `preview`. If a [Connector](ctp:connect:type:Connector) is referenced in the `connector` field, the value defaults to `sandbox`. However, you can send `production` when you are ready to deploy the Connector to your production environment.
   connector:
     type: common.ConnectorReference
     description: Reference to the [Connector](ctp:connect:type:Connector) or [ConnectorStaged](ctp:connect:type:ConnectorStaged) being deployed.

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

@@ -15,6 +15,9 @@ properties:
   version:
     type: integer
     description: Current version of the Deployment.
+  type:
+    type: common.DeploymentType
+    description: Deployment type. If a [ConnectorStaged](ctp:connect:type:ConnectorStaged) is referenced in the `connector` field, then the field can only be `preview`. If a [Connector](ctp:connect:type:Connector) is referenced in the `connector` field, then the field can either be `sandbox` or `production`.
   connector:
     type: common.DeploymentConnector
     description: Details of the [Connector](ctp:connect:type:Connector) being deployed.

api-specs/connect/types/error/DeploymentInvalidTypeError.raml

@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(annotations.package): error
+type: ErrorObject
+displayName: DeploymentInvalidTypeError
+discriminatorValue: DeploymentInvalidType
+description: |
+  Returned when the provided [deployment type](ctp:connect:type:DeploymentType) is not valid for the referenced [Connector](ctp:connect:type:Connector).
+
+  The error is returned as a failed response to the [Create a Deployment](ctp:connect:endpoint:/{projectKey}/deployments:POST) request.
+properties:
+  code:
+    type: string
+  message:
+    type: string
+    description: |
+      `"The Connector id=$resourceId or key=$resourceKey cannot be deployed as a '(preview|sandbox|production)' type. Only '(preview|sandbox|production)' types are allowed."`

api-specs/connect/types/error/DeploymentProductionDeactivatedError.raml

@@ -0,0 +1,14 @@
+#%RAML 1.0 DataType
+(annotations.package): error
+type: ErrorObject
+displayName: DeploymentProductionDeactivatedError
+discriminatorValue: DeploymentProductionDeactivated
+description: |
+  Returned as a failed response to the [Create a Deployment](ctp:connect:endpoint:/{projectKey}/deployments:POST) request when deployments to production are disabled for the Project.
+properties:
+  code:
+    type: string
+  message:
+    type: string
+    description: |
+      `"Deployments to production are disabled for this Project. Please contact support to enable production deployments."`

api-specs/connect/types/types.raml

@@ -71,3 +71,5 @@ DeploymentApplicationRequiredError: !include error/DeploymentApplicationRequired
 DeploymentUnknownGlobalConfigurationKeyError: !include error/DeploymentUnknownGlobalConfigurationKeyError.raml
 DeploymentMissingGlobalConfigurationKeyError: !include error/DeploymentMissingGlobalConfigurationKeyError.raml
 DeploymentEmptyRequiredGlobalConfigurationKeyError: !include error/DeploymentEmptyRequiredGlobalConfigurationKeyError.raml
+DeploymentInvalidTypeError: !include error/DeploymentInvalidTypeError.raml
+DeploymentProductionDeactivatedError: !include error/DeploymentProductionDeactivatedError.raml