TypeScript signature of issues.setLabels does not allow correct type of labels attribute.

[ghost]

Checklist

• I checked all open bugs and none of them matched my problem.

Environment

• Node.js

Versions

├── @octokit/auth-app@3.6.0
├── @octokit/rest@18.9.1

What happened?

The params object type for rest.issues.setLabels requires the labels attribute to be of type string[] & { name: string; }[] I have not found a value that allows this type signature to be satisfied, and I think it is incorrect.

Minimal test case to reproduce the problem

export const setIssueLabels = async (
  context: Context,
  labels: string[]
): Promise<void> => {
  await context.client.rest.issues.setLabels({
    issue_number: context.issue.number,
    owner: context.repo.owner,
    repo: context.repo.repo,
    labels: labels,
  });
};

Causes the following TypeScript error:

Type 'string[]' is not assignable to type 'string[] & { name: string; }[]'.
  Type 'string[]' is not assignable to type '{ name: string; }[]'.
    Type 'string' is not assignable to type '{ name: string; }'

The error also occurs when attempting to pass in an array of { name: string }

I know that using a string[] is valid, the above code works, it just requires casting the labels to any.

What did you expect to happen?

string[] to be an allowed type of labels attribute

What the problem might be

The type of labels attribute should be string[] | { name: string; }[]

[gr2m]

Thanks @sonnen-athene I was able to reproduce the problem using @octokit/openapi-types: TypeScript playground link

RequestBodyParameters["labels"] should be a union, not an intersection.

this might either be a problem with GitHub's OpenAPI spec that we use to generate the types for the endpoints, or the generated types in https://github.com/octokit/openapi-types.ts.

I won't be able to look into this today myself, but will get to it eventually. Can you check the OpenAPI spec? I gut feeling is that there is a allOf where there should be a anyOf in the spec for this operation

[ghost]

Thanks for the quick turn around. I'll give those a look and see what I can find out.

[ghost]

Looks like this is already captured in this issue and isn't caused by this library. Because of that I'll go ahead and close.

[gr2m]

perfect, thank you so much for tracking that down. I'm sorry I forgot about that one

[github-actions]

🎉 This issue has been resolved in version 18.10.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀