Skip to content

docs: align sessions OpenAPI with api PatchSessionBody and Session shape #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sweetmantech merged 6 commits into from
Jun 5, 2026
Merged

docs: align sessions OpenAPI with api PatchSessionBody and Session shape #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e45f354
docs: align sessions OpenAPI with api PatchSessionBody and Session shape
ahmednahima0-beep Jun 1, 2026
b6b112a
fix(docs): Session.artistId OAS 3.1 null type for required field
ahmednahima0-beep Jun 1, 2026
b296b47
fix(docs): patch.mdx openapi frontmatter uses METHOD /path format
ahmednahima0-beep Jun 1, 2026
02dc73b
docs(sessions): trim PatchSessionBody description (KISS, match Create…
sweetmantech Jun 5, 2026
05cd6a1
fix(docs): update openapi frontmatter format in patch.mdx to include …
ahmednahima0-beep Jun 6, 2026
e358198
docs(sessions): hyperlink referenced endpoints + trim PATCH descripti…
sweetmantech Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions api-reference/openapi/sessions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchSessionRequest"
"$ref": "#/components/schemas/PatchSessionBody"
}
}
}
Expand Down Expand Up @@ -746,9 +746,9 @@
}
}
},
"PatchSessionRequest": {
"PatchSessionBody": {
"type": "object",
"description": "All fields are optional. Omitted fields are left unchanged.",
"description": "All fields are optional; an empty object `{}` is valid and leaves the session unchanged.",
"properties": {
"title": {
"type": "string",
Expand Down Expand Up @@ -1084,9 +1084,11 @@
},
"Session": {
"type": "object",
"description": "Agent session returned by [POST /api/sessions](/api-reference/sessions/create), [GET /api/sessions/{sessionId}](/api-reference/sessions/get), and [PATCH /api/sessions/{sessionId}](/api-reference/sessions/patch). The api serializes every field listed in `required` on each response, including `isNewBranch` (boolean, from the non-null `sessions.is_new_branch` column) and `artistId` (UUID or null).",
"required": [
"id",
"userId",
"artistId",
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
"title",
"status",
"isNewBranch",
Expand Down Expand Up @@ -1137,7 +1139,7 @@
},
"isNewBranch": {
"type": "boolean",
"description": "True when this session created and pushed a new branch (not committing back to the original)."
"description": "Always present on session responses. True when this session created and pushed a new branch (not committing back to the original); false otherwise."
},
"globalSkillRefs": {
"type": "array",
Expand Down Expand Up @@ -1236,9 +1238,8 @@
"format": "date-time"
},
"artistId": {
"type": "string",
"type": ["string", "null"],
"format": "uuid",
"nullable": true,
"description": "Artist account id this session was created in the context of, or `null` when no artist was associated. Set via `POST /api/sessions { artistId }`; surfaces here for clients (e.g. the chat sidebar) that filter sessions/chats by artist."
}
}
Expand Down
1 change: 1 addition & 0 deletions api-reference/sessions/patch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "Update Session"
description: "Rename a session, change lifecycle status, or update line counters."
openapi: "/api-reference/openapi/sessions.json PATCH /api/sessions/{sessionId}"
---