Skip to content
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

Missing response properties on the branch protection api #2465

Closed
chris-smith-zocdoc opened this issue Jun 23, 2022 · 4 comments · Fixed by #2485
Closed

Missing response properties on the branch protection api #2465

chris-smith-zocdoc opened this issue Jun 23, 2022 · 4 comments · Fixed by #2485
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request

Comments

@chris-smith-zocdoc
Copy link

There are several newer properties on the branch protection api that are missing

  • required_signatures
  • required_linear_history
  • allow_force_pushes
  • allow_deletions
  • required_conversation_resolution

Relevant response model https://github.com/octokit/octokit.net/blob/main/Octokit/Models/Response/BranchProtection.cs

Api
https://docs.github.com/en/rest/branches/branch-protection#get-branch-protection

@timrogers
Copy link
Contributor

@chris-smith-zocdoc Thanks for reaching out! Would you be open to create a PR to add these fields?

@chris-smith-zocdoc
Copy link
Author

@timrogers potentially. Could you point me toward something that explains what type of testing / documentation is required for these new properties

@JonruAlveus
Copy link
Collaborator

@chris-smith-zocdoc It looks like there's some options for integration tests in RepositoryBranchesClientTests.TheGetBranchProtectionMethod where you can test that the properties are pulling back correctly. It doesn't look like there's any unit testing. Documentation is just summary tags on classes & properties.

@nickfloyd
Copy link
Contributor

I added "up for grabs" just in case @chris-smith-zocdoc is not able to get to this - this would definitely be a great addition to provide more functionality to our community while we work on generative models.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants