Skip to content

Add API::Snippets to OpenAPI V2

David O'Regan requested to merge 376989-snippets-openapiv2 into master

What does this MR do and why?

This adds the API::Snippets endpoints to the OpenAPI V2 documentation.

Pasting the doc file to https://editor.swagger.io/ shows two errors. But it is okay to ignore them for now, as described in https://gitlab.com/gitlab-org/gitlab/-/issues/377941:

Semantic error at paths./api/v4/snippets/{id}.put
Operations with parameters of "in: formData" must include "application/x-www-form-urlencoded" or "multipart/form-data" in their "consumes" property
Jump to line 381

Semantic error at paths./api/v4/snippets.post
Operations with parameters of "in: formData" must include "application/x-www-form-urlencoded" or "multipart/form-data" in their "consumes" property
Jump to line 507

The doc/api/openapi/openapi_v2.yaml is autogenerated using the rake gitlab:openapi:generate task.

Related issue: https://gitlab.com/gitlab-org/gitlab/-/issues/376989

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 David O'Regan

Merge request reports