Skip to content

Sync with OpenAPI definition - #684

Open
socket-pr-bot[bot] wants to merge 1 commit into
mainfrom
automated/open-api
Open

Sync with OpenAPI definition#684
socket-pr-bot[bot] wants to merge 1 commit into
mainfrom
automated/open-api

Conversation

@socket-pr-bot

@socket-pr-bot socket-pr-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown

OpenAPI Sync

The OpenAPI definition in the API has been updated. This PR automatically:

  • Downloads the latest OpenAPI specification
  • Regenerates TypeScript types (types/api.d.ts)
  • Regenerates strict TypeScript types (src/types-strict.mts)
  • Updates SDK method signatures if needed

What's Changed

See the file changes below for specific updates to the API types, strict types, and methods.

Please review carefully for any breaking changes in the API.


Note

Medium Risk
Regenerated strict types can break compile-time assumptions (organizations map shape, new required slig on repositories) even when runtime API behavior is unchanged.

Overview
This PR refreshes generated SDK types from the latest OpenAPI spec (types/api.d.ts and src/types/strict.mts), keeping the client aligned with the API without hand-editing those files.

Repository strict/OpenAPI shapes now include a required slig field alongside slug (documented in the spec as an intentional backwards-compatibility typo). OrganizationsResult models organizations as a Record<OrganizationSlug, OrganizationItem> map (matching additionalProperties on GET /organizations), with a small unit test locking that emit behavior in the strict-type generator.

Review for TypeScript breaking changes: code that treated organizations as an array or omitted slig on repository items may need updates.

Reviewed by Cursor Bugbot for commit 479ff19. Configure here.

@socket-pr-bot socket-pr-bot Bot added dependencies Pull requests that update a dependency file automated labels Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated dependencies Pull requests that update a dependency file

Development

Successfully merging this pull request may close these issues.

1 participant