Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ActionsCreateWorkflowDispatchEndpoint Type does not allow workflow_id to be string #155

Closed
prototypicalpro opened this issue Aug 21, 2020 · 3 comments · Fixed by #197
Closed
Labels
Type: Bug Something isn't working as documented, or is being fixed typescript Relevant to TypeScript users only

Comments

@prototypicalpro
Copy link

What happened?

The ActionsCreateWorkflowDispatchEndpoint type does not allow workflow_id to be a string. This disallows specifying a filename as the workflow_id as described in the documentation, preventing the following code from compiling:

octokit.actions.createWorkflowDispatch({
  owner: ...
  repo: ...
  ref: ...
  workflow_id: 'the-filename.yml'
})
@prototypicalpro prototypicalpro added the Type: Bug Something isn't working as documented, or is being fixed label Aug 21, 2020
@gr2m gr2m added the typescript Relevant to TypeScript users only label Aug 21, 2020
@gr2m
Copy link
Contributor

gr2m commented Aug 23, 2020

This should be resolved once we derive the types from the JSON Schema instead of the examples, see my comment here. It will take me at least another week until I can start working on that

@gr2m
Copy link
Contributor

gr2m commented Nov 11, 2020

I'm still working on #161, but getting close. I've confirmed that it will indeed be resolved by this update, the type for the workflow_id parameter is defined here:
https://github.com/octokit/openapi-types.ts/blob/36baf50bddd8b3baecd6601ea3301e82e6b225d7/generated/types.ts#L21477

@gr2m gr2m mentioned this issue Nov 30, 2020
6 tasks
@gr2m gr2m closed this as completed in #197 Nov 30, 2020
@octokitbot
Copy link
Collaborator

🎉 This issue has been resolved in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented, or is being fixed typescript Relevant to TypeScript users only
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants