Skip to content

Extract endpoints mounted to OpenAPI

Andy Schoenen requested to merge openapi/limit-number-of-endpoints into master

What does this MR do and why?

This allows a more iterational approach to cover the whole API in the documentation. Running rake gitlab:openapi:generate on master generates 17k additions to doc/api/openapi/openapi_v2.yaml. This makes it hard to review changes.

If endpoints are mounted in a separate class that is only used to generate the OpenAPI documentation, we can add endpoints step by step and review each one until the documentation covers the full API.

How to set up and validate locally

  1. Run rake gitlab:openapi:generate on master.
  2. This generates a lot of changes.
  3. Run rake gitlab:openapi:generate on openapi/limit-number-of-endpoints.
  4. This generates only a few changes that are due to an outdated documentation.

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