diff options
| author | Krasimir Angelov <kangelov@gitlab.com> | 2019-04-29 14:19:50 +1200 |
|---|---|---|
| committer | Krasimir Angelov <kangelov@gitlab.com> | 2019-04-29 14:19:50 +1200 |
| commit | 84bce2d954f6b633dab6ee56fd3c04338dd55c9a (patch) | |
| tree | ccdfc63d19372ff2a4ab41c755b1c37d8e8991d8 | |
| parent | f27780673dbb6fc62f0ada61e0f80d51016dded6 (diff) | |
| download | gitlab-ce-46806-typed-ci-variables.tar.gz | |
Update API docs to unify CI variable type explanations46806-typed-ci-variables
| -rw-r--r-- | doc/api/group_level_variables.md | 2 | ||||
| -rw-r--r-- | doc/api/pipeline_schedules.md | 2 | ||||
| -rw-r--r-- | doc/api/project_level_variables.md | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md index 26c26e5ffdb..7b00df6d775 100644 --- a/doc/api/group_level_variables.md +++ b/doc/api/group_level_variables.md @@ -100,7 +100,7 @@ PUT /groups/:id/variables/:key | `id` | integer/string | yes | The ID of a group or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `key` | string | yes | The `key` of a variable | | `value` | string | yes | The `value` of a variable | -| `variable_type` | string | no | The type of variable, must be one of env_var or file | +| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | | `protected` | boolean | no | Whether the variable is protected | ``` diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index 90b0537eca0..470e55425f8 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -325,7 +325,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key | `pipeline_schedule_id` | integer | yes | The pipeline schedule id | | `key` | string | yes | The `key` of a variable | | `value` | string | yes | The `value` of a variable | -| `variable_type` | string | no | The type of variable, must be one of env_var or file | +| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | ```sh curl --request PUT --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form "value=updated value" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables/NEW_VARIABLE" diff --git a/doc/api/project_level_variables.md b/doc/api/project_level_variables.md index dea1574ce3b..4a6f5624394 100644 --- a/doc/api/project_level_variables.md +++ b/doc/api/project_level_variables.md @@ -69,7 +69,7 @@ POST /projects/:id/variables | `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `key` | string | yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed | | `value` | string | yes | The `value` of a variable | -| `variable_type` | string | no | The type of variable, must be one of env_var or file (default: `env_var`) | +| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | | `protected` | boolean | no | Whether the variable is protected | ``` |