From 994e49b3fbc261f8e59429c1681d83c81ba25df3 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Tue, 28 Feb 2017 21:24:49 +0900 Subject: Fixed those points. - username to user_id - Drop duration - Resolve comments - Add Changelog - Edit docs --- doc/api/pipelines.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 732ad8da4ac..9281e6bb6d5 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -11,6 +11,13 @@ 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`| 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`, `user_id`, `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`; | ``` curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines" -- cgit v1.2.1 From df834306c1794ed72d6d655c7941dee28f7e85c7 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Wed, 1 Mar 2017 02:34:48 +0900 Subject: Add specs. Plus, minor fixes. --- doc/api/pipelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 9281e6bb6d5..677b96c74cc 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -16,7 +16,7 @@ GET /projects/:id/pipelines | `ref` | string | no | The ref of 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`, `user_id`, `started_at`, `finished_at`, `created_at`, `updated_at`; | +| `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`; | ``` -- cgit v1.2.1 From 7e421e55233bbb26594de2a88e62854b468fb02a Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Tue, 7 Mar 2017 21:36:08 +0900 Subject: Fix inappropriate words in doc --- doc/api/pipelines.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/api') 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" -- cgit v1.2.1 From 175800299bf497591e625e82fd71420644c0bc6b Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Wed, 8 Mar 2017 20:24:00 +0900 Subject: Add name(User) --- doc/api/pipelines.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 48e0d10180b..b843d64e000 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -15,7 +15,8 @@ GET /projects/:id/pipelines | `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 | -| `username`| string | no | The name of user who triggered pipelines | +| `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`, `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` | -- cgit v1.2.1 From 9324a464ef456dff3670df227c10d5cdec473256 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Wed, 8 Mar 2017 21:18:09 +0900 Subject: Reduce playable columns for sorting --- doc/api/pipelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index b843d64e000..c2aca779710 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -17,7 +17,7 @@ GET /projects/:id/pipelines | `yaml_errors`| string | no | If true, returns only yaml error pipelines | | `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`, `username`, `started_at`, `finished_at`, `created_at` or `updated_at` fields. Default is `id` | +| `order_by`| string | no | Return requests ordered by `id`, `status`, `ref`, `sha`, or `user_id` fields. Default is `id` | | `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` | ``` -- cgit v1.2.1 From d1ca5f46d4268ca3bba7801e581395e038c97129 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Tue, 14 Mar 2017 23:52:17 +0900 Subject: No need to support sha for sorting --- doc/api/pipelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index c2aca779710..d231dfc5241 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -17,7 +17,7 @@ GET /projects/:id/pipelines | `yaml_errors`| string | no | If true, returns only yaml error pipelines | | `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`, `sha`, or `user_id` fields. Default is `id` | +| `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` | ``` -- cgit v1.2.1 From f5f7f90abe6bc0f4e19e0abace72c8b1fd69f519 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Fri, 24 Mar 2017 17:30:26 +0900 Subject: Revise document. string to boolean. --- doc/api/pipelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index d231dfc5241..06307158e82 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -14,7 +14,7 @@ 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`| 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` | -- cgit v1.2.1 From 4bd0d8e433cdffba9e28a24657104eb2b0b0e761 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Thu, 30 Mar 2017 18:39:46 +0900 Subject: Adopt awesome axil idea --- doc/api/pipelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/api') 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" -- cgit v1.2.1 From dad973b59af297723c20726ef129d0e90b0bca87 Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Wed, 5 Apr 2017 20:48:59 +0900 Subject: Revise documents --- doc/api/pipelines.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/api') 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`) | -- cgit v1.2.1 From 255bfd658340e36a882108d4a9911d7f9cde638d Mon Sep 17 00:00:00 2001 From: Shinya Maeda Date: Thu, 27 Apr 2017 22:09:18 +0900 Subject: Improve documentation --- doc/api/pipelines.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/api') diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 31a28325a58..890945cfc7e 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -14,11 +14,11 @@ 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`| boolean | no | Returns pipelines which have an error of gitlab-ci.yml | +| `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 | 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`) | +| `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" -- cgit v1.2.1