Skip to content

Branch Protection Rules API docs missing enforcement_level in required_status_checks #16691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
mhaley-tignis opened this issue Mar 30, 2022 · 2 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team rest Content related to rest - overview.

Comments

@mhaley-tignis
Copy link

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/reference/branches#update-branch-protection

What part(s) of the article would you like to see updated?

The parameters are not very clear on what to put inside required_status_checks, required_pull_request_reviews and restrictions. From the code sample, you can piece together most of it, but that example doesn't actually work. In my specific case I discovered that a required_status_checks object needs to look like below, at the minimum to enable status checks:

{
    "strict": true,
    "contexts": [],
    "enforcement_level": "non_admins"
}

Additional information

No response

@mhaley-tignis mhaley-tignis added the content This issue or pull request belongs to the Docs Content team label Mar 30, 2022
@welcome
Copy link

welcome bot commented Mar 30, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 30, 2022
@ramyaparimi ramyaparimi added rest Content related to rest - overview. rest-description and removed triage Do not begin working on this issue until triaged by the team labels Mar 31, 2022
@docubot
Copy link
Contributor

docubot commented Mar 31, 2022

Thank you for opening this issue! Updates to the REST/GraphQL API description must be made internally. I have copied your issue to an internal issue, so I will close this issue.

@docubot docubot closed this as completed Mar 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team rest Content related to rest - overview.
Projects
None yet
Development

No branches or pull requests

3 participants