Fix wrong copy edits for URL-encoded substitutions in API docs
This commit is contained in:
parent
5422554b86
commit
b472f9995a
|
@ -23,7 +23,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `awardable_id` | integer | yes | The ID (`iid` for merge requests/issues, `id` for snippets) of an awardable |
|
| `awardable_id` | integer | yes | The ID (`iid` for merge requests/issues, `id` for snippets) of an awardable |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -83,7 +83,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `awardable_id` | integer | yes | The ID (`iid` for merge requests/issues, `id` for snippets) of an awardable |
|
| `awardable_id` | integer | yes | The ID (`iid` for merge requests/issues, `id` for snippets) of an awardable |
|
||||||
| `award_id` | integer | yes | The ID of the award emoji |
|
| `award_id` | integer | yes | The ID of the award emoji |
|
||||||
|
|
||||||
|
@ -126,7 +126,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `awardable_id` | integer | yes | The ID (`iid` for merge requests/issues, `id` for snippets) of an awardable |
|
| `awardable_id` | integer | yes | The ID (`iid` for merge requests/issues, `id` for snippets) of an awardable |
|
||||||
| `name` | string | yes | The name of the emoji, without colons |
|
| `name` | string | yes | The name of the emoji, without colons |
|
||||||
|
|
||||||
|
@ -170,7 +170,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `issue_iid` | integer | yes | The internal ID of an issue |
|
| `issue_iid` | integer | yes | The internal ID of an issue |
|
||||||
| `award_id` | integer | yes | The ID of a award_emoji |
|
| `award_id` | integer | yes | The ID of a award_emoji |
|
||||||
|
|
||||||
|
@ -195,7 +195,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `issue_iid` | integer | yes | The internal ID of an issue |
|
| `issue_iid` | integer | yes | The internal ID of an issue |
|
||||||
| `note_id` | integer | yes | The ID of an note |
|
| `note_id` | integer | yes | The ID of an note |
|
||||||
|
|
||||||
|
@ -237,7 +237,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `issue_iid` | integer | yes | The internal ID of an issue |
|
| `issue_iid` | integer | yes | The internal ID of an issue |
|
||||||
| `note_id` | integer | yes | The ID of a note |
|
| `note_id` | integer | yes | The ID of a note |
|
||||||
| `award_id` | integer | yes | The ID of the award emoji |
|
| `award_id` | integer | yes | The ID of the award emoji |
|
||||||
|
@ -277,7 +277,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `issue_iid` | integer | yes | The internal ID of an issue |
|
| `issue_iid` | integer | yes | The internal ID of an issue |
|
||||||
| `note_id` | integer | yes | The ID of a note |
|
| `note_id` | integer | yes | The ID of a note |
|
||||||
| `name` | string | yes | The name of the emoji, without colons |
|
| `name` | string | yes | The name of the emoji, without colons |
|
||||||
|
@ -320,7 +320,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `issue_iid` | integer | yes | The internal ID of an issue |
|
| `issue_iid` | integer | yes | The internal ID of an issue |
|
||||||
| `note_id` | integer | yes | The ID of a note |
|
| `note_id` | integer | yes | The ID of a note |
|
||||||
| `award_id` | integer | yes | The ID of a award_emoji |
|
| `award_id` | integer | yes | The ID of a award_emoji |
|
||||||
|
|
|
@ -15,7 +15,7 @@ GET /projects/:id/boards
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/boards
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/boards
|
||||||
|
@ -71,7 +71,7 @@ GET /projects/:id/boards/:board_id/lists
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `board_id` | integer | yes | The ID of a board |
|
| `board_id` | integer | yes | The ID of a board |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -122,7 +122,7 @@ GET /projects/:id/boards/:board_id/lists/:list_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `board_id` | integer | yes | The ID of a board |
|
| `board_id` | integer | yes | The ID of a board |
|
||||||
| `list_id`| integer | yes | The ID of a board's list |
|
| `list_id`| integer | yes | The ID of a board's list |
|
||||||
|
|
||||||
|
@ -154,7 +154,7 @@ POST /projects/:id/boards/:board_id/lists
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `board_id` | integer | yes | The ID of a board |
|
| `board_id` | integer | yes | The ID of a board |
|
||||||
| `label_id` | integer | yes | The ID of a label |
|
| `label_id` | integer | yes | The ID of a label |
|
||||||
|
|
||||||
|
@ -186,7 +186,7 @@ PUT /projects/:id/boards/:board_id/lists/:list_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `board_id` | integer | yes | The ID of a board |
|
| `board_id` | integer | yes | The ID of a board |
|
||||||
| `list_id` | integer | yes | The ID of a board's list |
|
| `list_id` | integer | yes | The ID of a board's list |
|
||||||
| `position` | integer | yes | The position of the list |
|
| `position` | integer | yes | The position of the list |
|
||||||
|
@ -219,7 +219,7 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `board_id` | integer | yes | The ID of a board |
|
| `board_id` | integer | yes | The ID of a board |
|
||||||
| `list_id` | integer | yes | The ID of a board's list |
|
| `list_id` | integer | yes | The ID of a board's list |
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ GET /projects/:id/variables
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```
|
```
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables"
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables"
|
||||||
|
@ -39,7 +39,7 @@ GET /projects/:id/variables/:key
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|-----------|---------|----------|-----------------------|
|
|-----------|---------|----------|-----------------------|
|
||||||
| `id` | integer | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key` | string | yes | The `key` of a variable |
|
| `key` | string | yes | The `key` of a variable |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -63,7 +63,7 @@ POST /projects/:id/variables
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|-----------|---------|----------|-----------------------|
|
|-----------|---------|----------|-----------------------|
|
||||||
| `id` | integer | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key` | string | yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed |
|
| `key` | string | yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed |
|
||||||
| `value` | string | yes | The `value` of a variable |
|
| `value` | string | yes | The `value` of a variable |
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ PUT /projects/:id/variables/:key
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|-----------|---------|----------|-------------------------|
|
|-----------|---------|----------|-------------------------|
|
||||||
| `id` | integer | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key` | string | yes | The `key` of a variable |
|
| `key` | string | yes | The `key` of a variable |
|
||||||
| `value` | string | yes | The `value` of a variable |
|
| `value` | string | yes | The `value` of a variable |
|
||||||
|
|
||||||
|
@ -113,7 +113,7 @@ DELETE /projects/:id/variables/:key
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|-----------|---------|----------|-------------------------|
|
|-----------|---------|----------|-------------------------|
|
||||||
| `id` | integer | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key` | string | yes | The `key` of a variable |
|
| `key` | string | yes | The `key` of a variable |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -69,7 +69,7 @@ POST /projects/:id/repository/commits
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `branch_name` | string | yes | The name of a branch |
|
| `branch` | string | yes | The name of a branch |
|
||||||
| `commit_message` | string | yes | Commit message |
|
| `commit_message` | string | yes | Commit message |
|
||||||
| `actions[]` | array | yes | An array of action hashes to commit as a batch. See the next table for what attributes it can take. |
|
| `actions[]` | array | yes | An array of action hashes to commit as a batch. See the next table for what attributes it can take. |
|
||||||
| `author_email` | string | no | Specify the commit author's email address |
|
| `author_email` | string | no | Specify the commit author's email address |
|
||||||
|
|
|
@ -43,7 +43,7 @@ GET /projects/:id/deploy_keys
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/deploy_keys"
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/deploy_keys"
|
||||||
|
@ -82,7 +82,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key_id` | integer | yes | The ID of the deploy key |
|
| `key_id` | integer | yes | The ID of the deploy key |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -114,7 +114,7 @@ POST /projects/:id/deploy_keys
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `title` | string | yes | New deploy key's title |
|
| `title` | string | yes | New deploy key's title |
|
||||||
| `key` | string | yes | New deploy key |
|
| `key` | string | yes | New deploy key |
|
||||||
| `can_push` | boolean | no | Can deploy key push to the project's repository |
|
| `can_push` | boolean | no | Can deploy key push to the project's repository |
|
||||||
|
@ -145,7 +145,7 @@ DELETE /projects/:id/deploy_keys/:key_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key_id` | integer | yes | The ID of the deploy key |
|
| `key_id` | integer | yes | The ID of the deploy key |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -162,7 +162,7 @@ curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitla
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `key_id` | integer | yes | The ID of the deploy key |
|
| `key_id` | integer | yes | The ID of the deploy key |
|
||||||
|
|
||||||
Example response:
|
Example response:
|
||||||
|
|
|
@ -10,7 +10,7 @@ GET /projects/:id/deployments
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/deployments"
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/deployments"
|
||||||
|
@ -147,7 +147,7 @@ GET /projects/:id/deployments/:deployment_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `deployment_id` | integer | yes | The ID of the deployment |
|
| `deployment_id` | integer | yes | The ID of the deployment |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -10,7 +10,7 @@ GET /projects/:id/environments
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ------- | -------- | --------------------- |
|
| --------- | ------- | -------- | --------------------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/environments
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/1/environments
|
||||||
|
@ -41,7 +41,7 @@ POST /projects/:id/environment
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| ------------- | ------- | -------- | ---------------------------- |
|
| ------------- | ------- | -------- | ---------------------------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `name` | string | yes | The name of the environment |
|
| `name` | string | yes | The name of the environment |
|
||||||
| `external_url` | string | no | Place to link to for this environment |
|
| `external_url` | string | no | Place to link to for this environment |
|
||||||
|
|
||||||
|
@ -72,7 +72,7 @@ PUT /projects/:id/environments/:environments_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------------- | ------- | --------------------------------- | ------------------------------- |
|
| --------------- | ------- | --------------------------------- | ------------------------------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `environment_id` | integer | yes | The ID of the environment | The ID of the environment |
|
| `environment_id` | integer | yes | The ID of the environment | The ID of the environment |
|
||||||
| `name` | string | no | The new name of the environment |
|
| `name` | string | no | The new name of the environment |
|
||||||
| `external_url` | string | no | The new external_url |
|
| `external_url` | string | no | The new external_url |
|
||||||
|
@ -102,7 +102,7 @@ DELETE /projects/:id/environments/:environment_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ------- | -------- | --------------------- |
|
| --------- | ------- | -------- | --------------------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `environment_id` | integer | yes | The ID of the environment |
|
| `environment_id` | integer | yes | The ID of the environment |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -119,7 +119,7 @@ POST /projects/:id/environments/:environment_id/stop
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ------- | -------- | --------------------- |
|
| --------- | ------- | -------- | --------------------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `environment_id` | integer | yes | The ID of the environment |
|
| `environment_id` | integer | yes | The ID of the environment |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -10,7 +10,7 @@ GET /projects/:id/jobs
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `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 **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
|
| `scope` | string **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -125,7 +125,7 @@ GET /projects/:id/pipeline/:pipeline_id/jobs
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|---------------|--------------------------------|----------|----------------------|
|
|---------------|--------------------------------|----------|----------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
||||||
| `scope` | string **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
|
| `scope` | string **or** array of strings | no | The scope of jobs to show, one or array of: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`; showing all jobs if none provided |
|
||||||
|
|
||||||
|
@ -241,7 +241,7 @@ GET /projects/:id/jobs/:job_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -309,7 +309,7 @@ GET /projects/:id/jobs/:job_id/artifacts
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -340,7 +340,7 @@ Parameters
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-------------|---------|----------|-------------------------- |
|
|-------------|---------|----------|-------------------------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `ref_name` | string | yes | The ref from a repository |
|
| `ref_name` | string | yes | The ref from a repository |
|
||||||
| `job` | string | yes | The name of the job |
|
| `job` | string | yes | The name of the job |
|
||||||
|
|
||||||
|
@ -369,7 +369,7 @@ GET /projects/:id/jobs/:job_id/trace
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| id | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| id | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| job_id | integer | yes | The ID of a job |
|
| job_id | integer | yes | The ID of a job |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -393,7 +393,7 @@ POST /projects/:id/jobs/:job_id/cancel
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -439,7 +439,7 @@ POST /projects/:id/jobs/:job_id/retry
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -487,7 +487,7 @@ Parameters
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-------------|---------|----------|---------------------|
|
|-------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
Example of request
|
Example of request
|
||||||
|
@ -537,7 +537,7 @@ Parameters
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-------------|---------|----------|---------------------|
|
|-------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
Example request:
|
Example request:
|
||||||
|
@ -585,7 +585,7 @@ POST /projects/:id/jobs/:job_id/play
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `job_id` | integer | yes | The ID of a job |
|
| `job_id` | integer | yes | The ID of a job |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -57,7 +57,7 @@ GET /projects/:id/milestones/:milestone_id
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
|
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
|
||||||
- `milestone_id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user milestone
|
- `milestone_id` (required) - The ID of the project's milestone
|
||||||
|
|
||||||
## Create new milestone
|
## Create new milestone
|
||||||
|
|
||||||
|
|
|
@ -115,7 +115,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `issue_iid` | integer | yes | The IID of an issue |
|
| `issue_iid` | integer | yes | The IID of an issue |
|
||||||
| `note_id` | integer | yes | The ID of a note |
|
| `note_id` | integer | yes | The ID of a note |
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ GET /projects/:id/triggers
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```
|
```
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers"
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/triggers"
|
||||||
|
@ -43,7 +43,7 @@ GET /projects/:id/triggers/:trigger_id
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|--------------|---------|----------|--------------------------|
|
|--------------|---------|----------|--------------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `trigger_id` | integer | yes | The trigger id |
|
| `trigger_id` | integer | yes | The trigger id |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -73,7 +73,7 @@ POST /projects/:id/triggers
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|---------------|---------|----------|--------------------------|
|
|---------------|---------|----------|--------------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `description` | string | yes | The trigger name |
|
| `description` | string | yes | The trigger name |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -103,7 +103,7 @@ PUT /projects/:id/triggers/:trigger_id
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|---------------|---------|----------|--------------------------|
|
|---------------|---------|----------|--------------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `trigger_id` | integer | yes | The trigger id |
|
| `trigger_id` | integer | yes | The trigger id |
|
||||||
| `description` | string | no | The trigger name |
|
| `description` | string | no | The trigger name |
|
||||||
|
|
||||||
|
@ -134,7 +134,7 @@ POST /projects/:id/triggers/:trigger_id/take_ownership
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|---------------|---------|----------|--------------------------|
|
|---------------|---------|----------|--------------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `trigger_id` | integer | yes | The trigger id |
|
| `trigger_id` | integer | yes | The trigger id |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -164,7 +164,7 @@ DELETE /projects/:id/triggers/:trigger_id
|
||||||
|
|
||||||
| Attribute | Type | required | Description |
|
| Attribute | Type | required | Description |
|
||||||
|----------------|---------|----------|--------------------------|
|
|----------------|---------|----------|--------------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `trigger_id` | integer | yes | The trigger id |
|
| `trigger_id` | integer | yes | The trigger id |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -10,7 +10,7 @@ GET /projects/:id/pipelines
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```
|
```
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines"
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/pipelines"
|
||||||
|
@ -45,7 +45,7 @@ GET /projects/:id/pipelines/:pipeline_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -91,7 +91,7 @@ POST /projects/:id/pipeline
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `ref` | string | yes | Reference to commit |
|
| `ref` | string | yes | Reference to commit |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -137,7 +137,7 @@ POST /projects/:id/pipelines/:pipeline_id/retry
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -183,7 +183,7 @@ POST /projects/:id/pipelines/:pipeline_id/cancel
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|------------|---------|----------|---------------------|
|
|------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
| `pipeline_id` | integer | yes | The ID of a pipeline |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -609,7 +609,7 @@ POST /projects/:id/unstar
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/unstar"
|
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/unstar"
|
||||||
|
@ -675,7 +675,7 @@ POST /projects/:id/archive
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/archive"
|
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/archive"
|
||||||
|
@ -757,7 +757,7 @@ POST /projects/:id/unarchive
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/unarchive"
|
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/unarchive"
|
||||||
|
@ -840,7 +840,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
## Uploads
|
## Uploads
|
||||||
|
|
||||||
|
@ -856,7 +856,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `file` | string | yes | The file to be uploaded |
|
| `file` | string | yes | The file to be uploaded |
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -887,7 +887,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `group_id` | integer | yes | The ID of the group to share with |
|
| `group_id` | integer | yes | The ID of the group to share with |
|
||||||
| `group_access` | integer | yes | The permissions level to grant the group |
|
| `group_access` | integer | yes | The permissions level to grant the group |
|
||||||
| `expires_at` | string | no | Share expiration date in ISO 8601 format: 2016-09-26 |
|
| `expires_at` | string | no | Share expiration date in ISO 8601 format: 2016-09-26 |
|
||||||
|
@ -904,7 +904,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `group_id` | integer | yes | The ID of the group |
|
| `group_id` | integer | yes | The ID of the group |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -928,7 +928,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
### Get project hook
|
### Get project hook
|
||||||
|
|
||||||
|
@ -942,7 +942,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `hook_id` | integer | yes | The ID of a project hook |
|
| `hook_id` | integer | yes | The ID of a project hook |
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
@ -975,7 +975,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `url` | string | yes | The hook URL |
|
| `url` | string | yes | The hook URL |
|
||||||
| `push_events` | boolean | no | Trigger hook on push events |
|
| `push_events` | boolean | no | Trigger hook on push events |
|
||||||
| `issues_events` | boolean | no | Trigger hook on issues events |
|
| `issues_events` | boolean | no | Trigger hook on issues events |
|
||||||
|
@ -1000,7 +1000,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `hook_id` | integer | yes | The ID of the project hook |
|
| `hook_id` | integer | yes | The ID of the project hook |
|
||||||
| `url` | string | yes | The hook URL |
|
| `url` | string | yes | The hook URL |
|
||||||
| `push_events` | boolean | no | Trigger hook on push events |
|
| `push_events` | boolean | no | Trigger hook on push events |
|
||||||
|
@ -1027,7 +1027,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `hook_id` | integer | yes | The ID of the project hook |
|
| `hook_id` | integer | yes | The ID of the project hook |
|
||||||
|
|
||||||
Note the JSON response differs if the hook is available or not. If the project hook
|
Note the JSON response differs if the hook is available or not. If the project hook
|
||||||
|
@ -1049,7 +1049,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
|
@ -1106,7 +1106,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `branch` | string | yes | The name of the branch |
|
| `branch` | string | yes | The name of the branch |
|
||||||
| `developers_can_push` | boolean | no | Flag if developers can push to the branch |
|
| `developers_can_push` | boolean | no | Flag if developers can push to the branch |
|
||||||
| `developers_can_merge` | boolean | no | Flag if developers can merge to the branch |
|
| `developers_can_merge` | boolean | no | Flag if developers can merge to the branch |
|
||||||
|
@ -1123,7 +1123,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `branch` | string | yes | The name of the branch |
|
| `branch` | string | yes | The name of the branch |
|
||||||
|
|
||||||
### Unprotect single branch
|
### Unprotect single branch
|
||||||
|
@ -1138,7 +1138,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `branch` | string | yes | The name of the branch |
|
| `branch` | string | yes | The name of the branch |
|
||||||
|
|
||||||
## Admin fork relation
|
## Admin fork relation
|
||||||
|
@ -1155,7 +1155,7 @@ Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
| `forked_from_id` | ID | yes | The ID of the project that was forked from |
|
| `forked_from_id` | ID | yes | The ID of the project that was forked from |
|
||||||
|
|
||||||
### Delete an existing forked from relationship
|
### Delete an existing forked from relationship
|
||||||
|
@ -1168,7 +1168,7 @@ Parameter:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| --------- | ---- | -------- | ----------- |
|
||||||
| `id` | integer/string | yes | The ID of the project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||||
|
|
||||||
## Search for projects by name
|
## Search for projects by name
|
||||||
|
|
||||||
|
|
|
@ -222,7 +222,7 @@ GET /projects/:id/runners
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-----------|---------|----------|---------------------|
|
|-----------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
|
|
||||||
```
|
```
|
||||||
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/9/runners"
|
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/9/runners"
|
||||||
|
@ -259,7 +259,7 @@ POST /projects/:id/runners
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-------------|---------|----------|---------------------|
|
|-------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `runner_id` | integer | yes | The ID of a runner |
|
| `runner_id` | integer | yes | The ID of a runner |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -290,7 +290,7 @@ DELETE /projects/:id/runners/:runner_id
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
|-------------|---------|----------|---------------------|
|
|-------------|---------|----------|---------------------|
|
||||||
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||||
| `runner_id` | integer | yes | The ID of a runner |
|
| `runner_id` | integer | yes | The ID of a runner |
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in New Issue