Skip to content

Update Epics OpenAPI documentation

Stanislav Dobrovolschii requested to merge sd/feature/epics-opengraph-spec into master

What does this MR do and why?

Contributes to #377019

  • Updates Epics API doc
  • Removed the epics file from Rubocop Layout/LineLength offenders

Detailed description (detail:) texts are taken from GitLab REST API documentation.

Screenshots or screen recordings

Screenshots

Screenshot_2022-11-30_at_16.35.16 Screenshot_2022-11-30_at_16.35.28 Screenshot_2022-11-30_at_16.35.44 Screenshot_2022-11-30_at_16.35.54 Screenshot_2022-11-30_at_16.37.13 Screenshot_2022-11-30_at_16.37.31

How to set up and validate locally

  1. Mount routes (add mount ::API::Epics to lib/api/api.rb:184)
  2. Run rake gitlab:openapi:generate
  3. Review changes in doc/api/openapi/openapi_v2.yaml
  4. Paste the content into https://editor.swagger.io/
  5. Search for epics references on page

MR acceptance checklist

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

Edited by Stanislav Dobrovolschii

Merge request reports