Skip to content

fix: align workspace id and slug response examples#142

Open
akhilmmenon wants to merge 1 commit into
masterfrom
hotfix-3853-workspace-uuid-fix
Open

fix: align workspace id and slug response examples#142
akhilmmenon wants to merge 1 commit into
masterfrom
hotfix-3853-workspace-uuid-fix

Conversation

@akhilmmenon
Copy link
Copy Markdown

Summary

  • update workspace response examples to clearly separate UUID id from workspace slug
  • add an explicit retrieve-workspace 200 example with distinct id and slug
  • keep changes limited to OpenAPI spec examples/documentation fields

Test plan

  • Verify Workspace and WorkspaceWithUsers examples use UUID for id
  • Verify create/retrieve workspace response examples no longer show same value for id and slug
  • Confirm diff scope is only openapi.yaml

Made with Cursor

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 200 response examples for create/retrieve workspace endpoints with distinct id (UUID) and slug.
  • Updated workspace list response examples to use UUIDs for id and added slug fields.
  • Clarified Workspace / WorkspaceWithUsers schema fields by adding id UUID format + descriptions for id and slug, 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-time timestamp format for created_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 thread openapi.yaml
Comment on lines 15169 to 15170
created_at: "2023-07-13 13:51:27"
last_updated_at: "2023-07-13 14:51:27"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants