diff options
| author | Robert Speicher <robert@gitlab.com> | 2017-05-03 16:14:42 +0000 |
|---|---|---|
| committer | Robert Speicher <robert@gitlab.com> | 2017-05-03 16:14:42 +0000 |
| commit | 501cb18be38eca623f143721dd76871d86badf9c (patch) | |
| tree | b160966761e912ed06cb5024bb8e97e61b8031e9 /doc | |
| parent | 439d55031166929a3cc4035f128f9a7156594a85 (diff) | |
| parent | 4fe7c25556c7343e46369ffc1e72db1346cc1360 (diff) | |
| download | gitlab-ce-501cb18be38eca623f143721dd76871d86badf9c.tar.gz | |
Merge branch '28408-feature-proposal-include-search-options-to-pipelines-api' into 'master'
Resolve "Feature Proposal: Include search options to pipelines API"
Closes #28408
See merge request !9367
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/pipelines.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 732ad8da4ac..890945cfc7e 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -11,6 +11,14 @@ 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` | +| `ref` | string | no | The ref of pipelines | +| `yaml_errors`| boolean | no | Returns pipelines with invalid configurations | +| `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 | Order pipelines by `id`, `status`, `ref`, or `user_id` (default: `id`) | +| `sort` | string | no | Sort pipelines in `asc` or `desc` order (default: `desc`) | ``` curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines" |