diff options
author | Jacopo <beschi.jacopo@gmail.com> | 2018-01-11 19:45:35 +0300 |
---|---|---|
committer | Jacopo <beschi.jacopo@gmail.com> | 2018-01-17 10:47:55 +0300 |
commit | 310d209b67938acdb1cde3cf5622440bf42c5bc4 (patch) | |
tree | 0b2881440a8f02a2f2e964946984ec3ab7f5fea2 /doc/api | |
parent | 3228ac06a019c9126b965ff32e354d10011a4f76 (diff) |
Adds sorting to deployments API
Adds sorting to deployments API through the `order_by` and sort
`fields`.
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/deployments.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/api/deployments.md b/doc/api/deployments.md index ab9e63e01d3..fd11894ea8f 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -11,6 +11,8 @@ GET /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 | +| `order_by`| string | no | Return deployments ordered by `id` or `iid` or `created_at` or `ref` fields. Default is `id` | +| `sort` | string | no | Return deployments sorted in `asc` or `desc` order. Default is `asc` | ```bash curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/deployments" |