Skip to content

[Docs] Add reviewers to MergeRequest API response

sue445 requested to merge sue445/gitlab:api-docs-mr-reviewers into master

What does this MR do?

Add reviewers to example response of MergeRequest API Doc.

Actually, the MergeRequest API contains reviewers

e.g.

$ curl -s --header "Authorization: Bearer $GITLAB_API_PRIVATE_TOKEN" "https://gitlab.com/api/v4/projects/gitlab-org%2Fgitlab/merge_requests/49854" | jq .reviewers
[
  {
    "id": 128633,
    "name": "Rémy Coutable",
    "username": "rymai",
    "state": "active",
    "avatar_url": "https://secure.gravatar.com/avatar/263da227929cc0035cb0eba512bcf81a?s=80&d=identicon",
    "web_url": "https://gitlab.com/rymai"
  }
]

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by sue445

Merge request reports