search

octokit / openapi-types.ts

Generated TypeScript definitions based on GitHub's OpenAPI spec
MIT License
37 stars 10 forks source link

fix: Updates OpenAPI version to 14.1.0, adds http status 409 to many endpoints, adds statuses [requested, pending] to workflow.run.status, updates reference path parameter.commit-ref to parameter.git-ref-only, updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null, BREAKING CHANGE: Updates multiple endpoints to use `owner` + `repo` in place of `repository_id` #402

Closed octokitbot closed 3 months ago

octokitbot commented 3 months ago

Updates OpenAPI version to 14.1.0, adds http status 409 to many endpoints, adds statuses [requested, pending] to workflow.run.status, updates reference path parameter.commit-ref to parameter.git-ref-only, updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null

BREAKING CHANGE: Updates multiple endpoints to use owner + repo in place of repository_id

nickfloyd commented 3 months ago

@gr2m @wolfy1339 Looking for a consensus here as far as this being a breaking change before merging and creating a new major release - if y'all have time to have a 👀.

wolfy1339 commented 3 months ago

updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null

I don't believe these are breaking changes.

The other changes, seem like breaking changes, because instead of a repository_id, you need to pass the owner and repo now

nickfloyd commented 3 months ago

@wolfy1339 I can get behind that. My concern was really around how permissive the code was before and now it's a bit more restrictive on the type... but I think I am being a bit too pedantic as far as what "breaking change" means here.

octokitbot commented 3 months ago

:tada: This PR is included in version 21.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: