diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-24 12:06:18 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-24 12:06:18 +0300 |
commit | dc0622dbe3cd552abca4107557c6c09edb23625c (patch) | |
tree | 224dc625a2fe70a37ea7af11b1ad539b9bee2212 /doc/api/visual_review_discussions.md | |
parent | 12287a65b735d784cda3555d1b261e50b461b29e (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/visual_review_discussions.md')
-rw-r--r-- | doc/api/visual_review_discussions.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/api/visual_review_discussions.md b/doc/api/visual_review_discussions.md new file mode 100644 index 00000000000..59dbd6cb006 --- /dev/null +++ b/doc/api/visual_review_discussions.md @@ -0,0 +1,40 @@ +# Visual Review discussions API **(STARTER**) + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/18710) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.5. + +Visual Review discussions are notes on Merge Requests sent as +feedback from [Visual Reviews](../ci/review_apps/index.md#visual-reviews-starter). + +## Create new merge request thread + +Creates a new thread to a single project merge request. This is similar to creating +a note but other comments (replies) can be added to it later. + +``` +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](README.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) | + +```bash +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 +``` |