Skip to content

Update GET MR API response for pipelines

Marcel Amirault requested to merge docs-update-mr-api-response into master

What does this MR do?

As per the discussion in the related issue, the example response in for GET'ing a single MR from the API is out of date, and does not show all the possible response parameters. The key point is that head_pipeline is not shown, and it's not clear if head_pipeline or pipeline is the best to use. From the discussion (#233122 (comment 947912304)) it looks like head_pipeline is recommended, and pipeline could actually be deprecated (I'll leave that for a separate issue).

Another parameter is already deprecated in that example, and has this note: // Deprecated and will be removed in API v5, use merge_user instead

I've copied the style and used // Old parameter, use head_pipeline instead. as an initial MVC, next to the pipeline example, to point people towards head_pipeline.

As a followup, we may want to update all the sample responses... 🤔

Related issues

Resolves #233122 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault

Merge request reports

Loading