Skip to content

Add API::Suggestions to OpenAPI V2

Sincheol (David) Kim requested to merge 376993-add-api-suggestions-endpoints-to-openapiv2-documentation into master

What does this MR do and why?

This MR adds API::Suggestions to OpenAPI V2.

https://editor.swagger.io/ shows two warnings, but I believe we're ignoring it for now as mentioned in https://gitlab.com/gitlab-org/gitlab/-/issues/377941

Related to #376993

How to set up and validate locally

  1. Run rake gitlab:openapi:generate
  2. Review changes in doc/api/openapi/openapi_v2.yaml
  3. Paste the content into https://editor.swagger.io/ and look for suggestions section and review the content

MR acceptance checklist

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

Related to #376993

Merge request reports