feat!(generated): regenerate from spec (6 changes)#544
feat!(generated): regenerate from spec (6 changes)#544workos-sdk-automation[bot] wants to merge 1 commit intomainfrom
Conversation
Greptile SummaryThis is an auto-generated SDK regeneration from the OpenAPI spec, introducing several breaking changes: org- and user-scoped API key types replace the generic Confidence Score: 4/5Safe to merge; all findings are P2 style/quality issues with no runtime impact. The generated changes are structurally sound — type aliases are wired correctly, iterator generics updated consistently, and testdata aligns with the new model shapes. Three P2 findings (unused
Important Files Changed
|
| // CreateUserAPIKey represents a create user api key. | ||
| type CreateUserAPIKey struct { | ||
| // Name is a descriptive name for the API key. | ||
| Name string `json:"name"` | ||
| // OrganizationID is the ID of the organization the user API key is associated with. The user must have an active membership in this organization. | ||
| OrganizationID string `json:"organization_id"` | ||
| // Permissions is the permission slugs to assign to the API key. Each permission must be enabled for user API keys. | ||
| Permissions []string `json:"permissions,omitempty"` |
There was a problem hiding this comment.
CreateUserAPIKey is unused dead code
CreateUserAPIKey has the exact same fields as UserManagementCreateAPIKeyParams (both have Name, OrganizationID, and Permissions), but no function in the codebase accepts CreateUserAPIKey as a parameter — UserManagementCreateAPIKeyParams is what CreateAPIKey actually uses. This struct appears to be a generated artifact that was never wired up.
Summary
feat!(api_keys): Break ApiKey owner field type and restructure responses
ApiKeyList,ApiKeyWithValue,ApiKeyWithValueOwner,ApiKeyListListMetadatamodelsApiKey.ownerfield type fromApiKeyCreatedDataOwnerto organization-specific owner typeListOrganizationAPIKeysresponse fromIterator[ApiKey]toIterator[OrganizationAPIKey]CreateOrganizationAPIKeyresponse fromApiKeyWithValuetoOrganizationAPIKeyWithValueOrganizationAPIKey,OrganizationAPIKeyWithValue,OrganizationAPIKeyOwner,OrganizationAPIKeyWithValueOwnerfeat(user_management): Add user API key management and JWT template retrieval
ListAPIKeys(userID, params)to list user API keys with optional organization filterCreateAPIKey(userID, params)to create API keys for usersListJWTTemplate()to retrieve JWT template for current environmentUserAPIKey,UserAPIKeyWithValue,UserAPIKeyOwner,UserAPIKeyWithValueOwner,CreateUserAPIKeyUserManagementListAPIKeysParamsandUserManagementCreateAPIKeyParamsfor new operationsfeat!(user_management): Add breaking user field to organization memberships
userfield toUserOrganizationMembership(breaking: required new field)userfield toOrganizationMembership(breaking: required new field)userfield toUserOrganizationMembershipBaseListData(breaking: required new field)feat!(directory_sync): Add breaking name field to directory user models
namefield toDirectoryUser(breaking: required new field)namefield toDirectoryUserWithGroups(breaking: required new field)namefield toDsyncUserUpdatedData(breaking: required new field)feat!(sso): Add breaking name field to user profile
namefield toProfile(breaking: required new field)feat(events): Add ADMIN_PORTAL actor source and vault BYOK key deleted event
ADMIN_PORTALvalue toEventContextActorSourceenumADMIN_PORTALvalue toFlagCreatedContextActorSource,FlagDeletedContextActorSource,FlagRuleUpdatedContextActorSource,FlagUpdatedContextActorSourceenumsVaultByokKeyDeleted,VaultByokKeyDeletedData,VaultByokKeyDeletedDataKeyProviderenumTriggered by workos/openapi-spec@058a0a4
BEGIN_COMMIT_OVERRIDE
feat!(api_keys): Break ApiKey owner field type and restructure responses
feat(user_management): Add user API key management and JWT template retrieval
feat!(user_management): Add breaking user field to organization memberships
feat!(directory_sync): Add breaking name field to directory user models
feat!(sso): Add breaking name field to user profile
feat(events): Add ADMIN_PORTAL actor source and vault BYOK key deleted event
END_COMMIT_OVERRIDE