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

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

Merged
merged 1 commit into from
Apr 1, 2024

Conversation

octokitbot
Copy link
Contributor

@octokitbot octokitbot commented Mar 19, 2024

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

@octokitbot octokitbot added Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR typescript Relevant to TypeScript users only labels Mar 19, 2024
@nickfloyd nickfloyd changed the title 🚧 OpenAPI types changed fix: Updates OpenAPI version to 14.1.0, adds statuses [requested, pending] to workflow.run.status, updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null Mar 25, 2024
@nickfloyd nickfloyd changed the title fix: Updates OpenAPI version to 14.1.0, adds statuses [requested, pending] to workflow.run.status, updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null fix: Updates OpenAPI version to 14.1.0, adds http status 409 to many endpoints, adds statuses [requested, pending] to workflow.run.status, updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null Mar 25, 2024
@nickfloyd nickfloyd changed the title fix: Updates OpenAPI version to 14.1.0, adds http status 409 to many endpoints, adds statuses [requested, pending] to workflow.run.status, updates many types from field?: unknown; to a more specific type field?: Record<string, unknown> | null 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 Mar 25, 2024
@nickfloyd nickfloyd added the Type: Breaking change Used to note any change that requires a major version bump label Mar 25, 2024
@nickfloyd
Copy link
Contributor

@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
Copy link
Member

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
Copy link
Contributor

@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.

@nickfloyd nickfloyd added Type: Breaking change Used to note any change that requires a major version bump and removed Type: Breaking change Used to note any change that requires a major version bump labels Apr 1, 2024
@nickfloyd nickfloyd changed the title 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 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 Apr 1, 2024
@nickfloyd nickfloyd merged commit 312b23b into main Apr 1, 2024
6 checks passed
@nickfloyd nickfloyd deleted the openapi-update branch April 1, 2024 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Breaking change Used to note any change that requires a major version bump Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR typescript Relevant to TypeScript users only
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants