Add response codes and fields to GET /merge_requests
What does this MR do?
Begins work on https://docs.gitlab.com/api/merge_requests/ by tackling the first endpoint, GET /merge_requests
: https://docs.gitlab.com/api/merge_requests/#list-merge-requests. This endpoint needs a list of response codes, and a table of fields in the response.
For the technical review: this MR requires more careful review than most MRs I send you, because I'm not able to fully verify the information I'm proposing here. I started digging in lib/api/merge_requests.rb
and got tangled up in the dependencies. I tried querying Duo; see internal comment below for the raw response. I saw it pull information from these files, which made me feel better about the dependency chain:
See full file list
lib/api/entities/merge_request_basic.rb
lib/api/entities/merge_request_simple.rb
lib/api/entities/milestone.rb
lib/api/entities/issuable_entity.rb
lib/api/entities/user_basic.rb
lib/api/entities/user_safe.rb
ee/lib/ee/api/entities/merge_request_basic.rb
What I need from a technical review:
-
Are the response codes complete and correct? -
Are the response fields complete and correct? -
Any fields missing? -
Are the types and descriptions correct?
-
I'll have another TW review my language, so don't worry about the wording. Focus on fact-checking me.
Related issues
Related to Fix missing data / structure in Merge Request A... (#433318)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.