Skip to content

Add introduction to OpenAPI doc

What does this MR do and why?

This adds an introduction to the OpenAPI documentation YML file like suggested in !181715 (comment 2356886928)

References

Please include cross links to any resources that are relevant to this MR. This will give reviewers and future readers helpful context to give an efficient review of the changes introduced.

How to set up and validate locally

  • To generate the OpenAPI documentation, run bin/rake gitlab:openapi:generate
  • To check that the documentation is up-to-date, run bin/rake gitlab:openapi:check_docs

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Andy Schoenen

Merge request reports

Loading