Skip to content

[Schema Inaccuracy] title and issue in pulls/create should be documented as mutually exclusive and required #696

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

Open
xmo-odoo opened this issue Nov 23, 2021 · 0 comments

Comments

@xmo-odoo
Copy link

Whatever rendering tool is used on docs.github.com may not be able to handle the oneOf trick, but it should at least be documented textually:

  • title and issue can't be provided together (and I expect body is only compatible with title though I did not test it)
  • either must be provided
  • issue should probably be documented as converting / upgrading the issue to a PR

The description of the endpoint also contains a phrase / paragraph which doesn't seem to say / mean anything:

You can create a new pull request.

It follows a useful paragraphs which explains the ACL requirements around creating new PRs, but doesn't seem to be of any use or significance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants