diff options
| author | Tomasz Maczukin <tomasz@maczukin.pl> | 2016-02-10 15:07:11 +0100 |
|---|---|---|
| committer | Tomasz Maczukin <tomasz@maczukin.pl> | 2016-02-10 15:07:11 +0100 |
| commit | ba1f6de8a518c7b279200058fcc68064d6cf37f8 (patch) | |
| tree | 5c19c0bb4d9389f2ae63003317990001f3a41a7d | |
| parent | efedf983a117c5e5c75d7b2109475800345ff804 (diff) | |
| download | gitlab-ce-fix/ci-api-builds-docs.tar.gz | |
Add some fixesfix/ci-api-builds-docs
[ci skip]
| -rw-r--r-- | doc/api/builds.md | 14 |
1 files 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 | |