Skip to content

Update OpenAPI spec (bd85a8e) - #166

Open
workos-sdk-automation[bot] wants to merge 1 commit into
mainfrom
update-spec-20260911-205808-34646885048
Open

Update OpenAPI spec (bd85a8e)#166
workos-sdk-automation[bot] wants to merge 1 commit into
mainfrom
update-spec-20260911-205808-34646885048

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/bd85a8e873330aaeb6930369a72f35f5e5783613

Source PRs

  • workos/workos#71978
  • workos/workos#72198
  • workos/workos#72373
Changes



├─┬Paths
│ ├──[➕] authkit_oauth_resources (17440:3)
│ ├──[➕] {id} (17617:3)
│ ├──[➕] organization (11192:3)
│ ├─┬/data-integrations
│ │ └─┬GET
│ │   ├──[🔀] description (10352:20)
│ │   ├─┬Parameters
│ │   │ └──[➕] ownership (10406:17)
│ │   └─┬Responses
│ │     ├──[➕] 404 (10429:11)
│ │     └──[➕] 422 (10444:11)
│ └─┬/data-integrations/{slug}
│   ├─┬GET
│   │ └──[🔀] description (10462:20)
│   ├─┬PUT
│   │ └──[🔀] description (10499:20)
│   └─┬DELETE
│     └──[🔀] description (10599:20)
├─┬Tags
│ └──[➕] user-management.authkit-oauth-resources (24906:5)
└─┬Components
  ├──[➕] schemas/CreateAuthkitOauthResourceDto (27391:7)
  ├──[➕] schemas/AuthkitOauthResource (44412:7)
  └─┬Schemas
    ├─┬CreateDataIntegrationDto
    │ └─┬Properties
    │   └─┬ownership
    │     ├──[🔀] example (27087:20)
    │     ├──[➕] enum (27079:15)
    │     ├──[➖] enum (26547:15)❌ 
    │     └──[🔀] description (27081:24)
    └─┬DataIntegration
      └─┬Properties
        └─┬ownership
          ├──[🔀] example (43095:20)
          ├──[➕] enum (43089:15)
          ├──[➖] enum (42537:15)❌ 
          └──[🔀] description (43091:24)


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

Date: 09/11/26 | Commit: Update OpenAPI spec from workos/workos@bd85a8e873330aaeb6930369a72f35f5e5783613

- ❌ **BREAKING Changes**: _2_ out of _21_
- **Modifications**: _8_
- **Removals**: _2_
- **Additions**: _11_
- **Breaking Removals**: _2_

ERROR: breaking changes discovered

@greptile-apps

greptile-apps Bot commented Sep 11, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 4/5

The PR appears safe to merge after a non-blocking correction to the organization update endpoint’s conflict documentation.

Findings

  1. P2 Misleading conflict response
Fix with agent prompt
### Issue 1
spec/open-api-spec.yaml:11381-11391
The new `409` response has an empty description, and its only example says “Organization not found,” which describes a missing resource rather than a conflict. Consumers therefore cannot tell what state triggers this response. The new 400, 403, and 422 responses also reuse this organization-not-found example instead of showing status-appropriate errors.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

---

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

Summary

  • Adds organization-specific data-integration GET, PUT, and DELETE operations.
  • Adds AuthKit OAuth resource create, list, and delete operations with supporting schemas and tags.
  • Changes documented data-integration ownership from userland_user to user.
  • Updates the recorded upstream synchronization SHA.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Client --> DI["Data Integrations API"]
  DI --> UserRoot["User-owned root"]
  DI --> OrgRoot["Organization-owned root"]
  Client --> AuthKit["AuthKit OAuth Resources API"]
  AuthKit --> Create["Create resource indicator"]
  AuthKit --> List["List resource indicators"]
  AuthKit --> Delete["Delete resource indicator"]
Loading

Reviews (1) · Last reviewed commit: "Update OpenAPI spec from workos/workos@b..."

Comment thread spec/open-api-spec.yaml
Comment on lines +11381 to +11391
'409':
description: ''
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: A human-readable description of the error.
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'

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 Misleading conflict response

The new 409 response has an empty description, and its only example says “Organization not found,” which describes a missing resource rather than a conflict. Consumers therefore cannot tell what state triggers this response. The new 400, 403, and 422 responses also reuse this organization-not-found example instead of showing status-appropriate errors.

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

Comment:
**Misleading conflict response**

The new `409` response has an empty description, and its only example says “Organization not found,” which describes a missing resource rather than a conflict. Consumers therefore cannot tell what state triggers this response. The new 400, 403, and 422 responses also reuse this organization-not-found example instead of showing status-appropriate errors.

---

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

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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