Skip to content

Regenerate openapi_v2.yaml

François Rosé requested to merge francoisrose/2024-03-13-regenerate-openapi-v2 into master

What does this MR do and why?

What: Regenerate openapi_v2.yaml by running rake gitlab:openapi:generate. See output here: https://gitlab.com/gitlab-org/gitlab/-/blob/8203bfae54aa3e029612652123263af98fe44e06/doc/api/openapi/openapi_v2.yaml

Why:

  1. The spec is currently outdated. A lot of work was done to document our APIs in code (&8926), but this file hasn't been generated to reflect all of these changes.
  2. This helps with an ongoing API document effort: #433318 (comment 1813457387)

MR acceptance checklist

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

Screenshots or screen recordings

Before After
Screenshot_2024-03-14_at_08.31.23 Screenshot_2024-03-14_at_08.33.13

How to set up and validate locally

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

  1. Observe that only 3 endpoints groups are currently present in the openapi_v2.yaml spec file: user_counts, metadata, access_requests
  2. Run rake gitlab:openapi:generate
  3. The updated openapi_v2.yaml file should match the changes in this MR
Edited by François Rosé

Merge request reports