fix: align workspace id and slug response examples#142
Open
akhilmmenon wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Workspaces OpenAPI documentation/examples to clearly distinguish a workspace’s UUID id from its human-readable slug, and adds explicit response examples that reflect this separation.
Changes:
- Added explicit
200response examples for create/retrieve workspace endpoints with distinctid(UUID) andslug. - Updated workspace list response examples to use UUIDs for
idand addedslugfields. - Clarified
Workspace/WorkspaceWithUsersschema fields by addingidUUID format + descriptions foridandslug, and added path parameter descriptions noting slug backward-compatibility.
Comments suppressed due to low confidence (1)
openapi.yaml:15177
- Same as above: this example uses a non-
date-timetimestamp format forcreated_at/last_updated_at, which conflicts with the schema (format: date-time). Update to RFC3339/ISO-8601 timestamps for consistency.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
15169
to
15170
| created_at: "2023-07-13 13:51:27" | ||
| last_updated_at: "2023-07-13 14:51:27" |
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.
Summary
idfrom workspaceslugidandslugTest plan
WorkspaceandWorkspaceWithUsersexamples use UUID forididandslugopenapi.yamlMade with Cursor