octokit / rest.js

GitHub REST API client for JavaScript

Home Page:https://octokit.github.io/rest.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Missing required properties for `Create Check Run` in docs

oscard0m opened this issue · comments

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

Tagging @inesilva since we discovered together