Skip to content

[docs] Update API reference docs #6038

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Update API reference docs #6038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/docs/reference/api/archive-session.StatusCodes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer","title":"Count","default":0},"session":{"anyOf":[{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"created_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Id"},"updated_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updated By Id"},"deleted_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deleted By Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"session_id":{"type":"string","title":"Session Id"},"flags":{"default":{"is_alive":false,"is_running":false,"is_attached":false},"properties":{"is_alive":{"type":"boolean","title":"Is Alive","default":false},"is_running":{"type":"boolean","title":"Is Running","default":false},"is_attached":{"type":"boolean","title":"Is Attached","default":false}},"type":"object","title":"SessionStreamFlags","description":"The nest as primitive bools (alive ⊇ running ⊇ attached).\n\nresumable (alive & !running) and reattachable (running & !attached) are\nderived client-side, never stored."},"tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tags"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"turn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn Id"},"references":{"anyOf":[{"items":{"properties":{"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"}},"type":"object","title":"SessionReference","description":"A reference element that carries its own family.\n\nSessions persist references as a flat list (`session_turns.references`,\n`session_streams.references`), so the map key that named the family upstream is\ngone by the time a reader sees the row — leaving \"first UUID in the list\" as the\nonly way to guess which element is the workflow.\n\n``key`` is the name `evaluation_runs.references` already uses for the same flat-list\ndiscriminator (`dbs/postgres/evaluations/utils.py`), and the same one tracing carries\nin `OTelReference.attributes[\"key\"]`.\n\nIt is a plain string rather than ``ReferenceKey`` on purpose: a turn append is\nfire-and-forget, so rejecting an unrecognized family would drop the whole turn, which\nis the failure this field exists to prevent. Producers inside the API use\n``ReferenceKey``; readers treat anything else as untyped."},"type":"array"},{"type":"null"}],"title":"References"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"},"origin":{"anyOf":[{"type":"string","enum":["manual","trigger"],"title":"SessionOrigin"},{"type":"null"}]},"trigger":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"kind":{"type":"string","enum":["schedule","subscription"],"title":"SessionTriggerKind"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["id","kind"],"title":"SessionTrigger"},{"type":"null"}]},"delivery":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"SessionDelivery"},{"type":"null"}]}},"type":"object","required":["project_id","session_id"],"title":"SessionStream"},{"type":"null"}]}},"type":"object","title":"SessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer","title":"Count","default":0},"session":{"anyOf":[{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"created_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Id"},"updated_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updated By Id"},"deleted_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deleted By Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"session_id":{"type":"string","title":"Session Id"},"flags":{"default":{"is_alive":false,"is_running":false,"is_attached":false},"properties":{"is_alive":{"type":"boolean","title":"Is Alive","default":false},"is_running":{"type":"boolean","title":"Is Running","default":false},"is_attached":{"type":"boolean","title":"Is Attached","default":false}},"type":"object","title":"SessionStreamFlags","description":"The nest as primitive bools (alive ⊇ running ⊇ attached).\n\nresumable (alive & !running) and reattachable (running & !attached) are\nderived client-side, never stored."},"tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tags"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"turn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn Id"},"references":{"anyOf":[{"items":{"properties":{"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"}},"type":"object","title":"SessionReference","description":"A reference element that carries its own family.\n\nSessions persist references as a flat list (`session_turns.references`,\n`session_streams.references`), so the map key that named the family upstream is\ngone by the time a reader sees the row — leaving \"first UUID in the list\" as the\nonly way to guess which element is the workflow.\n\n``key`` is the name `evaluation_runs.references` already uses for the same flat-list\ndiscriminator (`dbs/postgres/evaluations/utils.py`), and the same one tracing carries\nin `OTelReference.attributes[\"key\"]`.\n\nIt is a plain string rather than ``ReferenceKey`` on purpose: a turn append is\nfire-and-forget, so rejecting an unrecognized family would drop the whole turn, which\nis the failure this field exists to prevent. Producers inside the API use\n``ReferenceKey``; readers treat anything else as untyped."},"type":"array"},{"type":"null"}],"title":"References"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"},"origin":{"anyOf":[{"type":"string","enum":["manual","trigger"],"title":"SessionOrigin"},{"type":"null"}]},"trigger":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"kind":{"type":"string","enum":["schedule","subscription"],"title":"SessionTriggerKind"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["id","kind"],"title":"SessionTrigger"},{"type":"null"}]},"delivery":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"SessionDelivery"},{"type":"null"}]}},"type":"object","required":["project_id","session_id"],"title":"SessionStream"},{"type":"null"}]}},"type":"object","title":"SessionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
2 changes: 1 addition & 1 deletion docs/docs/reference/api/fetch-session-stream.StatusCodes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"stream":{"anyOf":[{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"created_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Id"},"updated_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updated By Id"},"deleted_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deleted By Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"session_id":{"type":"string","title":"Session Id"},"flags":{"default":{"is_alive":false,"is_running":false,"is_attached":false},"properties":{"is_alive":{"type":"boolean","title":"Is Alive","default":false},"is_running":{"type":"boolean","title":"Is Running","default":false},"is_attached":{"type":"boolean","title":"Is Attached","default":false}},"type":"object","title":"SessionStreamFlags","description":"The nest as primitive bools (alive ⊇ running ⊇ attached).\n\nresumable (alive & !running) and reattachable (running & !attached) are\nderived client-side, never stored."},"tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tags"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"turn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn Id"},"references":{"anyOf":[{"items":{"properties":{"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"}},"type":"object","title":"SessionReference","description":"A reference element that carries its own family.\n\nSessions persist references as a flat list (`session_turns.references`,\n`session_streams.references`), so the map key that named the family upstream is\ngone by the time a reader sees the row — leaving \"first UUID in the list\" as the\nonly way to guess which element is the workflow.\n\n``key`` is the name `evaluation_runs.references` already uses for the same flat-list\ndiscriminator (`dbs/postgres/evaluations/utils.py`), and the same one tracing carries\nin `OTelReference.attributes[\"key\"]`.\n\nIt is a plain string rather than ``ReferenceKey`` on purpose: a turn append is\nfire-and-forget, so rejecting an unrecognized family would drop the whole turn, which\nis the failure this field exists to prevent. Producers inside the API use\n``ReferenceKey``; readers treat anything else as untyped."},"type":"array"},{"type":"null"}],"title":"References"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"},"origin":{"anyOf":[{"type":"string","enum":["manual","trigger"],"title":"SessionOrigin"},{"type":"null"}]},"trigger":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"kind":{"type":"string","enum":["schedule","subscription"],"title":"SessionTriggerKind"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["id","kind"],"title":"SessionTrigger"},{"type":"null"}]},"delivery":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"SessionDelivery"},{"type":"null"}]}},"type":"object","required":["project_id","session_id"],"title":"SessionStream"},{"type":"null"}]}},"type":"object","title":"SessionStreamResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
{"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"stream":{"anyOf":[{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"created_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By Id"},"updated_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Updated By Id"},"deleted_by_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deleted By Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"project_id":{"type":"string","format":"uuid","title":"Project Id"},"session_id":{"type":"string","title":"Session Id"},"flags":{"default":{"is_alive":false,"is_running":false,"is_attached":false},"properties":{"is_alive":{"type":"boolean","title":"Is Alive","default":false},"is_running":{"type":"boolean","title":"Is Running","default":false},"is_attached":{"type":"boolean","title":"Is Attached","default":false}},"type":"object","title":"SessionStreamFlags","description":"The nest as primitive bools (alive ⊇ running ⊇ attached).\n\nresumable (alive & !running) and reattachable (running & !attached) are\nderived client-side, never stored."},"tags":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tags"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"turn_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn Id"},"references":{"anyOf":[{"items":{"properties":{"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"}},"type":"object","title":"SessionReference","description":"A reference element that carries its own family.\n\nSessions persist references as a flat list (`session_turns.references`,\n`session_streams.references`), so the map key that named the family upstream is\ngone by the time a reader sees the row — leaving \"first UUID in the list\" as the\nonly way to guess which element is the workflow.\n\n``key`` is the name `evaluation_runs.references` already uses for the same flat-list\ndiscriminator (`dbs/postgres/evaluations/utils.py`), and the same one tracing carries\nin `OTelReference.attributes[\"key\"]`.\n\nIt is a plain string rather than ``ReferenceKey`` on purpose: a turn append is\nfire-and-forget, so rejecting an unrecognized family would drop the whole turn, which\nis the failure this field exists to prevent. Producers inside the API use\n``ReferenceKey``; readers treat anything else as untyped."},"type":"array"},{"type":"null"}],"title":"References"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"},"origin":{"anyOf":[{"type":"string","enum":["manual","trigger"],"title":"SessionOrigin"},{"type":"null"}]},"trigger":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"kind":{"type":"string","enum":["schedule","subscription"],"title":"SessionTriggerKind"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["id","kind"],"title":"SessionTrigger"},{"type":"null"}]},"delivery":{"anyOf":[{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"SessionDelivery"},{"type":"null"}]}},"type":"object","required":["project_id","session_id"],"title":"SessionStream"},{"type":"null"}]}},"type":"object","title":"SessionStreamResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
Loading