Update OpenAPI spec (bee28a8) - #182
workos-sdk-automation[bot] wants to merge 1 commit into
Conversation
|
| message: | ||
| type: string | ||
| description: A human-readable description of the error. | ||
| example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.' |
There was a problem hiding this comment.
The new 403 response documents an inactive organization member, but its example says the organization was not found. Generated documentation will therefore show clients a different failure from the status being described. Use an example that represents an inactive membership here and in the PUT response at line 15256.
Knowledge Base Used:
Prompt To Fix With AI
This is a comment left during a code review.
Path: spec/open-api-spec.yaml
Line: 15057
Comment:
**403 Example Describes 404**
The new `403` response documents an inactive organization member, but its example says the organization was not found. Generated documentation will therefore show clients a different failure from the status being described. Use an example that represents an inactive membership here and in the PUT response at line 15256.
**Knowledge Base Used:**
- [OpenAPI service contract](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/openapi-spec/-/docs/openapi-contract.md)
- [API resource surface](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/openapi-spec/-/docs/api-resource-surface.md)
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
SDK compatibility report❌ Matrix result:
Missing diagnostics
Changes by domain
|
| Method | Changes | Languages |
|---|---|---|
CreateOrganizationConnectedAccountParams.new |
body type: ConnectedAccountInput → OrganizationConnectedAccount |
rust |
Pipes
Parameter changes (12)
| Method | Changes | Languages |
|---|---|---|
Pipes.create_organization_connected_account |
state type: ConnectedAccountInputState | str | None → OrganizationConnectedAccountState | str | None; user_id now required |
python, ruby |
Pipes.createOrganizationConnectedAccount |
state type: ConnectedAccountInputState? → OrganizationConnectedAccountState?; requestOptions moved 7→8; userId now required |
ios, php, python |
Pipes.update_organization_connected_account |
state type: ConnectedAccountInputState | str | None → OrganizationConnectedAccountState | str | None; user_id now required |
python, ruby |
Pipes.updateOrganizationConnectedAccount |
state type: ConnectedAccountInputState? → OrganizationConnectedAccountState?; supportsMultipleConnections moved 7→8; connectedAccountId moved 8→9; requestOptions moved 9→10; userId now required |
ios, php, python |
Type changes (2)
PipesCreateOrganizationConnectedAccountParams.state type changed (field)
| Language | Before | After |
|---|---|---|
| go 📄 pipes.go |
PipesCreateOrganizationConnectedAccountParams.statetype: *ConnectedAccountInputState |
PipesCreateOrganizationConnectedAccountParams.statetype: *OrganizationConnectedAccountState |
PipesUpdateOrganizationConnectedAccountParams.state type changed (field)
| Language | Before | After |
|---|---|---|
| go 📄 pipes.go |
PipesUpdateOrganizationConnectedAccountParams.statetype: *ConnectedAccountInputState |
PipesUpdateOrganizationConnectedAccountParams.statetype: *OrganizationConnectedAccountState |
UpdateOrganizationConnectedAccountParams
Parameter changes (1)
| Method | Changes | Languages |
|---|---|---|
UpdateOrganizationConnectedAccountParams.new |
body type: ConnectedAccountInput → OrganizationConnectedAccount |
rust |
Soft-risk (14)
Pipes
Parameter changes (14)
| Method | Changes | Languages |
|---|---|---|
Pipes.createOrganizationConnectedAccount |
accessToken moved 2→3; refreshToken moved 3→4; expiresAt moved 4→5; scopes moved 5→6; state moved 6→7; options moved 7→8 |
php |
Pipes.updateOrganizationConnectedAccount |
accessToken moved 2→3; refreshToken moved 3→4; expiresAt moved 4→5; scopes moved 5→6; state moved 6→7; supportsMultipleConnections moved 7→8; connectedAccountId moved 8→9; options moved 9→10 |
php |
Additive (12)
OrganizationConnectedAccount
| Change | Languages |
|---|---|
OrganizationConnectedAccount added (type) |
ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
OrganizationConnectedAccount.accessToken added (field) |
ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
OrganizationConnectedAccount.expiresAt added (field) |
ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
OrganizationConnectedAccount.refreshToken added (field) |
ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
OrganizationConnectedAccount.scopes added (field) |
ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
OrganizationConnectedAccount.state added (field) |
ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
OrganizationConnectedAccountState added (type) |
go 📄 enums.go ios 📄 Sources/WorkOS/Enums/OrganizationConnectedAccountState.swift rust 📄 src/enums/organization_connected_account_state.rs |
OrganizationConnectedAccountState.connected added (enum value) |
ios 📄 Sources/WorkOS/Enums/OrganizationConnectedAccountState.swift rust 📄 src/enums/organization_connected_account_state.rs |
OrganizationConnectedAccountState.needsReauthorization added (enum value) |
ios 📄 Sources/WorkOS/Enums/OrganizationConnectedAccountState.swift rust 📄 src/enums/organization_connected_account_state.rs |
OrganizationConnectedAccountState.Unknown added (enum value) |
rust 📄 src/enums/organization_connected_account_state.rs |
Pipes
| Change | Languages |
|---|---|
PipesCreateOrganizationConnectedAccountOptions.UserId added (field) |
dotnet 📄 src/WorkOS.net/Services/Pipes/_interfaces/PipesOptions.cs go 📄 pipes.go ios 📄 Sources/WorkOS/Models/OrganizationConnectedAccount.swift php 📄 lib/Resource/OrganizationConnectedAccount.php python 📄 src/workos/pipes/models/organization_connected_account.py ruby 📄 lib/workos/pipes/organization_connected_account.rb rust 📄 src/models/organization_connected_account.rs |
PipesUpdateOrganizationConnectedAccountOptions.UserId added (field) |
dotnet 📄 src/WorkOS.net/Services/Pipes/_interfaces/PipesOptions.cs go 📄 pipes.go |
🤖 I see new OpenAPI changes beep boop
Automated update from https://github.com/workos/workos/tree/bee28a898e7067d23e29b2a6f37c8897d5413611
Source PRs
Changes