diff options
Diffstat (limited to 'doc/api/commits.md')
| -rw-r--r-- | doc/api/commits.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/api/commits.md b/doc/api/commits.md index 3fe77dd5f43..83fa54231ee 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -100,15 +100,15 @@ POST /projects/:id/repository/commits | `stats` | boolean | no | Include commit stats. Default is true | | `force` | boolean | no | When `true` overwrites the target branch with a new commit based on the `start_branch` or `start_sha` | -| `actions[]` Attribute | Type | Required | Description | -| --------------------- | ---- | -------- | ----------- | -| `action` | string | yes | The action to perform, `create`, `delete`, `move`, `update`, `chmod`| -| `file_path` | string | yes | Full path to the file. Ex. `lib/class.rb` | -| `previous_path` | string | no | Original full path to the file being moved. Ex. `lib/class1.rb`. Only considered for `move` action. | -| `content` | string | no | File content, required for all except `delete`, `chmod`, and `move`. Move actions that do not specify `content` preserve the existing file content, and any other value of `content` overwrites the file content. | -| `encoding` | string | no | `text` or `base64`. `text` is default. | -| `last_commit_id` | string | no | Last known file commit ID. Only considered in update, move, and delete actions. | -| `execute_filemode` | boolean | no | When `true/false` enables/disables the execute flag on the file. Only considered for `chmod` action. | +| `actions[]` Attribute | Type | Required | Description | +|-----------------------|---------|----------|-------------| +| `action` | string | yes | The action to perform: `create`, `delete`, `move`, `update`, or `chmod`. | +| `file_path` | string | yes | Full path to the file. For example: `lib/class.rb`. | +| `previous_path` | string | no | Original full path to the file being moved. For example `lib/class1.rb`. Only considered for `move` action. | +| `content` | string | no | File content, required for all except `delete`, `chmod`, and `move`. Move actions that do not specify `content` preserve the existing file content, and any other value of `content` overwrites the file content. | +| `encoding` | string | no | `text` or `base64`. `text` is default. | +| `last_commit_id` | string | no | Last known file commit ID. Only considered in update, move, and delete actions. | +| `execute_filemode` | boolean | no | When `true/false` enables/disables the execute flag on the file. Only considered for `chmod` action. | ```shell PAYLOAD=$(cat << 'JSON' @@ -695,9 +695,10 @@ Example response: ] ``` -### Post the build status to a commit +### Set the pipeline status of a commit -Adds or updates a build status of a commit. +Add or update the pipeline status of a commit. If the commit is associated with a merge request, +the API call must target the commit in the merge request's source branch. ```plaintext POST /projects/:id/statuses/:sha |