Skip to content

Update OpenAPI spec (6e6d80d) - #107

Open
workos-sdk-automation[bot] wants to merge 1 commit into
mainfrom
update-spec-20260817-222857-32076105661
Open

Update OpenAPI spec (6e6d80d)#107
workos-sdk-automation[bot] wants to merge 1 commit into
mainfrom
update-spec-20260817-222857-32076105661

Conversation

@workos-sdk-automation

Copy link
Copy Markdown
Contributor

🤖 I see new OpenAPI changes beep boop

Automated update from https://github.com/workos/workos/tree/6e6d80dffb7a8e792bfb98885ada4f3af65aa606

Source PRs

  • workos/workos#68965
Changes



├─┬Paths
│ ├──[➕] it_contacts (11217:3)
│ └──[➕] {contact_id} (11372:3)
├─┬Tags
│ └──[➕] organizations.it-contacts (20037:5)
└─┬Components
  ├──[➕] schemas/CreateItContactDto (21346:7)
  ├──[➕] schemas/ItContact (35826:7)
  └──[➕] schemas/ItContactList (35859:7)


| Document Element | Total Changes | Breaking Changes |
|------------------|---------------|------------------|
| paths            | 2             | 0                |
| tags             | 1             | 0                |
| components       | 3             | 0                |

Date: 08/17/26 | Commit: Update OpenAPI spec from workos/workos@6e6d80dffb7a8e792bfb98885ada4f3af65aa606

- **Total Changes**: _6_
- **Additions**: _6_

@greptile-apps

greptile-apps Bot commented Aug 17, 2026

Copy link
Copy Markdown

Greptile Summary

The PR synchronizes the canonical OpenAPI contract to source revision 6e6d80d, adding organization IT-contact list, create, and delete operations.

  • Adds the organizations.it-contacts tag and three operations.
  • Adds request, resource, and list schemas for IT contacts.
  • Advances the downstream synchronization marker.

Confidence Score: 4/5

The PR appears safe to merge after considering the non-blocking pagination-contract inconsistency in the new list operation.

The new list response exposes navigation cursors that generated clients cannot submit because the operation declares no pagination query parameters; no blocking schema, generation, synchronization, or security failure was established.

Files Needing Attention: spec/open-api-spec.yaml

Important Files Changed

Filename Overview
spec/open-api-spec.yaml Adds the IT-contact API surface and schemas; the list response advertises cursor navigation without corresponding request parameters.
.last-synced-sha Advances the opaque synchronization marker to the source revision identified by the PR.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Spec[OpenAPI specification] --> List[GET organization IT contacts]
  Spec --> Create[POST organization IT contact]
  Spec --> Delete[DELETE organization IT contact]
  List --> ListSchema[ItContactList]
  Create --> ContactSchema[ItContact]
  Create --> CreateSchema[CreateItContactDto]
  ListSchema --> ContactSchema
  Marker[.last-synced-sha] --> SDK[Downstream SDK synchronization]
Loading
Prompt To Fix All With AI
### Issue 1
spec/open-api-spec.yaml:11217-11228
**Pagination cursors lack inputs**

The response exposes `before` and `after` cursors for navigating the IT-contact list, but this operation accepts only `organization_id`. Generated clients therefore cannot submit a returned cursor to navigate to another page; add the supported pagination parameters or use a non-paginated response shape.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

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

@github-actions

Copy link
Copy Markdown
Contributor

SDK compatibility report

❌ Matrix result: failure

📄 View full code diff

Language Breaking Soft-risk Additive
dotnet n/a n/a n/a
go 0 0 21
ios 0 0 0
kotlin 0 1 22
php 3 0 21
python n/a n/a n/a
ruby 1 1 18
rust 0 0 20

Missing diagnostics

  • dotnet: compat-report.json missing
  • python: compat-report.json missing

Changes by domain

Domain Breaking Soft-risk Additive Languages
CreateDataIntegrationAuthMethods 3 php
CreatePasswordResetToken 1 1 kotlin, ruby
ItContact 13 go, kotlin, php, ruby, rust
OrganizationsItContacts 10 go, kotlin, php, ruby, rust
OrganizationsItContactService 4 go, kotlin
CreateOrganizationItContactParams 2 rust
Client 1 go, kotlin, php, ruby
CreateItContact 1 kotlin, php, ruby, rust
WaitlistUser 1 go, php, ruby, rust
WorkOS 1 php, ruby

Breaking (4)

CreateDataIntegrationAuthMethods

1 enum, 2 enum values removed
Symbol Kind Languages
CreateDataIntegrationAuthMethods enum php
CreateDataIntegrationAuthMethods.ApiKey enum value php
CreateDataIntegrationAuthMethods.OAuth enum value php

CreatePasswordResetToken

Removed methods (1)

Method Languages
CreatePasswordResetToken ruby

Soft-risk (1)

CreatePasswordResetToken

1 field removed
Symbol Kind Languages
CreatePasswordResetToken.email field kotlin, ruby

Additive (33)

Client

Change Languages
Client.OrganizationsItContacts added (function) go
📄 workos.go
kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt
php
📄 lib/Service/OrganizationsItContacts.php
ruby
📄 lib/workos/organizations_it_contacts.rb

CreateItContact

Change Languages
CreateItContact added (type) kotlin
📄 src/main/kotlin/com/workos/models/CreateItContact.kt
php
📄 lib/Resource/CreateItContact.php
ruby
📄 lib/workos/organizations_it_contacts/create_it_contact.rb
rust
📄 src/models/create_it_contact.rs

CreateOrganizationItContactParams

Change Languages
CreateOrganizationItContactParams added (service) rust
📄 src/resources/organizations_it_contacts.rs
CreateOrganizationItContactParams.new(body) added (function) rust
📄 src/resources/organizations_it_contacts.rs

ItContact

Change Languages
ItContact added (type) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContact.kt
php
📄 lib/Resource/ItContact.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact.rb
rust
📄 src/models/it_contact.rs
ItContact.created_at added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContact.kt
php
📄 lib/Resource/ItContact.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact.rb
rust
📄 src/models/it_contact.rs
ItContact.email added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContact.kt
php
📄 lib/Resource/ItContact.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact.rb
rust
📄 src/models/it_contact.rs
ItContact.id added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContact.kt
php
📄 lib/Resource/ItContact.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact.rb
rust
📄 src/models/it_contact.rs
ItContact.object added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContact.kt
php
📄 lib/Resource/ItContact.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact.rb
rust
📄 src/models/it_contact.rs
ItContact.updated_at added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContact.kt
php
📄 lib/Resource/ItContact.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact.rb
rust
📄 src/models/it_contact.rs
ItContactList added (type) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactList.kt
php
📄 lib/Resource/ItContactList.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact_list.rb
rust
📄 src/models/it_contact_list.rs
ItContactList.data added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactList.kt
php
📄 lib/Resource/ItContactList.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact_list.rb
rust
📄 src/models/it_contact_list.rs
ItContactList.list_metadata added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactList.kt
php
📄 lib/Resource/ItContactList.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact_list.rb
rust
📄 src/models/it_contact_list.rs
ItContactList.object added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactList.kt
php
📄 lib/Resource/ItContactList.php
ruby
📄 lib/workos/organizations_it_contacts/it_contact_list.rb
rust
📄 src/models/it_contact_list.rs
ItContactListListMetadata added (type) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactListListMetadata.kt
php
📄 lib/Resource/ItContactListListMetadata.php
rust
📄 src/models/it_contact_list_list_metadata.rs
ItContactListListMetadata.after added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactListListMetadata.kt
php
📄 lib/Resource/ItContactListListMetadata.php
rust
📄 src/models/it_contact_list_list_metadata.rs
ItContactListListMetadata.before added (field) go
📄 models.go
kotlin
📄 src/main/kotlin/com/workos/models/ItContactListListMetadata.kt
php
📄 lib/Resource/ItContactListListMetadata.php
rust
📄 src/models/it_contact_list_list_metadata.rs

OrganizationsItContacts

Change Languages
OrganizationsItContacts.createOrganizationItContact(organizationId, email, options?) added (function) php
📄 lib/Service/OrganizationsItContacts.php
ruby
📄 lib/workos/organizations_it_contacts.rb
OrganizationsItContacts.createSuspend(organizationId, email, requestOptions?) added (function) kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt
OrganizationsItContacts.deleteOrganizationItContact(organizationId, contactId, options?) added (function) php
📄 lib/Service/OrganizationsItContacts.php
ruby
📄 lib/workos/organizations_it_contacts.rb
OrganizationsItContacts.deleteSuspend(organizationId, contactId, requestOptions?) added (function) kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt
OrganizationsItContacts.listOrganizationItContacts(organizationId, options?) added (function) php
📄 lib/Service/OrganizationsItContacts.php
ruby
📄 lib/workos/organizations_it_contacts.rb
OrganizationsItContacts.listSuspend(organizationId, requestOptions?) added (function) kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt
OrganizationsItContactsApi added (type) rust
📄 src/resources/organizations_it_contacts.rs
OrganizationsItContactsApi.client added (field) rust
📄 src/resources/organizations_it_contacts.rs
OrganizationsItContactsCreateParams added (type) go
📄 organizations_it_contacts.go
OrganizationsItContactsCreateParams.email added (field) go
📄 organizations_it_contacts.go
kotlin
📄 src/main/kotlin/com/workos/models/CreateItContact.kt
php
📄 lib/Resource/CreateItContact.php
ruby
📄 lib/workos/organizations_it_contacts/create_it_contact.rb
rust
📄 src/models/create_it_contact.rs

OrganizationsItContactService

Change Languages
OrganizationsItContactService added (service) go
📄 organizations_it_contacts.go
OrganizationsItContactService.Create(organizationID, params, opts) added (function) go
📄 organizations_it_contacts.go
kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt
OrganizationsItContactService.Delete(organizationID, contactID, opts) added (function) go
📄 organizations_it_contacts.go
kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt
OrganizationsItContactService.List(organizationID, opts) added (function) go
📄 organizations_it_contacts.go
kotlin
📄 src/main/kotlin/com/workos/organizationsitcontacts/OrganizationsItContacts.kt

WaitlistUser

Change Languages
WaitlistUser.additional_fields added (field) go
📄 models.go
php
📄 lib/Resource/WaitlistUser.php
ruby
📄 lib/workos/shared/waitlist_user.rb
rust
📄 src/models/waitlist_user.rs

WorkOS

Change Languages
WorkOS.organizationsItContacts added (function) php
📄 lib/WorkOS.php
ruby
📄 lib/workos/client.rb

github-actions Bot added a commit that referenced this pull request Aug 17, 2026
Comment thread spec/open-api-spec.yaml
Comment on lines +11217 to +11228
/organizations/{organization_id}/it_contacts:
get:
description: Get the IT contacts for an organization.
operationId: ItContactsController_list
parameters:
- name: organization_id
required: true
in: path
description: The ID of the organization.
schema:
type: string
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Pagination cursors lack inputs

The response exposes before and after cursors for navigating the IT-contact list, but this operation accepts only organization_id. Generated clients therefore cannot submit a returned cursor to navigate to another page; add the supported pagination parameters or use a non-paginated response shape.

Knowledge Base Used: WorkOS API OpenAPI specification

Prompt To Fix With AI
This is a comment left during a code review.
Path: spec/open-api-spec.yaml
Line: 11217-11228

Comment:
**Pagination cursors lack inputs**

The response exposes `before` and `after` cursors for navigating the IT-contact list, but this operation accepts only `organization_id`. Generated clients therefore cannot submit a returned cursor to navigate to another page; add the supported pagination parameters or use a non-paginated response shape.

**Knowledge Base Used:** [WorkOS API OpenAPI specification](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/openapi-spec/-/docs/api-openapi-spec.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

0 participants