Update OpenAPI spec (bf9c417) by workos-sdk-automation[bot] · Pull Request #125 · workos/openapi-spec

workos-sdk-automation · 2026-08-27T22:14:50Z

🤖 I see new OpenAPI changes beep boop

Automated update from https://github.com/workos/workos/tree/bf9c417018b5ce2feb68fa97f8d38b4bf4f900cf

Source PRs

workos/workos#70463
workos/workos#70538
workos/workos#70552
workos/workos#70640

Changes




└─┬Components
  └─┬Schemas
    ├─┬UpdateCustomProviderDefinitionDto
    │ └─┬Properties
    │   ├─┬token_url
    │   │ └──[🔀] description (22639:24)
    │   ├─┬authorization_url
    │   │ └──[🔀] description (22631:24)
    │   └─┬refresh_token_url
    │     └──[🔀] description (22649:24)
    ├─┬EventSchema
    │ └─┬ALLOF
    │   ├──[➕] oneOf (36423:15)
    │   ├──[➕] oneOf (36470:15)
    │   ├──[➕] oneOf (36499:15)
    │   ├──[➕] oneOf (36528:15)
    │   └─┬ONEOF
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35082:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (35100:23)❌ 
    │     │   ├──[➕] required (35101:23)❌ 
    │     │   ├──[➖] required (35107:23)❌ 
    │     │   ├──[➖] required (35108:23)❌ 
    │     │   ├──[➖] required (35109:23)❌ 
    │     │   ├──[➖] required (35110:23)❌ 
    │     │   ├──[➖] required (35106:23)❌ 
    │     │   ├──[➖] properties/created_at (35095:21)❌ 
    │     │   ├──[➖] properties/object (35075:21)❌ 
    │     │   ├──[➖] properties/permissions (35087:21)❌ 
    │     │   ├──[➖] properties/resource_type_slug (35083:21)❌ 
    │     │   ├──[➖] properties/slug (35079:21)❌ 
    │     │   ├──[➖] properties/updated_at (35100:21)❌ 
    │     │   ├──[➕] properties/id (35086:21)
    │     │   └──[➕] properties/resource_type (35090:21)
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35128:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (35146:23)❌ 
    │     │   ├──[➕] required (35147:23)❌ 
    │     │   ├──[➖] required (35170:23)❌ 
    │     │   ├──[➖] required (35171:23)❌ 
    │     │   ├──[➖] required (35172:23)❌ 
    │     │   ├──[➖] required (35173:23)❌ 
    │     │   ├──[➖] required (35174:23)❌ 
    │     │   ├──[➖] properties/created_at (35159:21)❌ 
    │     │   ├──[➖] properties/object (35141:21)❌ 
    │     │   ├──[➖] properties/permissions (35153:21)❌ 
    │     │   ├──[➖] properties/resource_type_slug (35149:21)❌ 
    │     │   ├──[➖] properties/slug (35145:21)❌ 
    │     │   ├──[➖] properties/updated_at (35164:21)❌ 
    │     │   ├──[➕] properties/id (35132:21)
    │     │   └──[➕] properties/resource_type (35136:21)
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ ├──[➕] required (35192:23)❌ 
    │     │ │ ├──[➕] required (35193:23)❌ 
    │     │ │ ├──[➖] required (35234:23)❌ 
    │     │ │ ├──[➖] required (35235:23)❌ 
    │     │ │ ├──[➖] required (35236:23)❌ 
    │     │ │ ├──[➖] required (35237:23)❌ 
    │     │ │ ├──[➖] required (35238:23)❌ 
    │     │ │ ├──[➖] properties/created_at (35223:21)❌ 
    │     │ │ ├──[➖] properties/object (35205:21)❌ 
    │     │ │ ├──[➖] properties/permissions (35217:21)❌ 
    │     │ │ ├──[➖] properties/resource_type_slug (35213:21)❌ 
    │     │ │ ├──[➖] properties/slug (35209:21)❌ 
    │     │ │ ├──[➖] properties/updated_at (35228:21)❌ 
    │     │ │ ├──[➕] properties/id (35178:21)
    │     │ │ └──[➕] properties/resource_type (35182:21)
    │     │ └─┬event
    │     │   └──[🔀] const (35174:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35220:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (35239:23)❌ 
    │     │   ├──[➖] required (35374:23)❌ 
    │     │   ├──[➖] required (35375:23)❌ 
    │     │   ├──[➖] required (35376:23)❌ 
    │     │   ├──[➖] required (35377:23)❌ 
    │     │   ├──[➖] required (35378:23)❌ 
    │     │   ├──[➖] required (35381:23)❌ 
    │     │   ├──[➖] required (35379:23)❌ 
    │     │   ├──[➖] required (35380:23)❌ 
    │     │   ├──[➖] required (35382:23)❌ 
    │     │   ├──[➖] required (35372:23)❌ 
    │     │   ├──[➖] properties/auth_method (35326:21)❌ 
    │     │   ├──[➖] properties/created_at (35361:21)❌ 
    │     │   ├──[➖] properties/ended_at (35354:21)❌ 
    │     │   ├──[➖] properties/expires_at (35349:21)❌ 
    │     │   ├──[➖] properties/impersonator (35277:21)❌ 
    │     │   ├──[➖] properties/ip_address (35300:21)❌ 
    │     │   ├──[➖] properties/object (35269:21)❌ 
    │     │   ├──[➖] properties/organization_id (35306:21)❌ 
    │     │   ├──[➖] properties/status (35341:21)❌ 
    │     │   ├──[➖] properties/updated_at (35366:21)❌ 
    │     │   ├──[➖] properties/user_agent (35312:21)❌ 
    │     │   ├──[➖] properties/user_id (35322:21)❌ 
    │     │   ├──[➕] properties/resource_type (35228:21)
    │     │   └─┬Properties
    │     │     └─┬id
    │     │       ├──[🔀] example (35227:32)
    │     │       └──[🔀] description (35226:36)
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35266:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (35302:23)❌ 
    │     │   ├──[➕] required (35303:23)❌ 
    │     │   ├──[➖] required (35517:23)❌ 
    │     │   ├──[➖] required (35518:23)❌ 
    │     │   ├──[➖] required (35519:23)❌ 
    │     │   ├──[➖] required (35520:23)❌ 
    │     │   ├──[➖] required (35521:23)❌ 
    │     │   ├──[➖] required (35522:23)❌ 
    │     │   ├──[➖] required (35524:23)❌ 
    │     │   ├──[➖] required (35523:23)❌ 
    │     │   ├──[➖] properties/auth_method (35470:21)❌ 
    │     │   ├──[➖] properties/ended_at (35498:21)❌ 
    │     │   ├──[➖] properties/expires_at (35493:21)❌ 
    │     │   ├──[➖] properties/id (35417:21)❌ 
    │     │   ├──[➖] properties/impersonator (35421:21)❌ 
    │     │   ├──[➖] properties/ip_address (35444:21)❌ 
    │     │   ├──[➖] properties/organization_id (35450:21)❌ 
    │     │   ├──[➖] properties/status (35485:21)❌ 
    │     │   ├──[➖] properties/user_agent (35456:21)❌ 
    │     │   ├──[➖] properties/user_id (35466:21)❌ 
    │     │   ├──[➕] properties/permissions (35282:21)
    │     │   ├──[➕] properties/resource_type_slug (35278:21)
    │     │   ├──[➕] properties/slug (35274:21)
    │     │   └─┬Properties
    │     │     └─┬object
    │     │       ├──[🔀] description (35272:36)
    │     │       └──[🔀] const (35273:30)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ └──[🔀] $ref (35334:19)
    │     │ └─┬event
    │     │   └──[🔀] const (35332:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ └──[🔀] $ref (35398:19)
    │     │ └─┬event
    │     │   └──[🔀] const (35396:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35460:26)❌ 
    │     │ └─┬data
    │     │   └──[🔀] $ref (35462:19)
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ ├──[➕] required (35715:23)❌ 
    │     │ │ ├──[➕] required (35718:23)❌ 
    │     │ │ ├──[➕] required (35721:23)❌ 
    │     │ │ ├──[➕] required (35711:23)❌ 
    │     │ │ ├──[➕] required (35714:23)❌ 
    │     │ │ ├──[➕] required (35716:23)❌ 
    │     │ │ ├──[➕] required (35717:23)❌ 
    │     │ │ ├──[➕] required (35719:23)❌ 
    │     │ │ ├──[➕] required (35720:23)❌ 
    │     │ │ ├──[➕] required (35712:23)❌ 
    │     │ │ ├──[➕] required (35713:23)❌ 
    │     │ │ ├──[➖] required (35652:23)❌ 
    │     │ │ ├──[➖] required (35651:23)❌ 
    │     │ │ ├──[➕] properties/auth_method (35665:21)
    │     │ │ ├──[➕] properties/created_at (35700:21)
    │     │ │ ├──[➕] properties/ended_at (35693:21)
    │     │ │ ├──[➕] properties/expires_at (35688:21)
    │     │ │ ├──[➕] properties/id (35612:21)
    │     │ │ ├──[➕] properties/impersonator (35616:21)
    │     │ │ ├──[➕] properties/ip_address (35639:21)
    │     │ │ ├──[➕] properties/object (35608:21)
    │     │ │ ├──[➕] properties/status (35680:21)
    │     │ │ ├──[➕] properties/updated_at (35705:21)
    │     │ │ ├──[➕] properties/user_agent (35651:21)
    │     │ │ ├──[➕] properties/user_id (35661:21)
    │     │ │ ├──[➖] properties (0:0)❌ 
    │     │ │ └─┬Properties
    │     │ │   └─┬organization_id
    │     │ │     ├──[🔀] example (35650:32)
    │     │ │     └──[🔀] description (35647:36)
    │     │ └─┬event
    │     │   └──[🔀] const (35604:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ └──[🔀] $ref (25975:13)
    │     │ └─┬event
    │     │   └──[🔀] const (35748:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ └──[🔀] $ref (25975:13)
    │     │ └─┬event
    │     │   └──[🔀] const (35777:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ └──[🔀] $ref (25975:13)
    │     │ └─┬event
    │     │   └──[🔀] const (35806:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ ├──[➕] required (35847:23)❌ 
    │     │ │ ├──[➕] required (35846:23)❌ 
    │     │ │ ├──[➖] required (35867:23)❌ 
    │     │ │ ├──[➖] required (35868:23)❌ 
    │     │ │ ├──[➖] required (35869:23)❌ 
    │     │ │ ├──[➖] required (35865:23)❌ 
    │     │ │ ├──[➖] required (35866:23)❌ 
    │     │ │ ├──[➖] properties/actor_id (35843:21)❌ 
    │     │ │ ├──[➖] properties/actor_name (35852:21)❌ 
    │     │ │ ├──[➖] properties/actor_source (35847:21)❌ 
    │     │ │ ├──[➖] properties/key_id (35860:21)❌ 
    │     │ │ ├──[➖] properties/kv_name (35856:21)❌ 
    │     │ │ ├──[➕] properties/key_provider (35843:21)
    │     │ │ └──[➕] properties/organization_id (35839:21)
    │     │ └─┬event
    │     │   └──[🔀] const (35835:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35874:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (35891:23)❌ 
    │     │   ├──[➕] required (35892:23)❌ 
    │     │   ├──[➕] required (35893:23)❌ 
    │     │   ├──[➖] required (35930:23)❌ 
    │     │   ├──[➖] required (35931:23)❌ 
    │     │   ├──[➖] required (35926:23)❌ 
    │     │   ├──[➖] required (35927:23)❌ 
    │     │   ├──[➖] required (35928:23)❌ 
    │     │   ├──[➖] required (35929:23)❌ 
    │     │   ├──[➖] properties/actor_id (35900:21)❌ 
    │     │   ├──[➖] properties/actor_name (35909:21)❌ 
    │     │   ├──[➖] properties/actor_source (35904:21)❌ 
    │     │   ├──[➖] properties/key_context (35921:21)❌ 
    │     │   ├──[➖] properties/key_id (35917:21)❌ 
    │     │   ├──[➖] properties/kv_name (35913:21)❌ 
    │     │   ├──[➕] properties/key_provider (35882:21)
    │     │   ├──[➕] properties/organization_id (35878:21)
    │     │   └──[➕] properties/verified (35884:21)
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ ├──[➕] required (35953:23)❌ 
    │     │ │ ├──[➕] required (35955:23)❌ 
    │     │ │ ├──[➕] properties/key_context (35945:21)
    │     │ │ ├──[➕] properties/kv_name (35937:21)
    │     │ │ └─┬Properties
    │     │ │   └─┬key_id
    │     │ │     └──[🔀] description (35943:36)
    │     │ └─┬event
    │     │   └──[🔀] const (35920:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (35982:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (36007:23)❌ 
    │     │   ├──[➖] required (36042:23)❌ 
    │     │   ├──[➖] required (36043:23)❌ 
    │     │   ├──[➖] properties/key_context (36034:21)❌ 
    │     │   ├──[➖] properties/key_ids (36027:21)❌ 
    │     │   └──[➕] properties/kv_name (35999:21)
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (36034:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (36063:23)❌ 
    │     │   ├──[➖] required (36099:23)❌ 
    │     │   ├──[➕] properties/kv_name (36051:21)
    │     │   ├──[➖] properties/key_name (36087:21)❌ 
    │     │   └─┬Properties
    │     │     └─┬key_id
    │     │       └──[🔀] description (36057:36)
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (36091:26)❌ 
    │     │ └─┬data
    │     │   ├──[➕] required (36124:23)❌ 
    │     │   ├──[➕] required (36126:23)❌ 
    │     │   ├──[➖] required (36156:23)❌ 
    │     │   ├──[➕] properties/key_context (36116:21)
    │     │   ├──[➕] properties/kv_name (36108:21)
    │     │   ├──[➖] properties (0:0)❌ 
    │     │   └─┬Properties
    │     │     └─┬key_id
    │     │       └──[🔀] description (36114:36)
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ ├──[➕] required (36178:23)❌ 
    │     │ │ ├──[➖] required (36209:23)❌ 
    │     │ │ ├──[➕] properties/key_id (36170:21)
    │     │ │ └──[➖] properties/kv_name (36201:21)❌ 
    │     │ └─┬event
    │     │   └──[🔀] const (36153:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ ├──[➕] required (36237:23)❌ 
    │     │ │ ├──[➕] required (36238:23)❌ 
    │     │ │ ├──[➕] properties/key_context (36229:21)
    │     │ │ └──[➕] properties/key_ids (36222:21)
    │     │ └─┬event
    │     │   └──[🔀] const (36205:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬data
    │     │ │ └──[🔀] $ref (36267:19)
    │     │ └─┬event
    │     │   └──[🔀] const (36265:26)❌ 
    │     ├─┬Properties
    │     │ ├─┬event
    │     │ │ └──[🔀] const (36322:26)❌ 
    │     │ └─┬data
    │     │   └──[🔀] $ref (36324:19)
    │     └─┬Properties
    │       ├─┬event
    │       │ └──[🔀] const (36379:26)❌ 
    │       └─┬data
    │         └──[🔀] $ref (36381:19)
    ├─┬DataIntegration
    │ └─┬Properties
    │   ├─┬credentials
    │   │ └──[🔀] description (37605:24)
    │   └─┬redirect_uri
    │     └──[🔀] description (37584:24)
    └─┬CustomProviderDefinitionDto
      └─┬Properties
        ├─┬authorization_url
        │ └──[🔀] description (22468:24)
        ├─┬refresh_token_url
        │ └──[🔀] description (22489:24)
        └─┬token_url
          └──[🔀] description (22477:24)


| Document Element | Total Changes | Breaking Changes |
|------------------|---------------|------------------|
| components       | 231           | 332              |

Date: 08/27/26 | Commit: Update OpenAPI spec from workos/workos@bf9c417018b5ce2feb68fa97f8d38b4bf4f900cf

- ❌ **BREAKING Changes**: _332_ out of _231_
- **Modifications**: _49_
- **Removals**: _108_
- **Additions**: _74_
- **Breaking Removals**: _108_
- **Breaking Modifications**: _24_
- **Breaking Additions**: _34_

ERROR: breaking changes discovered

greptile-apps · 2026-08-27T22:16:31Z

Greptile Summary

Updates the canonical OpenAPI contract from upstream commit bf9c417, primarily documenting custom-provider URL constraints and adding resource-export lifecycle events.

Adds resource_export.created, resource_export.completed, resource_export.downloaded, and resource_export.failed event variants.
Clarifies custom-provider endpoint URL restrictions and client-credentials response behavior.
Advances the recorded upstream synchronization SHA.

Confidence Score: 5/5

The PR appears safe to merge, with no concrete changed-code defect identified.

The new event variants are internally consistent tagged schemas, the documentation edits align with adjacent client-credentials behavior, and the synchronization marker matches the stated upstream update.

Important Files Changed

Filename	Overview
spec/open-api-spec.yaml	Adds four resource-export event variants and clarifies custom-provider and client-credentials documentation without an established contract defect.
.last-synced-sha	Advances the synchronization marker to the upstream commit represented by this specification update.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  A[Upstream WorkOS contract] --> B[OpenAPI specification]
  B --> C[Generated SDK types]
  B --> D[API documentation]
  B --> E[Webhook event models]

_{Reviews (1): Last reviewed commit: "Update OpenAPI spec from workos/workos@b..." | Re-trigger Greptile}

gjtorikian and others added 2 commits August 27, 2026 12:58

chore: bump deps

190c698

Update OpenAPI spec from workos/workos@bf9c417

00fa434

workos-sdk-automation Bot added the autogenerated label Aug 27, 2026

gjtorikian force-pushed the main branch from 190c698 to b6e34a2 Compare August 28, 2026 15:13

gjtorikian closed this Aug 28, 2026

Navigation Menu

Uh oh!

Update OpenAPI spec (bf9c417) - #125

Update OpenAPI spec (bf9c417)#125
workos-sdk-automation[bot] wants to merge 2 commits into
mainfrom
update-spec-20260827-221444-33121619067

workos-sdk-automation Bot commented Aug 27, 2026

Uh oh!

greptile-apps Bot commented Aug 27, 2026

Flowchart

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

workos-sdk-automation Bot commented Aug 27, 2026

Source PRs

Uh oh!

greptile-apps Bot commented Aug 27, 2026

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Flowchart

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

1 participant