Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Schema Inaccuracy] <Missing properties in pulls API endpoint> #3162

Closed
IllyaKh opened this issue Nov 9, 2023 · 1 comment
Closed

[Schema Inaccuracy] <Missing properties in pulls API endpoint> #3162

IllyaKh opened this issue Nov 9, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@IllyaKh
Copy link

IllyaKh commented Nov 9, 2023

Schema Inaccuracy

There are some missing fields in https://api.github.com/repos/[OWNER]/[REPO]/pulls endpoint. There are no problems with documentation but these fields exist in https://api.github.com/repos/[OWNER]/[REPO]/pulls/[ID]

Not implemented fields:

    "mergeable": false,
    "rebaseable": false,
    "mergeable_state": "dirty",
    "merged_by": null,
    "comments": 4,
    "review_comments": 20,
    "maintainer_can_modify": false,
    "commits": 25,
    "additions": 897,
    "deletions": 11,
    "changed_files": 25

Expected

https://api.github.com/repos/[OWNER]/[REPO]/pulls schema matches with the /repos/[OWNER]/[REPO]/pulls/[ID] schema

Reproduction Steps

$ curl -X POST https://api.github.com/repos/[OWNER]/[REPO]/pulls

@shiftkey shiftkey added inaccuracy enhancement New feature or request and removed inaccuracy labels Nov 9, 2023
@shiftkey
Copy link
Member

shiftkey commented Nov 9, 2023

@IllyaKh thanks for the feedback!

I believe this List pull requests endpoint was implemented to only include a subset of fields that Get a pull request supports as this endpoint is required to paginate over open and closed pull requests.

I've passed your feedback onto the team for their consideration but at the moment I believe the schema reflects what is supported by this endpoint.

@shiftkey shiftkey closed this as completed Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants