diff options
| author | Tomasz Maczukin <tomasz@maczukin.pl> | 2016-02-10 16:31:30 +0300 |
|---|---|---|
| committer | Tomasz Maczukin <tomasz@maczukin.pl> | 2016-02-10 16:36:51 +0300 |
| commit | efedf983a117c5e5c75d7b2109475800345ff804 (patch) | |
| tree | 0e234859d7359e0ecb66012d03d0ecb3189dc83e /doc/api | |
| parent | 10aa99a30c311c59358d1547ebcbe0f6a92227a7 (diff) | |
Fix builds API formatting
[ci skip]
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/builds.md | 64 |
1 files 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 { |