Skip to content

Add API::Ci::Runners endpoints to OpenApiV2 documentation

Pedro Pombeiro requested to merge pedropombeiro/376879/add-runners-endpoints-to-openapiv2-docs into master

What does this MR do and why?

Describe in detail what your merge request does and why.

This MR adds OpenApiV2 documentation for the API::Ci::Runners endpoints. It also fixes some inconsistencies in the text between the Markdown and the implementation class.

Closes https://gitlab.com/gitlab-org/gitlab/-/issues/376879+

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

image

How to set up and validate locally

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

  1. Run rake gitlab:openapi:generate
  2. Review changes in doc/api/openapi/openapi_v2.yaml. You can check the content of the file by pasting it into https://editor-next.swagger.io. Errors will be shown on the left side.

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 Pedro Pombeiro

Merge request reports