Branch protection "ADd user/team/app access restriction" command examples are incorrect

[zihaoyu]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-user-access-restrictions
https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-team-access-restrictions
https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-app-access-restrictions

What changes are you suggesting?

POST /repos/OWNER/REPO/branches/BRANCH/protection/restrictions/[users|teams|apps]

The code examples for the APIs above call for a JSON object

{
  "users|teams|apps": [
    "name1",
    "name2"
  ]
}

However, we will get error in response

gh: Invalid request.

For 'links/12/schema', {"apps" => ["name1"]} is not an array. (HTTP 422)
  "message": "Invalid request.\n\nFor 'links/12/schema', {\"apps\" => [\"name1\"]} is not an array.",
  "documentation_url": "https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions",
  "status": "422"
}

It turns out that the APIs need an array directly

[
  "name1",
  "name2"
]

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[Sharra-writes]

@zihaoyu Thanks for opening an issue! A lot of the REST API content is auto-generated and has to be fixed internally, so let me hunt down the team responsible for this endpoint and get it transferred over to them to look at.

[docs-bot]

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.