feat(COR-683): add api to create an override on the variable endpoint (…

…#415)

src/openapi.yaml

@@ -746,6 +746,8 @@ paths:
     $ref: './resources/deploymentStage/ServiceDeploymentStage.yaml'
   /variable/{variableId}/alias:
     $ref: './resources/variable/VariableAlias.yaml'
+  /variable/{variableId}/override:
+    $ref: './resources/variable/VariableOverride.yaml'
   #/organization/{organizationId}/job/preview:
   #/organization/{organizationId}/job/deploy:
 components:

src/resources/variable/VariableAlias.yaml

@@ -1,5 +1,5 @@
 post:
-  summary: 'WIP: Create a variable alias'
+  summary: 'Create a variable alias'
   description: |
     - Allows you to add an alias at the level defined in the request body on an existing variable having a higher scope, in order to customize its key.
     - You have to specify a key in the request body and the scope and the parent id of the alias

src/resources/variable/VariableOverride.yaml

@@ -0,0 +1,34 @@
+post:
+  summary: 'Create a variable override'
+  description: |
+    - Allows you to override a variable that has a higher scope.
+    - You have to specify a value in the request body and the scope and the parent id of the variable to alias
+    - The system will create a new environment variable at project level with the same key as the one corresponding to the variable id in the path
+    - The response body will contain the newly created variable
+    - Information regarding the overridden_variable will be exposed in the "overridden_variable" or in the "overridden_secret" field of the newly created variable
+  operationId: createVariableOverride
+  parameters:
+    - $ref: '../../parameters/path/variableId.yaml'
+
+  tags:
+    - Variable Main Calls
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/variable/VariableOverrideRequest.yaml'
+  responses:
+    '201':
+      description: 'Create variable override'
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/variable/VariableResponse.yaml'
+    '400':
+      description: Can't create an override on a higher scope. Overrides can only be created from one scope to a lower scope. Scope hierarchy is ORGANIZATION > PROJECT > ENVIRONMENT > APPLICATION
+    '401':
+      $ref: '../../responses/NotAuthorized.yaml'
+    '403':
+      $ref: '../../responses/Forbidden.yaml'
+    '404':
+      $ref: '../../responses/NotFound.yaml'

src/schemas/_index.yaml

@@ -650,6 +650,8 @@ WeekdayEnum:
   $ref: ./enums/Weekday.yaml
 VariableAliasRequest:
   $ref: ./variable/VariableAliasRequest.yaml
+VariableOverrideRequest:
+  $ref: ./variable/VariableOverrideRequest.yaml
 VariableResponse:
   $ref: ./variable/VariableResponse.yaml
 VariableAlias:

src/schemas/variable/VariableAliasRequest.yaml

@@ -1,13 +1,13 @@
 type: object
 required:
   - key
-  - aliasScope
-  - aliasParentId
+  - alias_scope
+  - alias_parent_id
 properties:
   key:
     type: string
-  aliasScope:
+  alias_scope:
     $ref: '../enums/APIVariableScope.yaml'
-  aliasParentId:
+  alias_parent_id:
     type: string
     format: uuid

src/schemas/variable/VariableOverrideRequest.yaml

@@ -0,0 +1,13 @@
+type: object
+required:
+  - value
+  - alias_scope
+  - alias_parent_id
+properties:
+  value:
+    type: string
+  alias_scope:
+    $ref: '../enums/APIVariableScope.yaml'
+  alias_parent_id:
+    type: string
+    format: uuid