summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorShinya Maeda <gitlab.shinyamaeda@gmail.com>2017-03-30 18:39:46 +0900
committerShinya Maeda <gitlab.shinyamaeda@gmail.com>2017-05-03 02:11:51 +0900
commit4bd0d8e433cdffba9e28a24657104eb2b0b0e761 (patch)
tree0689955b445618401c10ead0109c95a6445915fd /doc
parentfda48d3091cefeb8c981fcb689ca1ed94f841958 (diff)
downloadgitlab-ce-4bd0d8e433cdffba9e28a24657104eb2b0b0e761.tar.gz
Adopt awesome axil idea
Diffstat (limited to 'doc')
-rw-r--r--doc/api/pipelines.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md
index 06307158e82..733c9479ec2 100644
--- a/doc/api/pipelines.md
+++ b/doc/api/pipelines.md
@@ -17,8 +17,8 @@ GET /projects/:id/pipelines
| `yaml_errors`| boolean | no | Returns pipelines which have an error of gitlab-ci.yml |
| `name`| string | no | The name of user who triggered pipelines |
| `username`| string | no | The username of user who triggered pipelines |
-| `order_by`| string | no | Return requests ordered by `id`, `status`, `ref`, or `user_id` fields. Default is `id` |
-| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` |
+| `order_by`| string | no | Return requests ordered by `id`, `status`, `ref`, or `user_id`. Default is `id`. Can be combined with `sort`. If you omit `sort`, its default value is used (`desc`) |
+| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc`. Can be combined with `order_by`. If you omit `order_by`, its default value is used (`id`) |
```
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines"