[Schema Inaccuracy] pull request id documented as int but missing format int64

Open
#4,564 4 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
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start by locating the pull request simple id schema in the OpenAPI description and compare it with the reproduced gh pr list -R baywet/demo --json id response. The work is done when the documented type matches the returned string IDs, including the expected format.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

Pull request simple id field is documented as a int but should be a string string this is what the API returns

Expected

See inacurracy

Reproduction Steps

# or any repo really
gh pr list -R baywet/demo --json id
[
  {
    "id": "PR_kwDOIJ9Ix86M10xO"
  },
  {
    "id": "PR_kwDOIJ9Ix86M10mq"
  }
]
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.