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

Missing required properties for Create Check Run in docs #108

Closed
oscard0m opened this issue Sep 7, 2021 · 2 comments · Fixed by octokit/plugin-rest-endpoint-methods.js#694
Labels
Status: Blocked Some technical or requirement is blocking the issue Type: Bug Something isn't working as documented

Comments

@oscard0m
Copy link
Member

oscard0m commented Sep 7, 2021

What happened?
Missing required properties for

octokit.rest.checks.create({
  owner,
  repo,
});

According to GitHub Documentation, name and head_sha are required body parameters to be passed.

Minimal test case to reproduce the problem
You can see the error in Docs' table https://octokit.github.io/rest.js/v18#checks-create

What did you expect to happen?
To get the right parameters marked as required in docs.

What the problem might be
Details here: octokit/plugin-rest-endpoint-methods.js#441

@oscard0m oscard0m added the Type: Bug Something isn't working as documented label Sep 7, 2021
@oscard0m
Copy link
Member Author

oscard0m commented Sep 7, 2021

Tagging @inesilva since we discovered together

@wolfy1339
Copy link
Member

This should get fixed by octokit/plugin-rest-endpoint-methods.js#694

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Blocked Some technical or requirement is blocking the issue Type: Bug Something isn't working as documented
Projects
None yet
3 participants