Skip to content

Add vision for GitLab OpenAPI documentation

Andy Schoenen requested to merge document-openapi-vision into master

What does this MR do and why?

This is an attempt to document a vision for using OpenAPI to document the GitLab REST API.

It should also contain a roadmap. Maybe in the form of an epic link:

  1. Include the gitlab-grape-swagger gem.
  2. Add a pipeline job to make sure the documentation is up-to-date with every MR.
  3. Cover all endpoints in the OpenAPI documentation.
  4. Generate the Markdown documentation from OpenAPI.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports