OpenAPI page: minor updates, and change YAML file link
What does this MR do?
This MR updates a link in doc/api/openapi/openapi_interactive.md, and blends a couple of subheadings together into a concept area. (This page didn't really have one.)
How we got to this point is worth outlining, because it's a bit of a ride.
- As part of Inconsistent use of 'cherry-pick' versus 'cherr... (gitlab-docs#1849 - closed), I tried to update strings that used
cherry pickinstead ofcherry-pick. - One of the findings that needed fixing was
doc/api/openapi/openapi_v2.yamlauto-generated from Rake taskbin/rake gitlab:openapi:generate, which led me to create Regenerate API file, document how it was done (!179892 - merged) to updateopenapi_v2.yaml. - When I had trouble identifying an owner for the YAML file, that led me to the giant epic Document the REST API in OpenAPI V2 (&8926). I added &8926 (comment 2332786567).
- As part of the discussion, @m_frankiewicz asked that we update the link in
doc/api/openapi/openapi_interactive.md.
And that's why I'm updating a link in doc/api/openapi/openapi_interactive.md, in a part of the docs I'm never in, to update the link to a YAML file that I just wanted to change one character in. Good times!
I'll send this over to @ashrafkhamis because this page belongs to groupimport and integrate, and he will be FAR more familiar with that area than I am.
Related issues
- Related to Regenerate API file, document how it was done (!179892 - merged)
- Related to Inconsistent use of 'cherry-pick' versus 'cherr... (gitlab-docs#1849 - closed)
- Related to Document the REST API in OpenAPI V2 (&8926) (epic)
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.