feat(COR-683): add api to create, update, delete and list variable en…

…dpoint (#419)

src/openapi.yaml

@@ -103,6 +103,7 @@ tags:
   - name: Referral & Rewards
   - name: Container Registries
   - name: User Sign Up
+  - name: Variable Main Calls
 x-tagGroups:
   - name: Organization
     tags:
@@ -744,10 +745,14 @@ paths:
       $ref: './resources/JobClone.yaml'
   /service/{serviceId}/deploymentStage:
     $ref: './resources/deploymentStage/ServiceDeploymentStage.yaml'
+  /variable:
+    $ref: './resources/variable/Variable.yaml'
   /variable/{variableId}/alias:
     $ref: './resources/variable/VariableAlias.yaml'
   /variable/{variableId}/override:
     $ref: './resources/variable/VariableOverride.yaml'
+  /variable/{variableId}:
+    $ref: './resources/variable/VariableRef.yaml'
   #/organization/{organizationId}/job/preview:
   #/organization/{organizationId}/job/deploy:
 components:

src/resources/variable/Variable.yaml

@@ -0,0 +1,65 @@
+get:
+  summary: 'List variables'
+  description: Returns a list of variables
+  operationId: listVariables
+  parameters:
+    - in: query
+      name: parent_id
+      schema:
+        type: string
+        format: uuid
+      description: the id where the variable will be added
+    - in: query
+      name: scope
+      schema:
+        $ref: '../../schemas/enums/APIVariableScope.yaml'
+      description: the scope of the parent where the variable will be added
+    - in: query
+      name: is_secret
+      schema:
+        type: boolean
+        nullable: true
+        description: true if the variable is a secret
+  tags:
+    - Variable Main Calls
+  responses:
+    '200':
+      description: 'List variables'
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/variable/VariableResponseList.yaml'
+    '401':
+      $ref: '../../responses/NotAuthorized.yaml'
+    '403':
+      $ref: '../../responses/Forbidden.yaml'
+    '404':
+      $ref: '../../responses/NotFound.yaml'
+post:
+  summary: 'Create a variable'
+  description: |
+    - Create a variable at the level defined in the request body.
+  operationId: createVariable
+
+  tags:
+    - Variable Main Calls
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/variable/VariableRequest.yaml'
+  responses:
+    '201':
+      description: 'Create a variable'
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/variable/VariableResponse.yaml'
+    '400':
+      $ref: '../../responses/BadRequest.yaml'
+    '401':
+      $ref: '../../responses/NotAuthorized.yaml'
+    '403':
+      $ref: '../../responses/Forbidden.yaml'
+    '404':
+      $ref: '../../responses/NotFound.yaml'

src/resources/variable/VariableOverride.yaml

@@ -9,7 +9,6 @@ post:
   operationId: createVariableOverride
   parameters:
     - $ref: '../../parameters/path/variableId.yaml'
-
   tags:
     - Variable Main Calls
   requestBody:

src/resources/variable/VariableRef.yaml

@@ -0,0 +1,55 @@
+delete:
+  summary: 'Delete a variable'
+  description: |
+    - To delete a variable
+    - You can't delete a BUILT_IN variable
+    - If you delete a variable having override or alias, the associated override/alias will be deleted as well
+  operationId: deleteVariable
+  parameters:
+    - $ref: '../../parameters/path/variableId.yaml'
+
+  tags:
+    - Variable Main Calls
+  responses:
+    '204':
+      $ref: '../../responses/Deleted.yaml'
+    '401':
+      $ref: '../../responses/NotAuthorized.yaml'
+    '403':
+      $ref: '../../responses/Forbidden.yaml'
+    '404':
+      $ref: '../../responses/NotFound.yaml'
+
+put:
+  summary: 'Edit a variable'
+  description: |
+    - You can't edit a BUILT_IN variable
+    - For an override, you can't edit the key
+    - For an alias, you can't edit the value
+  operationId: editVariable
+  parameters:
+    - $ref: '../../parameters/path/variableId.yaml'
+
+  tags:
+    - Variable Main Calls
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/variable/VariableEditRequest.yaml'
+  responses:
+    '200':
+      description: 'Edited variable value'
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/variable/VariableResponse.yaml'
+    '400':
+      $ref: '../../responses/BadRequest.yaml'
+    '401':
+      $ref: '../../responses/NotAuthorized.yaml'
+    '403':
+      $ref: '../../responses/Forbidden.yaml'
+    '404':
+      $ref: '../../responses/NotFound.yaml'

src/schemas/_index.yaml

@@ -652,8 +652,14 @@ VariableAliasRequest:
   $ref: ./variable/VariableAliasRequest.yaml
 VariableOverrideRequest:
   $ref: ./variable/VariableOverrideRequest.yaml
+VariableRequest:
+  $ref: ./variable/VariableRequest.yaml
+VariableEditRequest:
+  $ref: ./variable/VariableEditRequest.yaml
 VariableResponse:
   $ref: ./variable/VariableResponse.yaml
+VariableResponseList:
+    $ref: ./variable/VariableResponseList.yaml
 VariableAlias:
   $ref: ./variable/VariableAlias.yaml
 VariableOverride:

src/schemas/variable/VariableEditRequest.yaml

@@ -0,0 +1,9 @@
+type: object
+required:
+  - key
+  - value
+properties:
+  key:
+    type: string
+  value:
+    type: string

src/schemas/variable/VariableRequest.yaml

@@ -0,0 +1,22 @@
+type: object
+required:
+  - key
+  - value
+  - is_secret
+  - variable_scope
+  - variable_parent_id
+properties:
+  key:
+    type: string
+  value:
+    type: string
+  mount_path:
+    type: string
+    nullable: true
+  is_secret:
+    type: boolean
+  variable_scope:
+    $ref: '../enums/APIVariableScope.yaml'
+  variable_parent_id:
+    type: string
+    format: uuid

src/schemas/variable/VariableResponseList.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  results:
+    type: array
+    items:
+      $ref: './VariableResponse.yaml'