ChecksListSuitesForRefResponseCheckSuitesItem is missing keys about plugin-rest-endpoint-methods.js

[sean-krail]

Created a GHE support ticket for this and here's a curl + jq request you can make to show you the response's keys/structure:

curl --silent --header 'Accept: application/vnd.github.antiope-preview+json' \
    "https://api.github.com/repos/octokit/plugin-rest-endpoint-methods.js/commits/master/check-suites" \
  | jq --raw-output '.check_suites[0]' \                                        
  | less

[gr2m]

The code & types are generated based on https://github.com/octokit/routes/, which scrapes the documentation at https://developer.github.com/v3/.

If the keys are missing in the docs, could you send an email to [email protected]? They will forward it to the right people. It would help if you would send along a curl request with the response showing the keys. Once the documentation is fixed, this repo will get updated automatically trough an update of @octokit/routes

[gr2m]

You can get the types from @octokit/openapi-types now

import { components } from "@octokit/openapi-types"

type CheckSuite = components["schemas"]["check-suite"]
const test: CheckSuite = {
    created_at: "",
    updated_at: "",
    latest_check_runs_count: 1,
    check_runs_url: "",
    head_commit: {},
    // ...
}

playground