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.

Sign up for GitHub

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

Jump to bottom

Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"] response type is incomplete #284

Closed
ojab opened this issue Mar 8, 2021 · 5 comments
Closed

Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"] response type is incomplete #284

ojab opened this issue Mar 8, 2021 · 5 comments
Labels
Type: Bug Something isn't working as documented, or is being fixed

Comments

@ojab
Copy link

ojab commented Mar 8, 2021 •
edited
Loading

What happened?

Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"] has no files field in response type.

What did you expect to happen?

It has files field.

What the problem might be

Content in openapi-types is "application/json": components["schemas"]["git-commit"];, I suppose it should be "application/json": components["schemas"]["commit"]; (which has files? field).
@ojab ojab added the Type: Bug Something isn't working as documented, or is being fixed label Mar 8, 2021
@ojab ojab changed the title Endpoints["POST /repos/{owner}/{repo}/git/trees"] response type is inomplete Endpoints["POST /repos/{owner}/{repo}/git/trees"] response type is incomplete Mar 8, 2021
@gr2m
Copy link
Contributor

gr2m commented Mar 8, 2021

could you do me a favor and report this issue in https://github.com/github/rest-api-description, similar to e.g. github/rest-api-description#228? I can do it myself but have other priorities right now. If you could report it we would get it fixed faster

@gr2m gr2m mentioned this issue Mar 8, 2021
Open
@ojab
Copy link
Author

ojab commented Mar 8, 2021

Sure, will do tomorrow.
(CONTRIBUTING.md should probably be fixed. it mentions @octokit/plugin-paginate-rest right now and I was kinda lost in which package this stuff should go)

gr2m added a commit that referenced this issue Mar 8, 2021
@gr2m
docs(CONTRIBUTING): replace plugin-paginate-rest.js with types.ts
8be46a3 
thanks @ojab #284 (comment)
@gr2m
Copy link
Contributor

gr2m commented Mar 8, 2021

(CONTRIBUTING.md should probably be fixed. it mentions @octokit/plugin-paginate-rest right now and I was kinda lost in which package this stuff should go)

Done, sorry for that!

@ojab ojab changed the title Endpoints["POST /repos/{owner}/{repo}/git/trees"] response type is incomplete Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"] response type is incomplete Mar 9, 2021
@ojab ojab changed the title Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"] response type is incomplete Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"] response type is incomplete Mar 9, 2021
@ojab
Copy link
Author

ojab commented Mar 9, 2021 •
edited
Loading

Ok, this one is bogus, I've looked into octokit.repos.getCommit docs and used octokit.git.getCommit in the code 🤦

Done, sorry for that!

I was thinking about adding a link to https://github.com/github/rest-api-description since types are actually generated based on it.

@ojab ojab closed this as completed Mar 9, 2021
@gr2m
Copy link
Contributor

gr2m commented Mar 9, 2021

I was thinking about adding a link to https://github.com/github/rest-api-description since types are actually generated based on it.

Good idea! It wasn't the case when I created this repository, but I'll incorporate it now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Bug Something isn't working as documented, or is being fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gr2m @ojab