diff options
Diffstat (limited to 'doc/api/deployments.md')
| -rw-r--r-- | doc/api/deployments.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/deployments.md b/doc/api/deployments.md index b8865ecc614..32d3ab55f9f 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -22,7 +22,7 @@ GET /projects/:id/deployments | `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. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return deployments updated before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `environment` | string | no | The [name of the environment](../ci/environments/index.md#defining-environments) to filter deployments by | +| `environment` | string | no | The [name of the environment](../ci/environments/index.md) to filter deployments by | | `status` | string | no | The status to filter deployments by | The status attribute can be one of the following values: @@ -281,7 +281,7 @@ POST /projects/:id/deployments | 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 | -| `environment` | string | yes | The [name of the environment](../ci/environments/index.md#defining-environments) to create the deployment for | +| `environment` | string | yes | The [name of the environment](../ci/environments/index.md) to create the deployment for | | `sha` | string | yes | The SHA of the commit 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) | |