diff --git a/src/resources/ApplicationEnvironmentVariableAlias.yaml b/src/resources/ApplicationEnvironmentVariableAlias.yaml index fe55f7ff..75bb7615 100644 --- a/src/resources/ApplicationEnvironmentVariableAlias.yaml +++ b/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' diff --git a/src/resources/ApplicationSecretAlias.yaml b/src/resources/ApplicationSecretAlias.yaml index 4513a7cc..e61d20c0 100644 --- a/src/resources/ApplicationSecretAlias.yaml +++ b/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' diff --git a/src/resources/ContainerEnvironmentVariableAlias.yaml b/src/resources/ContainerEnvironmentVariableAlias.yaml index f00f5c7d..cf794e46 100644 --- a/src/resources/ContainerEnvironmentVariableAlias.yaml +++ b/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' diff --git a/src/resources/ContainerSecretAlias.yaml b/src/resources/ContainerSecretAlias.yaml index 0987abaa..810a902a 100644 --- a/src/resources/ContainerSecretAlias.yaml +++ b/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' diff --git a/src/resources/EnvironmentEnvironmentVariableAlias.yaml b/src/resources/EnvironmentEnvironmentVariableAlias.yaml index 040684d8..56c5b0e7 100644 --- a/src/resources/EnvironmentEnvironmentVariableAlias.yaml +++ b/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' diff --git a/src/resources/EnvironmentSecretAlias.yaml b/src/resources/EnvironmentSecretAlias.yaml index 9449bd31..4fa506fe 100644 --- a/src/resources/EnvironmentSecretAlias.yaml +++ b/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' diff --git a/src/resources/ProjectEnvironmentVariableAlias.yaml b/src/resources/ProjectEnvironmentVariableAlias.yaml index c2ed20c4..8a12da05 100644 --- a/src/resources/ProjectEnvironmentVariableAlias.yaml +++ b/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' diff --git a/src/resources/ProjectSecretAlias.yaml b/src/resources/ProjectSecretAlias.yaml index 37eeea86..1564f589 100644 --- a/src/resources/ProjectSecretAlias.yaml +++ b/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' diff --git a/src/resources/job/JobEnvironmentVariableAlias.yaml b/src/resources/job/JobEnvironmentVariableAlias.yaml index adea5018..2b36fa01 100644 --- a/src/resources/job/JobEnvironmentVariableAlias.yaml +++ b/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' diff --git a/src/resources/job/JobSecretAlias.yaml b/src/resources/job/JobSecretAlias.yaml index cf257139..2a6bebd5 100644 --- a/src/resources/job/JobSecretAlias.yaml +++ b/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' diff --git a/src/resources/variable/Variable.yaml b/src/resources/variable/Variable.yaml index 4d6942dd..15fcb90f 100644 --- a/src/resources/variable/Variable.yaml +++ b/src/resources/variable/Variable.yaml @@ -1,6 +1,6 @@ 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 @@ -8,18 +8,18 @@ get: schema: type: string format: uuid - description: the id where the variable will be added + description: it filters the list by returning only the variables accessible by the selected parent_id. This field shall contain the id of a project, environment or service depending on the selected scope. Example, if scope = APPLICATION and parent_id=, the result will contain any variable accessible by the application. The result will contain also any variable declared at an higher scope. - in: query name: scope schema: $ref: '../../schemas/enums/APIVariableScope.yaml' - description: the scope of the parent where the variable will be added + description: the type of the parent_id (application, project, environment etc..). - 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: diff --git a/src/resources/variable/VariableAlias.yaml b/src/resources/variable/VariableAlias.yaml index 3f66f8bf..081676c4 100644 --- a/src/resources/variable/VariableAlias.yaml +++ b/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' diff --git a/src/resources/variable/VariableOverride.yaml b/src/resources/variable/VariableOverride.yaml index 3898da80..c820a5f2 100644 --- a/src/resources/variable/VariableOverride.yaml +++ b/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 diff --git a/src/schemas/variable/VariableAlias.yaml b/src/schemas/variable/VariableAlias.yaml index bdf42e7c..d8025131 100644 --- a/src/schemas/variable/VariableAlias.yaml +++ b/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 diff --git a/src/schemas/variable/VariableAliasRequest.yaml b/src/schemas/variable/VariableAliasRequest.yaml index 6387bcda..f023bd2c 100644 --- a/src/schemas/variable/VariableAliasRequest.yaml +++ b/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. diff --git a/src/schemas/variable/VariableEditRequest.yaml b/src/schemas/variable/VariableEditRequest.yaml index 5d67bce2..34db5b82 100644 --- a/src/schemas/variable/VariableEditRequest.yaml +++ b/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 diff --git a/src/schemas/variable/VariableOverride.yaml b/src/schemas/variable/VariableOverride.yaml index 1ee2d8b4..5e9064d9 100644 --- a/src/schemas/variable/VariableOverride.yaml +++ b/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: diff --git a/src/schemas/variable/VariableOverrideRequest.yaml b/src/schemas/variable/VariableOverrideRequest.yaml index a42d8844..25116b6d 100644 --- a/src/schemas/variable/VariableOverrideRequest.yaml +++ b/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. \ No newline at end of file diff --git a/src/schemas/variable/VariableRequest.yaml b/src/schemas/variable/VariableRequest.yaml index ff9035c5..fd5b6733 100644 --- a/src/schemas/variable/VariableRequest.yaml +++ b/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 diff --git a/src/schemas/variable/VariableResponse.yaml b/src/schemas/variable/VariableResponse.yaml index 7a085c30..dbdd81e9 100644 --- a/src/schemas/variable/VariableResponse.yaml +++ b/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