[Schema Inaccuracy] Schema says array of objects, but response had a null value in the array alongside the objects
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Locate the OpenAPI description for the List Public Repositories endpoint and inspect the response array schema against the documented example. Update the schema so its items allow both minimal repository objects and null, then verify that the endpoint description matches the reproduced response.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-public-repositories
The List Public Repositories endpoint is supposed to return an array of minimal repository objects.
One of the values in such a response at a certain offset was null instead of a minimal repository object.
Expected
Schema should specify that array may contain null values and minimal repository objects, rather than only saying that it contains minimal repository objects.
Reproduction Steps
curl -i "https://api.github.com/repositories?since=263175046"
HTTP/1.1 200 OK
Date: Thu, 13 Feb 2025 06:21:57 GMT
Content-Type: application/json; charset=utf-8
Cache-Control: public, max-age=60, s-maxage=60
Vary: Accept,Accept-Encoding, Accept, X-Requested-With
ETag: W/"94f54685d2f34d4b33402468be31a060f63dbbe9842c0d0294064dc2805f8454"
X-GitHub-Media-Type: github.v3; format=json
Link: <https://api.github.com/repositories?since=263175278>; rel="next", <https://api.github.com/repositories{?since}>; rel="first"
x-github-api-version-selected: 2022-11-28
# …
X-GitHub-Request-Id: D170:2F4C71:38ABFF0:3A8CE3C:67AD8F86
[
{
"id": 263175047,
"node_id": "MDEwOlJlcG9zaXRvcnkyNjMxNzUwNDc=",
"name": "design-patterns-php",
"full_name": "ninja-tn/design-patterns-php",
"private": false,
# …
"deployments_url": "https://api.github.com/repos/ninja-tn/design-patterns-php/deployments"
},
# …
# many lines more, omitted for brevity
# …
{
"id": 263175062,
"node_id": "MDEwOlJlcG9zaXRvcnkyNjMxNzUwNjI=",
"name": "38671075_60",
"full_name": "offlinesite/38671075_60",
"private": false,
# …
"deployments_url": "https://api.github.com/repos/offlinesite/38671075_60/deployments"
},
null,
{
"id": 263175064,
"node_id": "MDEwOlJlcG9zaXRvcnkyNjMxNzUwNjQ=",
"name": "onLlineBooks",
"full_name": "crisantus/onLlineBooks",
"private": false,
# …
"deployments_url": "https://api.github.com/repos/crisantus/onLlineBooks/deployments"
}
# …
# many lines more, omitted for brevity
# …
]
There between object with id 263175062 and object with id 263175064 is a null instead of a minimal repository object.
- Dominant language
- No language data
- Stars
- 1.6k
- Forks
- 342
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 57
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
github/rest-api-description#7220 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
All issues in github/rest-api-description
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
canonical/paas-charm#368 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
status/awaiting_triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100