[BUG]: Type ... is not assignable to type 'never' when calling requestReviewers

[jakebailey]

What happened?

With just:

import { Octokit } from "@octokit/rest";

const gh = new Octokit();

gh.pulls.requestReviewers({
	owner: "owner",
	repo: "repo",
	pull_number: 1234,
	reviewers: ["foo", "bar", "baz"],
})

All properties of the options are flagged as errors.

You can see this at the moment in the TS playground (which does download the types): Playground Link

Versions

@octokit/types@9.1.4

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[jakebailey]

Per #528 (comment) I may have been too quick at the draw, but, the just released v9.2.0 also has this problem.

[wolfy1339]

This is a different problem than #528...

This is caused by GitHub itself. The OpenAPI spec isn't quite correct for many endpoints

Example endpoint:
PATCH /gists/{gist_id}

"gists/update": {
   [ ... ]
    requestBody: {
      content: {
        "application/json":
          | ({
              [ ... ]
              files?: {
                [key: string]:
                  | (
                      | ({
                          /** @description The new content of the file. */
                          content?: string;
                          /** @description The new filename for the file. */
                          filename?: string | null;
                        } & (
                          | Record<string, never>
                          | Record<string, never>
                          | Record<string, never>
                        ))
                      | null
                    )
                  | undefined;
              };
            } & (Record<string, never> | Record<string, never>))
          | null;
      };
    };
  };

"/gists/{gist_id}": {
[ ... ]
"patch": {
        "summary": "Update a gist",
        "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
        "tags": [
          "gists"
        ],
        "operationId": "gists/update",
        "externalDocs": {
          "description": "API method documentation",
          "url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/gist-id"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                   [ ... ]
                  "files": {
                    [ ... ]
                    "type": "object",
                    "additionalProperties": {
                      "type": "object",
                      "nullable": true,
                      "properties": {
                        "content": {
                          "description": "The new content of the file.",
                          "type": "string"
                        },
                        "filename": {
                          "description": "The new filename for the file.",
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "anyOf": [
                        {
                          "required": [
                            "content"
                          ]
                        },
                        {
                          "required": [
                            "filename"
                          ]
                        },
                        {
                          "type": "object",
                          "maxProperties": 0
                        }
                      ]
                    }
                  }
                },
                "anyOf": [
                  {
                    "required": [
                      "description"
                    ]
                  },
                  {
                    "required": [
                      "files"
                    ]
                  }
                ],
                "type": "object",
                "nullable": true
              },
            [ ... ]
              }
            }
          }
        },
  [ ... ]
      },

[wolfy1339]

I've narrowed it down to the following circumstance:

The spec is trying to specify that either reviewers or team_reviewers is present at a time, by trying to use anyOf and required.
That isn't how the JSON schema spec that OpenAPI is built on works. It will always result in undefined behaviour

Before openapi-typescript handled these quirks, but doesn't anymore.

[wolfy1339]

/cc @timrogers @nickfloyd
Can you point out this bug to the relevant team so it can get fixed

[kfcampbell]

I've brought it up in Slack, though I can't speculate at a time frame for resolution.

[kfcampbell]

@wolfy1339 now that your override has been merged, we should get automated dependency updates with the next lock file maintenance PRs, right?

[wolfy1339]

Sometimes, that may be the case.

Most of the time updates to this package is handled by octokitbot

[wolfy1339]

I'm closing out this issue as everything seems to be in working order now.

Please file a new issue if a problem arises