diff --git a/api-specs/connect/examples/connector/ConfigurationKey.json b/api-specs/connect/examples/connector/ConfigurationKey.json
deleted file mode 100644
index 7474fd045..000000000
--- a/api-specs/connect/examples/connector/ConfigurationKey.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "key": "CONFIG_KEY",
- "description": "config key description"
-}
diff --git a/api-specs/connect/examples/connector/ConfigurationKeySecured.json b/api-specs/connect/examples/connector/ConfigurationKeySecured.json
new file mode 100644
index 000000000..48e905253
--- /dev/null
+++ b/api-specs/connect/examples/connector/ConfigurationKeySecured.json
@@ -0,0 +1,5 @@
+{
+ "key": "SECURED_CONFIG_KEY",
+ "description": "secure config key description",
+ "required": true
+}
diff --git a/api-specs/connect/examples/connector/ConfigurationKeyStandard.json b/api-specs/connect/examples/connector/ConfigurationKeyStandard.json
new file mode 100644
index 000000000..ae45a032c
--- /dev/null
+++ b/api-specs/connect/examples/connector/ConfigurationKeyStandard.json
@@ -0,0 +1,5 @@
+{
+ "key": "CONFIG_KEY",
+ "description": "config key description",
+ "default": "this is the default value"
+}
diff --git a/api-specs/connect/ruleset.xml b/api-specs/connect/ruleset.xml
index d9b3b3af4..1dd537276 100644
--- a/api-specs/connect/ruleset.xml
+++ b/api-specs/connect/ruleset.xml
@@ -18,6 +18,7 @@
com.commercetools.rmf.validators.DatetimeRule
+
diff --git a/api-specs/connect/types/common.raml b/api-specs/connect/types/common.raml
index 4da946ff6..8d59855aa 100644
--- a/api-specs/connect/types/common.raml
+++ b/api-specs/connect/types/common.raml
@@ -31,8 +31,28 @@ types:
comment:
type: string
description: The body text of the comment.
- ConfigurationKey:
- example: !include ../examples/connector/ConfigurationKey.json
+ ConfigurationKeyStandard:
+ example: !include ../examples/connector/ConfigurationKeyStandard.json
+ description: |
+ The name, description, and default value of a standard environment variable.
+ properties:
+ key:
+ type: string
+ description: Name of the environment variable.
+ description:
+ type: string
+ description: Description of the environment variable.
+ default?:
+ type: string
+ description: Default value of the environment variable.
+ required?:
+ type: boolean
+ description: Indicates if the environment variable is required.
+ default: false
+ ConfigurationKeySecured:
+ example: !include ../examples/connector/ConfigurationKeySecured.json
+ description: |
+ The name and description of a secret environment variable.
properties:
key:
type: string
@@ -40,6 +60,10 @@ types:
description:
type: string
description: Description of the environment variable.
+ required?:
+ type: boolean
+ description: Indicates if the environment variable is required.
+ default: false
ConfigurationValue:
example: !include ../examples/deployment/ConfigurationValue.json
properties:
@@ -64,11 +88,12 @@ types:
- service
- event
- job
+ - mc-app
standardConfiguration:
- type: ConfigurationKey[]
- description: Contains the name and description of standard environment variables.
+ type: ConfigurationKeyStandard[]
+ description: Contains the name, description, and default values of standard environment variables.
securedConfiguration:
- type: ConfigurationKey[]
+ type: ConfigurationKeySecured[]
description: Contains the name and description of secret environment variables.
DeploymentConfigurationApplication:
description: |