Skip to content

Improve API docs for `List project merge requests`

François Rosé (OOO, back 2024-11-04) requested to merge francoisrose/2024-03-22-api-doc-list-project-mrs into master

What does this MR do and why?

Improve API docs for List project merge requests.

  • Move pagination fields to request attributes
  • Add table with response attributes
  • Add example curl command
  • Update example response

Contributes to #433318.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

How to set up and validate locally

  1. Run this curl command to see the API response for a list of project MRs:
curl --header "PRIVATE-TOKEN: <your-token>" \
  --url "https://gitlab.com/api/v4/projects/45308633/merge_requests" \
  | jq
  1. Compare the response to what's documented by this MR
Edited by François Rosé (OOO, back 2024-11-04)

Merge request reports