feat: default and required configurations (#75)

commercetools · Feb 26, 2024 · 84cd456 · 84cd456
1 parent 8fd1695
commit 84cd456
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -173,5 +173,5 @@ deployAs:
 - `endpoint` - Point of entry for respective application component
 - `scripts.postDeploy` - Post-deploy script to execute after the connector deployment process
 - `scripts.preUndeploy` - Pre-undeploy script to execute before the connector undeployment process
-- `configuration` - Definiton of all environment variables needed by the application, customer will be responsible to provide value for these variables when choosen to deploy. You need to choose between `standardConfiguration` and `securedConfiguration`. `standardConfiguration` for customer provided values to be saved as plain text , `securedConfiguration` for customer provided values to be secured and stored in encrypted format
+- `configuration` - Definiton of all environment variables needed by the application, customer will be responsible to provide value for these variables when choosen to deploy. You need to choose between `standardConfiguration` and `securedConfiguration`. `standardConfiguration` for customer provided values to be saved as plain text , `securedConfiguration` for customer provided values to be secured and stored in encrypted format. configurations can be marked `required` depending on application implementation and also provided a `default` value if needed
 - `schedule` - Schedule expression for job applications, it need to be input of type <a href="https://en.wikipedia.org/wiki/Cron">cron</a> expression
diff --git a/application-templates/javascript/connect.yaml b/application-templates/javascript/connect.yaml
@@ -9,15 +9,21 @@ deployAs:
       standardConfiguration:
         - key: CTP_REGION
           description: commercetools Composable Commerce API region
+          required: true
+          default: "europe-west1.gcp"
       securedConfiguration:
         - key: CTP_PROJECT_KEY
           description: commercetools Composable Commerce project key
+          required: true
         - key: CTP_CLIENT_ID
           description: commercetools Composable Commerce client ID
+          required: true
         - key: CTP_CLIENT_SECRET
           description: commercetools Composable Commerce client secret
+          required: true
         - key: CTP_SCOPE
           description: commercetools Composable Commerce client scope
+          required: true
   - name: job
     applicationType: job
     endpoint: /job
@@ -27,15 +33,21 @@ deployAs:
       standardConfiguration:
         - key: CTP_REGION
           description: commercetools Composable Commerce API region
+          required: true
+          default: "europe-west1.gcp"
       securedConfiguration:
         - key: CTP_PROJECT_KEY
           description: commercetools Composable Commerce project key
+          required: true
         - key: CTP_CLIENT_ID
           description: commercetools Composable Commerce client ID
+          required: true
         - key: CTP_CLIENT_SECRET
           description: commercetools Composable Commerce client secret
+          required: true
         - key: CTP_SCOPE
           description: commercetools Composable Commerce client scope
+          required: true
   - name: event
     applicationType: event
     endpoint: /event
@@ -46,15 +58,21 @@ deployAs:
       standardConfiguration:
         - key: CTP_REGION
           description: commercetools Composable Commerce API region
+          required: true
+          default: "europe-west1.gcp"
       securedConfiguration:
         - key: CTP_PROJECT_KEY
           description: commercetools Composable Commerce project key
+          required: true
         - key: CTP_CLIENT_ID
           description: commercetools Composable Commerce client ID
+          required: true
         - key: CTP_CLIENT_SECRET
           description: commercetools Composable Commerce client secret
+          required: true
         - key: CTP_SCOPE
           description: commercetools Composable Commerce client scope
+          required: true
   # - name: merchant-center-custom-application
   #   applicationType: merchant-center-custom-application
   #   endpoint: /

diff --git a/application-templates/typescript/connect.yaml b/application-templates/typescript/connect.yaml
@@ -9,15 +9,21 @@ deployAs:
       standardConfiguration:
         - key: CTP_REGION
           description: commercetools Composable Commerce API region
+          required: true
+          default: "europe-west1.gcp"
       securedConfiguration:
         - key: CTP_PROJECT_KEY
           description: commercetools Composable Commerce project key
+          required: true
         - key: CTP_CLIENT_ID
           description: commercetools Composable Commerce client ID
+          required: true
         - key: CTP_CLIENT_SECRET
           description: commercetools Composable Commerce client secret
+          required: true
         - key: CTP_SCOPE
           description: commercetools Composable Commerce client scope
+          required: true
   - name: job
     applicationType: job
     endpoint: /job
@@ -27,15 +33,21 @@ deployAs:
       standardConfiguration:
         - key: CTP_REGION
           description: commercetools Composable Commerce API region
+          required: true
+          default: "europe-west1.gcp"
       securedConfiguration:
         - key: CTP_PROJECT_KEY
           description: commercetools Composable Commerce project key
+          required: true
         - key: CTP_CLIENT_ID
           description: commercetools Composable Commerce client ID
+          required: true
         - key: CTP_CLIENT_SECRET
           description: commercetools Composable Commerce client secret
+          required: true
         - key: CTP_SCOPE
           description: commercetools Composable Commerce client scope
+          required: true
   - name: event
     applicationType: event
     endpoint: /event
@@ -46,15 +58,21 @@ deployAs:
       standardConfiguration:
         - key: CTP_REGION
           description: commercetools Composable Commerce API region
+          required: true
+          default: "europe-west1.gcp"
       securedConfiguration:
         - key: CTP_PROJECT_KEY
           description: commercetools Composable Commerce project key
+          required: true
         - key: CTP_CLIENT_ID
           description: commercetools Composable Commerce client ID
+          required: true
         - key: CTP_CLIENT_SECRET
           description: commercetools Composable Commerce client secret
+          required: true
         - key: CTP_SCOPE
           description: commercetools Composable Commerce client scope
+          required: true
   # - name: merchant-center-custom-application
   #   applicationType: merchant-center-custom-application
   #   endpoint: /