diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2024-01-10 06:12:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2024-01-10 06:12:01 +0300 |
commit | fea86fb8bf2339727de5e91ccf17ab105e993dca (patch) | |
tree | 25ddd67b8131643fa648f052eb29d527d72bdda3 /doc/api | |
parent | ec4891efa777d951afdbff95557bbcf5fda00188 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/discussions.md | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/doc/api/discussions.md b/doc/api/discussions.md index d821c9e0634..b12131e4746 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -876,27 +876,27 @@ POST /projects/:id/merge_requests/:merge_request_iid/discussions Parameters for all comments: -| Attribute | Type | Required | Description | -| ---------------------------------------- | -------------- | -------- | ----------- | -| `body` | string | yes | The content of the thread. | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | -| `merge_request_iid` | integer | yes | The IID of a merge request. | -| `position[base_sha]` | string | yes | Base commit SHA in the source branch. | -| `position[head_sha]` | string | yes | SHA referencing HEAD of this merge request. | -| `position[start_sha]` | string | yes | SHA referencing commit in target branch. | +| Attribute | Type | Required | Description | +| ---------------------------------------- | -------------- |--------------------------------------| ----------- | +| `body` | string | yes | The content of the thread. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `merge_request_iid` | integer | yes | The IID of a merge request. | +| `position[base_sha]` | string | yes (if `position*` is supplied) | Base commit SHA in the source branch. | +| `position[head_sha]` | string | yes (if `position*` is supplied) | SHA referencing HEAD of this merge request. | +| `position[start_sha]` | string | yes (if `position*` is supplied) | SHA referencing commit in target branch. | | `position[new_path]` | string | yes (if the position type is `text`) | File path after change. | | `position[old_path]` | string | yes (if the position type is `text`) | File path before change. | -| `position[position_type]` | string | yes | Type of the position reference. Allowed values: `text` or `image`. | -| `commit_id` | string | no | SHA referencing commit to start this thread on. | -| `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | -| `position` | hash | no | Position when creating a diff note. | -| `position[new_line]` | integer | no | For `text` diff notes, the line number after change. | -| `position[old_line]` | integer | no | For `text` diff notes, the line number before change. | -| `position[line_range]` | hash | no | Line range for a multi-line diff note. | -| `position[width]` | integer | no | For `image` diff notes, width of the image. | -| `position[height]` | integer | no | For `image` diff notes, height of the image. | -| `position[x]` | float | no | For `image` diff notes, X coordinate. | -| `position[y]` | float | no | For `image` diff notes, Y coordinate. | +| `position[position_type]` | string | yes (if position* is supplied) | Type of the position reference. Allowed values: `text` or `image`. | +| `commit_id` | string | no | SHA referencing commit to start this thread on. | +| `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | +| `position` | hash | no | Position when creating a diff note. | +| `position[new_line]` | integer | no | For `text` diff notes, the line number after change. | +| `position[old_line]` | integer | no | For `text` diff notes, the line number before change. | +| `position[line_range]` | hash | no | Line range for a multi-line diff note. | +| `position[width]` | integer | no | For `image` diff notes, width of the image. | +| `position[height]` | integer | no | For `image` diff notes, height of the image. | +| `position[x]` | float | no | For `image` diff notes, X coordinate. | +| `position[y]` | float | no | For `image` diff notes, Y coordinate. | #### Create a new thread on the overview page @@ -1287,17 +1287,17 @@ POST /projects/:id/repository/commits/:commit_id/discussions Parameters: -| Attribute | Type | Required | Description | -| ------------------------- | -------------- | -------- | ----------- | -| `body` | string | yes | The content of the thread. | -| `commit_id` | string | yes | The SHA of a commit. | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | -| `position[base_sha]` | string | yes | SHA of the parent commit. | -| `position[head_sha]` | string | yes | The SHA of this commit. Same as `commit_id`. | -| `position[start_sha]` | string | yes | SHA of the parent commit. | -| `position[position_type]` | string | yes | Type of the position reference. Allowed values: `text` or `image`. | -| `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | -| `position` | hash | no | Position when creating a diff note. | +| Attribute | Type | Required | Description | +| ------------------------- | -------------- |----------------------------------| ----------- | +| `body` | string | yes | The content of the thread. | +| `commit_id` | string | yes | The SHA of a commit. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `position[base_sha]` | string | yes (if `position*` is supplied) | SHA of the parent commit. | +| `position[head_sha]` | string | yes (if `position*` is supplied) | The SHA of this commit. Same as `commit_id`. | +| `position[start_sha]` | string | yes (if `position*` is supplied) | SHA of the parent commit. | +| `position[position_type]` | string | yes (if `position*` is supplied) | Type of the position reference. Allowed values: `text` or `image`. | +| `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | +| `position` | hash | no | Position when creating a diff note. | | `position[new_path]` | string | no | File path after change. | | `position[new_line]` | integer | no | Line number after change. | |