Fixed example payload in protected branches API docs
What does this MR do?
id
field in the example payload is not necessary and is in fact ignored (the id
assigned to the protected branch is picked by GitLab). So this example is confusing as the reader does not know where this value came from. I think even the writer of this example got confused and assumed that the value is the project ID value, which is not true.
In fact, the whole existence of this id
field is confusing and not explained in documentation at all. It does not seem
to be necessary for any API call so it is unclear why it is exposed, even if internally exists in the database. So another issue should be to or hide the id
field or document the id
field.
Review 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. - 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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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. -
Ensure a release milestone is set.