The type defintion for octokit.rest.actions.listArtifactsForRepo is missing workflow_run
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
The type definition for the response from octokit.rest.actions.listArtifactsForRepo is incomplete, it is missing the workflow_run property
To Reproduce
Open node_modules@octokit\openapi-types\types.d.ts on line 7899 and observe there is no workflow_run property to be seen
artifact: {
id: number;
node_id: string;
/** The name of the artifact. /
name: string;
/* The size in bytes of the artifact. /
size_in_bytes: number;
url: string;
archive_download_url: string;
/* Whether or not the artifact has expired. */
expired: boolean;
created_at: string | null;
expires_at: string | null;
updated_at: string | null;
};


Expected behavior
The typescript type definition to match the observed response, and the github documentation
https://docs.github.com/en/rest/actions/artifacts#list-artifacts-for-a-repository
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at node_modules@octokit/openapi-types/types.d.ts around line 7899 and compare the artifact shape with the linked GitHub REST API documentation. The work is done when the listArtifactsForRepo response type includes the documented workflow_run property and matches the observed response.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100