Skip to content

G
gitlab-ce
Commit a0ce8872 authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski
Browse files
Options

Merge branch 'docs-deployment-api-environment-name' into 'master' 

Add crosslink in deployment api doc

See merge request gitlab-org/gitlab!41730
parents c987beb4 bd785d17
Hide whitespace changes
Inline Side-by-side
Showing with 17 additions and 17 deletions
doc/api/deployments.md
View file @ a0ce8872
...@@ -15,15 +15,15 @@ Get a list of deployments in a project. ...@@ -15,15 +15,15 @@ Get a list of deployments in a project.
GET /projects/:id/deployments GET /projects/:id/deployments
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|-----------|---------|----------|---------------------| |------------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `order_by`| string | no | Return deployments ordered by `id` or `iid` or `created_at` or `updated_at` or `ref` fields. Default is `id` | | `order_by` | string | no | Return deployments ordered by `id` or `iid` or `created_at` or `updated_at` or `ref` fields. Default is `id` |
| `sort` | string | no | Return deployments sorted in `asc` or `desc` order. Default is `asc` | | `sort` | string | no | Return deployments sorted in `asc` or `desc` order. Default is `asc` |
| `updated_after` | datetime | no | Return deployments updated after the specified date | | `updated_after` | datetime | no | Return deployments updated after the specified date |
| `updated_before` | datetime | no | Return deployments updated before the specified date | | `updated_before` | datetime | no | Return deployments updated before the specified date |
| `environment` | string | no | The name of the environment to filter deployments by | | `environment` | string | no | The [name of the environment](../ci/environments/index.md#defining-environments) to filter deployments by |
| `status` | string | no | The status to filter deployments by | | `status` | string | no | The status to filter deployments by |
The status attribute can be one of the following values: The status attribute can be one of the following values:
...@@ -278,14 +278,14 @@ Example of response ...@@ -278,14 +278,14 @@ Example of response
POST /projects/:id/deployments POST /projects/:id/deployments
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
|------------------|----------------|----------|---------------------| |---------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `environment` | string | yes | The name of the environment to create the deployment for | | `environment` | string | yes | The [name of the environment](../ci/environments/index.md#defining-environments) to create the deployment for |
| `sha` | string | yes | The SHA of the commit that is deployed | | `sha` | string | yes | The SHA of the commit that is deployed |
| `ref` | string | yes | The name of the branch or tag that is deployed | | `ref` | string | yes | The name of the branch or tag that is deployed |
| `tag` | boolean | yes | A boolean that indicates if the deployed ref is a tag (true) or not (false) | | `tag` | boolean | yes | A boolean that indicates if the deployed ref is a tag (true) or not (false) |
| `status` | string | yes | The status of the deployment | | `status` | string | yes | The status of the deployment |
The status can be one of the following values: The status can be one of the following values:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7