Skip to content

Add merge_requests to OpenAPI documentation

Sincheol (David) Kim requested to merge 376941-add-api-merge-requests-to-openapi-docs into master

What does this MR do and why?

This MR adds API::MergeRequests to OpenAPI V2. I've tried to use the exact text from https://docs.gitlab.com/ee/api/merge_requests.html whenever I can.

I haven't updated the following entities yet as this MR is already too big.

  • Entities::MergeRequestBasic
  • Entities::MergeRequest
  • Entities::MergeRequestReviewer
  • Entities::MergeRequestChanges
  • Entities::MRNote

I think they are nice to haves so we could improve that as a follow up if wanted. UPDATED: I've created a follow up issue #383518

Related to #376941

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 merge request 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 #376941

Edited by Sincheol (David) Kim

Merge request reports