Update OpenAPI spec (bd85a8e) - #166
Open
workos-sdk-automation[bot] wants to merge 1 commit into
Open
Conversation
|
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''.' |
There was a problem hiding this comment.
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!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 I see new OpenAPI changes beep boop
Automated update from https://github.com/workos/workos/tree/bd85a8e873330aaeb6930369a72f35f5e5783613
Source PRs
Changes