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

Open
#5,568 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start by locating the Pull Request review comment schema in the OpenAPI description and compare its position field with the API responses shown in the issue. Mark position as nullable and verify that the schemas for both listing and fetching review comments reflect the observed null value.

Written by the indexing model from the issue text.

Description

feature

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,
...
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.