diff options
| author | Shinya Maeda <gitlab.shinyamaeda@gmail.com> | 2017-03-07 21:36:08 +0900 |
|---|---|---|
| committer | Shinya Maeda <gitlab.shinyamaeda@gmail.com> | 2017-05-03 02:11:50 +0900 |
| commit | 7e421e55233bbb26594de2a88e62854b468fb02a (patch) | |
| tree | d74ec3eab57de2878736ed80400d1818cce8248e /doc/api/pipelines.md | |
| parent | fa64da65e7205b101569a3e515a0a65ae2d679c9 (diff) | |
| download | gitlab-ce-7e421e55233bbb26594de2a88e62854b468fb02a.tar.gz | |
Fix inappropriate words in doc
Diffstat (limited to 'doc/api/pipelines.md')
| -rw-r--r-- | doc/api/pipelines.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 677b96c74cc..48e0d10180b 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -14,10 +14,10 @@ GET /projects/:id/pipelines | `scope` | string | no | The scope of pipelines, one of: `running`, `pending`, `finished`, `branches`, `tags`; | | `status` | string | no | The status of pipelines, one of: `running`, `pending`, `success`, `failed`, `canceled`, `skipped`; | | `ref` | string | no | The ref of pipelines | -| `yaml_errors`| string | no | If true, Returns only yaml error pipelines | +| `yaml_errors`| string | no | If true, returns only yaml error pipelines | | `username`| string | no | The name of user who triggered pipelines | -| `order_by`| string | no | The order_by which is combined with a `sort`, one of: `id`, `status`, `ref`, `username`, `started_at`, `finished_at`, `created_at`, `updated_at`; | -| `sort` | string | no | The sort method which is combined with an `order_by`, one of: `asc`, `desc`; | +| `order_by`| string | no | Return requests ordered by `id`, `status`, `ref`, `username`, `started_at`, `finished_at`, `created_at` or `updated_at` fields. Default is `id` | +| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` | ``` curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines" |