diff options
| author | Shinya Maeda <gitlab.shinyamaeda@gmail.com> | 2017-04-05 20:48:59 +0900 |
|---|---|---|
| committer | Shinya Maeda <gitlab.shinyamaeda@gmail.com> | 2017-05-03 02:11:51 +0900 |
| commit | dad973b59af297723c20726ef129d0e90b0bca87 (patch) | |
| tree | 4d51f19bff5a40970d2206eff06a66d712eee594 | |
| parent | 8653c2dfc943b5536ab99155c8b950e30ba1f567 (diff) | |
| download | gitlab-ce-dad973b59af297723c20726ef129d0e90b0bca87.tar.gz | |
Revise documents
| -rw-r--r-- | changelogs/unreleased/28408-feature-proposal-include-search-options-to-pipelines-api.yml | 2 | ||||
| -rw-r--r-- | doc/api/pipelines.md | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/changelogs/unreleased/28408-feature-proposal-include-search-options-to-pipelines-api.yml b/changelogs/unreleased/28408-feature-proposal-include-search-options-to-pipelines-api.yml index 6fb3da99fb4..9b9f0032810 100644 --- a/changelogs/unreleased/28408-feature-proposal-include-search-options-to-pipelines-api.yml +++ b/changelogs/unreleased/28408-feature-proposal-include-search-options-to-pipelines-api.yml @@ -1,4 +1,4 @@ --- -title: Resolve Feature Proposal Include search options to pipelines API +title: 'API: Add parameters to allow filtering project pipelines' merge_request: 9367 author: dosuken123 diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 733c9479ec2..31a28325a58 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -11,12 +11,12 @@ GET /projects/:id/pipelines | 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 | -| `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`; | +| `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`| 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 | +| `name`| string | no | The name of the user who triggered pipelines | +| `username`| string | no | The username of the user who triggered pipelines | | `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`) | |