Skip to content

[Schema Inaccuracy] Pull Request Review Comment position should be nullable #1901

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
bigfootjon opened this issue Nov 23, 2022 · 0 comments

Comments

@bigfootjon
Copy link

bigfootjon commented Nov 23, 2022

Schema Inaccuracy

For each Pull Request Comment in the API, it has a position field attached. Some comments are not attached to a position so this field is null. The Schema does not reflect this nuance.

Expected

position in Pull Request review comments should be marked as nullable

Reproduction Steps

We have observed this in 2 different APIs, either listing PR review comments or fetching a specific comment:

$ curl https://api.github.com/repos/pytorch/tutorials/pulls/2120/comments
$ curl https://api.github.com/repos/pytorch/tutorials/pulls/comments/1024558033

In both cases, the position field is null:

...
"position": null,
...
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

3 participants