Skip to content

Docs: improve issues API description

What does this MR do?

Add missing information to the Issues API documentation.

In particular, both the ID of a project and the URL-encoded path can be used in the parameter id.

Demo:

# Using ID of a project
curl "https://gitlab.com/api/v4/projects/1794617/issues/690/closed_by"

# Using URL-encoded path of the same project as above
curl "https://gitlab.com/api/v4/projects/gitlab-org%2fgitlab-docs/issues/690/closed_by"

The above is an arbritrary example from a public repo (issue is gitlab-docs#690 (closed), merge request that closes it is gitlab-docs!1136 (merged)). Note that both the ID and URL-encoded path work for the command.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcin Sedlak-Jakubowski

Merge request reports