[Schema Inaccuracy] Issue event rename "from" and "to" fields can be null
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Start by locating the issue-event-rename schema in the OpenAPI description and compare it with the linked issue-events API response. Update the schema so its nullability matches the documented data, then validate the description if the repository provides schema checks.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
Spec:
issue-event-rename": {
"title": "Issue Event Rename",
"description": "Issue Event Rename",
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to"
]
},
Expected
Based on the above, since from and to are marked as required they should not be null in the data, but see an example below
Reproduction Steps
https://api.github.com/repos/golang/go/issues/50851/events?sort=updated&direction=desc&per_page=100
...
{
"id": 5963856655,
"node_id": "RTE_lADOAWBuf85CiGTczwAAAAFjeTsP",
"url": "https://api.github.com/repos/golang/go/issues/events/5963856655",
"actor": {
"login": "hyangah",
"id": 4999471,
"node_id": "MDQ6VXNlcjQ5OTk0NzE=",
"avatar_url": "https://avatars.githubusercontent.com/u/4999471?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/hyangah",
"html_url": "https://github.com/hyangah",
"followers_url": "https://api.github.com/users/hyangah/followers",
"following_url": "https://api.github.com/users/hyangah/following{/other_user}",
"gists_url": "https://api.github.com/users/hyangah/gists{/gist_id}",
"starred_url": "https://api.github.com/users/hyangah/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/hyangah/subscriptions",
"organizations_url": "https://api.github.com/users/hyangah/orgs",
"repos_url": "https://api.github.com/users/hyangah/repos",
"events_url": "https://api.github.com/users/hyangah/events{/privacy}",
"received_events_url": "https://api.github.com/users/hyangah/received_events",
"type": "User",
"user_view_type": "public",
"site_admin": false
},
"event": "renamed",
"commit_id": null,
"commit_url": null,
"created_at": "2022-01-27T13:46:50Z",
"rename": {
"from": null,
"to": null
},
"performed_via_github_app": null
},
...
- 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
-
clawsweeper:linked-pr-open clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:message-loss issue-rating: 🦞 diamond lobster maturity:stable P2
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
growthbook/growthbook#7100 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
punkpeye/mcp-remote#369 ·
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/azure-sdk-for-net#63292 · 3 comments · 1 reaction ·
-
bug p:3-mid pydanty:bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
pydantic/pydantic-ai#8643 · 1 comment ·