diff options
Diffstat (limited to 'doc/api/visual_review_discussions.md')
| -rw-r--r-- | doc/api/visual_review_discussions.md | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/api/visual_review_discussions.md b/doc/api/visual_review_discussions.md index 496c732b337..f6d6636280a 100644 --- a/doc/api/visual_review_discussions.md +++ b/doc/api/visual_review_discussions.md @@ -29,23 +29,23 @@ POST /projects/:id/merge_requests/:merge_request_iid/visual_review_discussions Parameters: | Attribute | Type | Required | Description | -| ------------------------- | -------------- | -------- | ----------- | -| `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 | -| `body` | string | yes | The content of the thread | -| `position` | hash | no | Position when creating a diff note | -| `position[base_sha]` | string | yes | Base commit SHA in the source branch | -| `position[start_sha]` | string | yes | SHA referencing commit in target branch | -| `position[head_sha]` | string | yes | SHA referencing HEAD of this merge request | -| `position[position_type]` | string | yes | Type of the position reference. Either `text` or `image`. | -| `position[new_path]` | string | no | File path after change | -| `position[new_line]` | integer | no | Line number after change (Only stored for `text` diff notes) | -| `position[old_path]` | string | no | File path before change | -| `position[old_line]` | integer | no | Line number before change (Only stored for `text` diff notes) | -| `position[width]` | integer | no | Width of the image (Only stored for `image` diff notes) | -| `position[height]` | integer | no | Height of the image (Only stored for `image` diff notes) | -| `position[x]` | integer | no | X coordinate (Only stored for `image` diff notes) | -| `position[y]` | integer | no | Y coordinate (Only stored for `image` diff notes) | +|---------------------------|----------------|----------|-------------| +| `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 | +| `body` | string | Yes | The content of the thread | +| `position` | hash | No | Position when creating a diff note | +| `position[base_sha]` | string | Yes | Base commit SHA in the source branch | +| `position[start_sha]` | string | Yes | SHA referencing commit in target branch | +| `position[head_sha]` | string | Yes | SHA referencing HEAD of this merge request | +| `position[position_type]` | string | Yes | Type of the position reference. Either `text` or `image`. | +| `position[new_path]` | string | No | File path after change | +| `position[new_line]` | integer | No | Line number after change (Only stored for `text` diff notes) | +| `position[old_path]` | string | No | File path before change | +| `position[old_line]` | integer | No | Line number before change (Only stored for `text` diff notes) | +| `position[width]` | integer | No | Width of the image (Only stored for `image` diff notes) | +| `position[height]` | integer | No | Height of the image (Only stored for `image` diff notes) | +| `position[x]` | integer | No | X coordinate (Only stored for `image` diff notes) | +| `position[y]` | integer | No | Y coordinate (Only stored for `image` diff notes) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/visual_review_discussions?body=comment" |