[Schema Inaccuracy] Pull Request Files Changed `blob_url`, `raw_url`, and `sha` should be nullable

Open Beginner friendly
#1,945 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the OpenAPI description for the pull request files changed endpoint and compare its schema with the response from https://api.github.com/repos/pytorch/pytorch/pulls/89846/files. The work is done when blob_url, raw_url, and sha are nullable in that response schema and the description validates successfully.

Written by the indexing model from the issue text.

Description

feature inaccuracy P3

Schema Inaccuracy

When a PR changes a submodule, the blob_url and raw_url are null, in some other cases that I can't pin down the sha field is null. However, the current schema marks these fields as non-nullable.

Expected

blob_url, raw_url, and sha in PR files changed responses should be marked as nullable.

Reproduction Steps

$ curl https://api.github.com/repos/pytorch/pytorch/pulls/89846/files

The above PR changes a submodule, the fields can be seen to be nullable there.

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.