Skip to content

Clarify API descriptions of ID formats

Amy Qualls requested to merge 331237-aqualls-fix-id-definitions into master

What does this MR do?

Updates API documentation on these pages, to make clearer how the ID field can be formatted:

  • doc/api/merge_request_approvals.md
  • doc/api/notification_settings.md
  • doc/api/project_clusters.md
  • doc/api/project_snippets.md
  • doc/api/projects.md
  • doc/api/resource_access_tokens.md

@katrinleinweber, @.luke, I want to be clear that this MR is a little bare-bones. I've updated the ID definitions that Katrin identified, but I haven't attempted to add in any other language like Luke mentioned #331237 (comment 596140456):

Maybe we want to add a section that discusses this to the main REST API doc (a bit similar to this clarification: https://docs.gitlab.com/ee/api/#id-vs-iid)

I'd need a rough draft from Luke before I can add that, but these changes might be enough on their own?

Related issues

Closes #331237 (closed)

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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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 Luke Duncalfe

Merge request reports