fixed text

src/resources/ApplicationEnvironmentVariableAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new environment variable at application level with the same value as the one corresponding to the variable id in the path
     - The response body will contain the newly created variable
     - Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createApplicationEnvironmentVariableAlias
   parameters:
     - $ref: '../parameters/path/applicationId.yaml'

src/resources/ApplicationSecretAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new secret at application level with the same value as the one corresponding to the secret id in the path
     - The response body will contain the newly created secret
     - Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createApplicationSecretAlias
   parameters:
     - $ref: '../parameters/path/applicationId.yaml'

src/resources/ContainerEnvironmentVariableAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new environment variable at container level with the same value as the one corresponding to the variable id in the path
     - The response body will contain the newly created variable
     - Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createContainerEnvironmentVariableAlias
   parameters:
     - $ref: '../parameters/path/containerId.yaml'

src/resources/ContainerSecretAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new secret at container level with the same value as the one corresponding to the secret id in the path
     - The response body will contain the newly created secret
     - Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createContainerSecretAlias
   parameters:
     - $ref: '../parameters/path/containerId.yaml'

src/resources/EnvironmentEnvironmentVariableAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new environment variable at environment level with the same value as the one corresponding to the variable id in the path
     - The response body will contain the newly created variable
     - Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createEnvironmentEnvironmentVariableAlias
   parameters:
     - $ref: '../parameters/path/environmentId.yaml'

src/resources/EnvironmentSecretAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new secret at environment level with the same value as the one corresponding to the secret id in the path
     - The response body will contain the newly created secret
     - Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createEnvironmentSecretAlias
   parameters:
     - $ref: '../parameters/path/environmentId.yaml'

src/resources/ProjectEnvironmentVariableAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new environment variable at project level with the same value as the one corresponding to the variable id in the path
     - The response body will contain the newly created variable
     - Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createProjectEnvironmentVariableAlias
   parameters:
     - $ref: '../parameters/path/projectId.yaml'

src/resources/ProjectSecretAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new secret at project level with the same value as the one corresponding to the secret id in the path
     - The response body will contain the newly created secret
     - Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createProjectSecretAlias
   parameters:
     - $ref: '../parameters/path/projectId.yaml'

src/resources/job/JobEnvironmentVariableAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new environment variable at job level with the same value as the one corresponding to the variable id in the path
     - The response body will contain the newly created variable
     - Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createJobEnvironmentVariableAlias
   parameters:
     - $ref: '../../parameters/path/jobId.yaml'

src/resources/job/JobSecretAlias.yaml

@@ -6,7 +6,7 @@ post:
     - The system will create a new secret at job level with the same value as the one corresponding to the secret id in the path
     - The response body will contain the newly created secret
     - Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createJobSecretAlias
   parameters:
     - $ref: '../../parameters/path/jobId.yaml'

src/resources/variable/Variable.yaml

@@ -1,25 +1,25 @@
 get:
   summary: 'List variables'
-  description: Returns a list of variables
+  description: Returns a list of variables. The result can be filtered by using the query parameters.
   operationId: listVariables
   parameters:
     - in: query
       name: parent_id
       schema:
         type: string
         format: uuid
-      description: the id where the variable will be added
+      description: it filters the list by returning only the variables available to the selected parent_id (parent_id is the id of an application, cronjob or lifecycle job)
     - in: query
       name: scope
       schema:
         $ref: '../../schemas/enums/APIVariableScope.yaml'
-      description: the scope of the parent where the variable will be added
+      description: it filters the list by returning only the variables having the selected scope
     - in: query
       name: is_secret
       schema:
         type: boolean
         nullable: true
-        description: true if the variable is a secret
+        description: it filters the list by returning only the variables of type secret or not
   tags:
     - Variable Main Calls
   responses:
@@ -38,7 +38,7 @@ get:
 post:
   summary: 'Create a variable'
   description: |
-    - Create a variable at the level defined in the request body.
+    - Create a variable with the scope defined in the request body.
   operationId: createVariable
 
   tags:

src/resources/variable/VariableAlias.yaml

@@ -1,12 +1,12 @@
 post:
   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
-    - The system will create a new variable at the requested level with the same value as the one corresponding to the variable id in the path
+    - Allows you to create an alias of one of the existing variables.
+    - You have to specify an alias (key) in the request body, the scope and the parent id of the alias (project id, environment id or service id)
+    - The system will create a new variable at the requested level with the same value as the one corresponding to the variable id passed as path parameter.
     - The response body will contain the newly created variable
     - Information regarding the aliased_variable will be exposed in the "aliased_variable" or in the "aliased_secret" field of the newly created variable
-    - Only 1 alias level is allowed. You can't create an alias on an alias
+    - You can't create an alias on an alias
   operationId: createVariableAlias
   parameters:
     - $ref: '../../parameters/path/variableId.yaml'

src/resources/variable/VariableOverride.yaml

@@ -2,8 +2,8 @@ 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
+    - You have to specify a value (override) in the request body and the scope and the parent id of the variable to override (project id, environment id or service id)
+    - The system will create a new environment variable at the requested level with the same key as the one corresponding to the variable id passed as path parameter.
     - 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

src/schemas/variable/VariableAlias.yaml

@@ -11,7 +11,7 @@ properties:
     format: uuid
   key:
     type: string
-    example: QOVERY_DATABASE_PSQL_NAME
+    example: DATABASE_PSQL_NAME
   value:
     type: string
     nullable: true

src/schemas/variable/VariableAliasRequest.yaml

@@ -6,8 +6,10 @@ required:
 properties:
   key:
     type: string
+    description: the value to be used as Alias of the targeted environment variable.
   alias_scope:
     $ref: '../enums/APIVariableScope.yaml'
   alias_parent_id:
     type: string
     format: uuid
+    description: the id of the variable that is aliased.

src/schemas/variable/VariableEditRequest.yaml

@@ -5,5 +5,7 @@ required:
 properties:
   key:
     type: string
+    description: the key of the environment variable
   value:
     type: string
+    description: the value of the environment variable

src/schemas/variable/VariableOverride.yaml

@@ -9,13 +9,17 @@ properties:
   id:
     type: string
     format: uuid
+    description: The id of the overriden variable
   key:
     type: string
+    description: The key of the overriden variable
   value:
     type: string
     nullable: true
+    description: The value of the overriden variable
   mount_path:
     type: string
+    description: The mounth path of the overriden variable (only if environment variable type is 'file')
   scope:
     $ref: '../enums/APIVariableScope.yaml'
   variable_type:

src/schemas/variable/VariableOverrideRequest.yaml

@@ -1,13 +1,15 @@
 type: object
 required:
   - value
-  - alias_scope
-  - alias_parent_id
+  - override_scope
+  - override_parent_id
 properties:
   value:
     type: string
-  alias_scope:
+    description: the value to be used as Override of the targeted environment variable.
+  override_scope:
     $ref: '../enums/APIVariableScope.yaml'
-  alias_parent_id:
+  override_parent_id:
     type: string
     format: uuid
+    description: the id of the variable that is aliased.

src/schemas/variable/VariableRequest.yaml

@@ -8,15 +8,20 @@ required:
 properties:
   key:
     type: string
+    description: the key of the environment variable
   value:
     type: string
+    description: the value of the environment variable
   mount_path:
     type: string
     nullable: true
+    description: the path where the file will be mounted (only if type =file)
   is_secret:
     type: boolean
+    description: if true, the variable will be considered as a secret and will not be accessible after its creation. Only your applications will be able to access its value at build and run time.
   variable_scope:
     $ref: '../enums/APIVariableScope.yaml'
   variable_parent_id:
     type: string
     format: uuid
+    description: based on the selected scope, it contains the ID of the service, environment or project where the variable is attached 

src/schemas/variable/VariableResponse.yaml

@@ -15,10 +15,10 @@ allOf:
       service_id:
         type: string
         format: uuid
-        description: present only for `BUILT_IN` variable
+        description: The id of the service referenced by this variable. present only for `BUILT_IN` variable
       service_name:
         type: string
-        description: present only for `BUILT_IN` variable
+        description: The name of the service referenced by this variable. present only for `BUILT_IN` variable
       service_type:
         $ref: '../enums/LinkedServiceType.yaml'
         description: present only for `BUILT_IN` variable