From efedf983a117c5e5c75d7b2109475800345ff804 Mon Sep 17 00:00:00 2001 From: Tomasz Maczukin Date: Wed, 10 Feb 2016 14:31:30 +0100 Subject: Fix builds API formatting [ci skip] --- doc/api/builds.md | 64 +++++++++++++++++++------------------------------------ 1 file changed, 22 insertions(+), 42 deletions(-) diff --git a/doc/api/builds.md b/doc/api/builds.md index 6e64d096644..baf357a1075 100644 --- a/doc/api/builds.md +++ b/doc/api/builds.md @@ -8,20 +8,16 @@ Get a list of builds in a project. GET /projects/:id/builds ``` -### Parameters - | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| id | integer | yes | The ID of a project | -| scope | string|array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | - -### Example of request +| `id` | integer | yes | The ID of a project | +| `scope` | string|array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | ``` curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds" ``` -### Example of response +Example of response ```json [ @@ -112,21 +108,17 @@ Get a list of builds for specific commit in a project. GET /projects/:id/repository/commits/:sha/builds ``` -### Parameters - | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| id | integer | yes | The ID of a project | -| sha | string | yes | The SHA id of a commit | -| scope | string|array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | - -### Example of request +| `id` | integer | yes | The ID of a project | +| `sha` | string | yes | The SHA id of a commit | +| `scope` | string|array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | ``` curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/repository/commits/0ff3ae198f8601a285adcf5c0fff204ee6fba5fd/builds" ``` -### Example of response +Example of response ```json [ @@ -203,20 +195,16 @@ Get a single build of a project GET /projects/:id/builds/:build_id ``` -### Parameters - -| Attribute | Type | required | Description | -|-----------|---------|----------|---------------------| -| id | integer | yes | The ID of a project | -| build\_id | integer | yes | The ID of a build | - -### Example of request +| Attribute | Type | required | Description | +|------------|---------|----------|---------------------| +| `id` | integer | yes | The ID of a project | +| `build_id` | integer | yes | The ID of a build | ``` curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds/8" ``` -### Example of response +Example of response ```json { @@ -267,20 +255,16 @@ Cancel a single build of a project POST /projects/:id/builds/:build_id/cancel ``` -### Parameters - -| Attribute | Type | required | Description | -|-----------|---------|----------|---------------------| -| id | integer | yes | The ID of a project | -| build\_id | integer | yes | The ID of a build | - -### Example of request +| Attribute | Type | required | Description | +|------------|---------|----------|---------------------| +| `id` | integer | yes | The ID of a project | +| `build_id` | integer | yes | The ID of a build | ``` curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds/1/cancel" ``` -### Example of response +Example of response ```json { @@ -317,20 +301,16 @@ Retry a single build of a project POST /projects/:id/builds/:build_id/retry ``` -### Parameters - -| Attribute | Type | required | Description | -|-----------|---------|----------|---------------------| -| id | integer | yes | The ID of a project | -| build\_id | integer | yes | The ID of a build | - -### Example of request +| Attribute | Type | required | Description | +|------------|---------|----------|---------------------| +| `id` | integer | yes | The ID of a project | +| `build_id` | integer | yes | The ID of a build | ``` curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds/1/retry" ``` -### Example of response +Example of response ```json { -- cgit v1.2.1 From ba1f6de8a518c7b279200058fcc68064d6cf37f8 Mon Sep 17 00:00:00 2001 From: Tomasz Maczukin Date: Wed, 10 Feb 2016 15:07:11 +0100 Subject: Add some fixes [ci skip] --- doc/api/builds.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/api/builds.md b/doc/api/builds.md index baf357a1075..4dd4ee8b4bb 100644 --- a/doc/api/builds.md +++ b/doc/api/builds.md @@ -8,10 +8,10 @@ Get a list of builds in a project. GET /projects/:id/builds ``` -| Attribute | Type | required | Description | +| Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| | `id` | integer | yes | The ID of a project | -| `scope` | string|array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | +| `scope` | string **or** array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | ``` curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/builds" @@ -108,11 +108,11 @@ Get a list of builds for specific commit in a project. GET /projects/:id/repository/commits/:sha/builds ``` -| Attribute | Type | required | Description | +| Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| | `id` | integer | yes | The ID of a project | | `sha` | string | yes | The SHA id of a commit | -| `scope` | string|array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | +| `scope` | stringi **or** array of strings | no | The scope of builds to show, one or array of: `pending`, `running`, `failed`, `success`, `canceled`; showing all builds if none provided | ``` curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/repository/commits/0ff3ae198f8601a285adcf5c0fff204ee6fba5fd/builds" @@ -195,7 +195,7 @@ Get a single build of a project GET /projects/:id/builds/:build_id ``` -| Attribute | Type | required | Description | +| Attribute | Type | Required | Description | |------------|---------|----------|---------------------| | `id` | integer | yes | The ID of a project | | `build_id` | integer | yes | The ID of a build | @@ -255,7 +255,7 @@ Cancel a single build of a project POST /projects/:id/builds/:build_id/cancel ``` -| Attribute | Type | required | Description | +| Attribute | Type | Required | Description | |------------|---------|----------|---------------------| | `id` | integer | yes | The ID of a project | | `build_id` | integer | yes | The ID of a build | @@ -301,7 +301,7 @@ Retry a single build of a project POST /projects/:id/builds/:build_id/retry ``` -| Attribute | Type | required | Description | +| Attribute | Type | Required | Description | |------------|---------|----------|---------------------| | `id` | integer | yes | The ID of a project | | `build_id` | integer | yes | The ID of a build | -- cgit v1.2.1