Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Schema Inaccuracy] Issue event rename "from" and "to" fields can be null

Open
#5,705 1 comment 0 reactions 0 assignees View on GitHub

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

documentation

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

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.