Skip to content

Add OpenAPI specification for GitLab API

Winnie requested to merge (removed):winniehell-openapi-mvc into master

What does this MR do?

This is a first second attempt for bringing OpenAPI specification for the GitLab API. It starts by adding specification for /v4/version and allowing to look at the documentation through the built-in Swagger UI feature.

The resulting documentation can be seen at https://gitlab.com/winniehell/gitlab/-/blob/winniehell-openapi-mvc/doc/api/openapi/openapi.yaml.

see also #16023

Screenshots

screenshot of the resulting API documentation

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Winnie

Merge request reports