{ "openapi": "3.1.0", "info": { "title": "fxquinox", "version": "0.0.1" }, "paths": { "/schema": { "get": { "tags": [ "schema" ], "summary": "Get Schema", "operationId": "get_schema_schema_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Schema Schema Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/usage": { "get": { "tags": [ "schema" ], "summary": "Schema Usage", "operationId": "schema_usage_schema_usage_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Schema Usage Schema Usage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/entity-types": { "post": { "tags": [ "schema" ], "summary": "Create Entity Type", "operationId": "create_entity_type_schema_entity_types_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityTypeBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Entity Type Schema Entity Types Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/entity-types/{entity_code}/fields": { "post": { "tags": [ "schema" ], "summary": "Add Field", "operationId": "add_field_schema_entity_types__entity_code__fields_post", "parameters": [ { "name": "entity_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Field Schema Entity Types Entity Code Fields Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/statuses": { "post": { "tags": [ "schema" ], "summary": "Create Status", "operationId": "create_status_schema_statuses_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fxq__api__routers__schema__StatusBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Status Schema Statuses Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/statuses/{code}": { "patch": { "tags": [ "schema" ], "summary": "Update Status", "operationId": "update_status_schema_statuses__code__patch", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Status Schema Statuses Code Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "schema" ], "summary": "Delete Status", "operationId": "delete_status_schema_statuses__code__delete", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "entity_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Status Schema Statuses Code Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/steps": { "post": { "tags": [ "schema" ], "summary": "Create Step", "operationId": "create_step_schema_steps_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Step Schema Steps Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/steps/reorder": { "post": { "tags": [ "schema" ], "summary": "Reorder Steps", "operationId": "reorder_steps_schema_steps_reorder_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepReorder" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reorder Steps Schema Steps Reorder Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/steps/{code}": { "patch": { "tags": [ "schema" ], "summary": "Update Step", "operationId": "update_step_schema_steps__code__patch", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Step Schema Steps Code Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "schema" ], "summary": "Delete Step", "operationId": "delete_step_schema_steps__code__delete", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Step Schema Steps Code Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/steps/{code}/rename": { "post": { "tags": [ "schema" ], "summary": "Rename Step Code", "description": "Change a step's code, cascading to tasks + workflow schemas.", "operationId": "rename_step_code_schema_steps__code__rename_post", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rename Step Code Schema Steps Code Rename Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/workflows": { "post": { "tags": [ "schema" ], "summary": "Create Workflow", "operationId": "create_workflow_schema_workflows_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Workflow Schema Workflows Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/entity-types/{entity_code}": { "patch": { "tags": [ "schema" ], "summary": "Rename Entity Type", "operationId": "rename_entity_type_schema_entity_types__entity_code__patch", "parameters": [ { "name": "entity_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rename Entity Type Schema Entity Types Entity Code Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "schema" ], "summary": "Delete Entity Type", "operationId": "delete_entity_type_schema_entity_types__entity_code__delete", "parameters": [ { "name": "entity_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Entity Type Schema Entity Types Entity Code Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/entity-types/{entity_code}/fields/{field_code}": { "patch": { "tags": [ "schema" ], "summary": "Update Field", "operationId": "update_field_schema_entity_types__entity_code__fields__field_code__patch", "parameters": [ { "name": "entity_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Code" } }, { "name": "field_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Field Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Field Schema Entity Types Entity Code Fields Field Code Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "schema" ], "summary": "Delete Field", "operationId": "delete_field_schema_entity_types__entity_code__fields__field_code__delete", "parameters": [ { "name": "entity_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Code" } }, { "name": "field_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Field Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Field Schema Entity Types Entity Code Fields Field Code Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/entity-types/{entity_code}/fields/{field_code}/rename-option": { "post": { "tags": [ "schema" ], "summary": "Rename Field Option", "description": "Change an enum option's code, cascading to records + workflow schemas.", "operationId": "rename_field_option_schema_entity_types__entity_code__fields__field_code__rename_option_post", "parameters": [ { "name": "entity_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Code" } }, { "name": "field_code", "in": "path", "required": true, "schema": { "type": "string", "title": "Field Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionRename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rename Field Option Schema Entity Types Entity Code Fields Field Code Rename Option Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/statuses/{code}/rename": { "post": { "tags": [ "schema" ], "summary": "Rename Status Code", "description": "Change a status code, cascading to records, transitions and presets.", "operationId": "rename_status_code_schema_statuses__code__rename_post", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rename Status Code Schema Statuses Code Rename Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/priorities/{code}/rename": { "post": { "tags": [ "schema" ], "summary": "Rename Priority Code", "description": "Change a priority code, cascading to every record that stores it.", "operationId": "rename_priority_code_schema_priorities__code__rename_post", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rename Priority Code Schema Priorities Code Rename Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/entity-types/{code}/rename-code": { "post": { "tags": [ "schema" ], "summary": "Rename Entity Type Code", "description": "Change a custom object's code, cascading to records, links and presets.", "operationId": "rename_entity_type_code_schema_entity_types__code__rename_code_post", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rename Entity Type Code Schema Entity Types Code Rename Code Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/workflows/delete": { "post": { "tags": [ "schema" ], "summary": "Delete Workflow", "operationId": "delete_workflow_schema_workflows_delete_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Workflow Schema Workflows Delete Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/transitions": { "post": { "tags": [ "schema" ], "summary": "Set Object Transitions", "description": "Set the studio-default transitions (global flow) for an object type.", "operationId": "set_object_transitions_schema_transitions_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectTransitionsBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Object Transitions Schema Transitions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/task-templates": { "put": { "tags": [ "schema" ], "summary": "Set Task Templates", "description": "Replace the studio-wide task templates.", "operationId": "set_task_templates_schema_task_templates_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTemplatesBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Task Templates Schema Task Templates Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/priorities": { "post": { "tags": [ "schema" ], "summary": "Create Priority", "operationId": "create_priority_schema_priorities_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Priority Schema Priorities Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/priorities/{code}": { "patch": { "tags": [ "schema" ], "summary": "Update Priority", "operationId": "update_priority_schema_priorities__code__patch", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Priority Schema Priorities Code Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "schema" ], "summary": "Delete Priority", "operationId": "delete_priority_schema_priorities__code__delete", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "title": "Code" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Priority Schema Priorities Code Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/branding": { "get": { "tags": [ "schema" ], "summary": "Get Branding", "operationId": "get_branding_branding_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Branding Branding Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "schema" ], "summary": "Set Branding", "operationId": "set_branding_branding_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Branding Branding Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/applications": { "get": { "tags": [ "schema" ], "summary": "Get Applications", "description": "The software-launcher catalog the desktop discovers DCCs with. Pass\n``project_id`` to get the catalog filtered to that project's available\napplications (its override; inherits the full studio catalog when unset).\nPass ``step`` too to apply the project's per-step app list for that step\n(``overrides.applicationsByStep``), which wins over the project-wide list.", "operationId": "get_applications_schema_applications_get", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "step", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Step" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Applications Schema Applications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "schema" ], "summary": "Set Applications", "description": "Replace the studio launcher catalog (Admin only).", "operationId": "set_applications_schema_applications_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationsBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Applications Schema Applications Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/tools": { "get": { "tags": [ "schema" ], "summary": "Get Tools", "description": "The studio tools catalog (renderers / plugins that contribute env + args\nto a DCC launch). Falls back to the built-in defaults when unset.", "operationId": "get_tools_schema_tools_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Tools Schema Tools Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "schema" ], "summary": "Set Tools", "description": "Replace the studio tools catalog (Admin only).", "operationId": "set_tools_schema_tools_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolsBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Tools Schema Tools Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/schema/tools/active": { "get": { "tags": [ "schema" ], "summary": "Active Tools", "description": "The flattened tool variants a project has attached\n(``data.overrides.tools``), for the desktop to merge into a launch. Each\nitem is ``{tool, label, icon, version, args, environment}``. Pass ``step``\nto narrow to that step's per-step list (``overrides.toolsByStep``): an\nexplicit (even empty) list filters the attached selectors; an absent key\nkeeps them all.", "operationId": "active_tools_schema_tools_active_get", "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "step", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Step" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Active Tools Schema Tools Active Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/entities/{entity_type}/{record_id}/notes": { "get": { "tags": [ "entities" ], "summary": "List Record Notes", "description": "Notes attached to one record (scoped server-side), oldest\u2192newest.", "operationId": "list_record_notes_entities__entity_type___record_id__notes_get", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Record Notes Entities Entity Type Record Id Notes Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/{note_id}/transfer": { "post": { "tags": [ "entities" ], "summary": "Transfer Note", "description": "Copy a Version's review note onto its parent shot/asset (VAL-34).", "operationId": "transfer_note_notes__note_id__transfer_post", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Transfer Note Notes Note Id Transfer Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notes/{note_id}/react": { "post": { "tags": [ "entities" ], "summary": "Toggle Reaction", "description": "Atomically toggle the caller's reaction on a note; returns the note.", "operationId": "toggle_reaction_notes__note_id__react_post", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReactBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Toggle Reaction Notes Note Id React Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/entities/{entity_type}": { "post": { "tags": [ "entities" ], "summary": "Create Entity", "operationId": "create_entity_entities__entity_type__post", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Entity Entities Entity Type Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/entities/{entity_type}/{record_id}": { "get": { "tags": [ "entities" ], "summary": "Get Entity", "operationId": "get_entity_entities__entity_type___record_id__get", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Entity Entities Entity Type Record Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "entities" ], "summary": "Update Entity", "operationId": "update_entity_entities__entity_type___record_id__patch", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Entity Entities Entity Type Record Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "entities" ], "summary": "Delete Entity", "operationId": "delete_entity_entities__entity_type___record_id__delete", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Entity Entities Entity Type Record Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/entities/{entity_type}/query": { "post": { "tags": [ "entities" ], "summary": "Query Entities", "operationId": "query_entities_entities__entity_type__query_post", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Query Entities Entities Entity Type Query Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/entities/{entity_type}/{record_id}/allowed-transitions": { "get": { "tags": [ "entities" ], "summary": "Get Allowed", "operationId": "get_allowed_entities__entity_type___record_id__allowed_transitions_get", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Allowed Entities Entity Type Record Id Allowed Transitions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/imports/entities": { "post": { "tags": [ "imports" ], "summary": "Import Entities", "description": "Create records for ``entity_type`` from the wizard's mapped rows.", "operationId": "import_entities_imports_entities_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Import Entities Imports Entities Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/publish": { "post": { "tags": [ "publish" ], "summary": "Do Publish", "operationId": "do_publish_publish_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Do Publish Publish Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/paths/resolve": { "post": { "tags": [ "publish" ], "summary": "Resolve Path", "operationId": "resolve_path_paths_resolve_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resolve Path Paths Resolve Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/anatomy/studio": { "get": { "tags": [ "publish" ], "summary": "Get Studio Anatomy", "description": "The studio-level anatomy defaults every project inherits.", "operationId": "get_studio_anatomy_anatomy_studio_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Studio Anatomy Anatomy Studio Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "publish" ], "summary": "Put Studio Anatomy", "description": "Set the studio-level anatomy defaults. Admin only.", "operationId": "put_studio_anatomy_anatomy_studio_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnatomyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Put Studio Anatomy Anatomy Studio Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sites/roots": { "get": { "tags": [ "publish" ], "summary": "Get Site Roots", "description": "The primary site's per-platform storage roots (the source of {root}).", "operationId": "get_site_roots_sites_roots_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Site Roots Sites Roots Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "publish" ], "summary": "Put Site Roots", "description": "Set the primary site's roots. Admin only.", "operationId": "put_site_roots_sites_roots_put", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteRootsBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Put Site Roots Sites Roots Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projects/{project_id}/anatomy": { "get": { "tags": [ "publish" ], "summary": "Get Project Anatomy", "description": "The project's effective anatomy (its overrides merged over defaults).", "operationId": "get_project_anatomy_projects__project_id__anatomy_get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Project Anatomy Projects Project Id Anatomy Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "publish" ], "summary": "Put Project Anatomy", "description": "Set a project's anatomy (templates + roots). Admin only.", "operationId": "put_project_anatomy_projects__project_id__anatomy_put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnatomyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Put Project Anatomy Projects Project Id Anatomy Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/anatomy/resolve": { "post": { "tags": [ "publish" ], "summary": "Resolve Anatomy", "description": "Resolve a named anatomy template for an entity into a path.", "operationId": "resolve_anatomy_anatomy_resolve_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnatomyResolveBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Resolve Anatomy Anatomy Resolve Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/anatomy/tokens": { "get": { "tags": [ "publish" ], "summary": "Anatomy Tokens", "description": "The tokens path templates can use, derived from the schema (so the editor\nsuggests exactly what resolves). Each is ``{token, hint, sample}``.", "operationId": "anatomy_tokens_anatomy_tokens_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Anatomy Tokens Anatomy Tokens Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/versions/{version_id}/lineage": { "get": { "tags": [ "publish" ], "summary": "Version Lineage", "operationId": "version_lineage_versions__version_id__lineage_get", "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Version Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Version Lineage Versions Version Id Lineage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/loader/browse": { "post": { "tags": [ "publish" ], "summary": "Loader Browse", "description": "List loadable published products for a context (universal loader).", "operationId": "loader_browse_loader_browse_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoaderBrowseBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Loader Browse Loader Browse Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scene/inventory": { "post": { "tags": [ "publish" ], "summary": "Scene Inventory", "description": "Resolve a DCC scene's loaded versions: flag outdated + update targets.", "operationId": "scene_inventory_scene_inventory_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Scene Inventory Scene Inventory Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/versions/{version_id}/dependencies": { "get": { "tags": [ "publish" ], "summary": "Version Dependencies", "description": "The enriched upstream dependency tree for a version (VAL-51).", "operationId": "version_dependencies_versions__version_id__dependencies_get", "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Version Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Version Dependencies Versions Version Id Dependencies Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/register": { "post": { "tags": [ "auth" ], "summary": "Register", "operationId": "register_auth_register_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/login": { "post": { "tags": [ "auth" ], "summary": "Login", "operationId": "login_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me": { "get": { "tags": [ "auth" ], "summary": "Me", "operationId": "me_me_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/api-keys": { "post": { "tags": [ "auth" ], "summary": "Make Api Key", "operationId": "make_api_key_auth_api_keys_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/notifications": { "get": { "tags": [ "auth" ], "summary": "My Notifications", "operationId": "my_notifications_me_notifications_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/notifications/seen": { "post": { "tags": [ "auth" ], "summary": "Mark Notifications Seen", "operationId": "mark_notifications_seen_me_notifications_seen_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/notifications/{nid}/seen": { "post": { "tags": [ "auth" ], "summary": "Mark Notification Seen", "description": "Mark a single notification read \u2014 e.g. when its entity is opened.", "operationId": "mark_notification_seen_me_notifications__nid__seen_post", "parameters": [ { "name": "nid", "in": "path", "required": true, "schema": { "type": "string", "title": "Nid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/notifications/{nid}/dismiss": { "post": { "tags": [ "auth" ], "summary": "Dismiss Notification", "description": "Remove a single notification from the current user's inbox.", "operationId": "dismiss_notification_me_notifications__nid__dismiss_post", "parameters": [ { "name": "nid", "in": "path", "required": true, "schema": { "type": "string", "title": "Nid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/notifications/clear": { "post": { "tags": [ "auth" ], "summary": "Clear Notifications", "description": "Empty the current user's inbox.", "operationId": "clear_notifications_me_notifications_clear_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/entities/{entity_type}/{record_id}/watch": { "post": { "tags": [ "auth" ], "summary": "Toggle Watch", "operationId": "toggle_watch_entities__entity_type___record_id__watch_post", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "auth" ], "summary": "Get Watch", "operationId": "get_watch_entities__entity_type___record_id__watch_get", "parameters": [ { "name": "entity_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Type" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/tasks": { "get": { "tags": [ "auth" ], "summary": "My Tasks", "operationId": "my_tasks_me_tasks_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/me/timelogs": { "get": { "tags": [ "auth" ], "summary": "My Timelogs", "description": "The current user's logged time \u2014 backs the personal timesheet.", "operationId": "my_timelogs_me_timelogs_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/{uid}/tasks": { "get": { "tags": [ "auth" ], "summary": "User Tasks", "operationId": "user_tasks_users__uid__tasks_get", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/{uid}/timelogs": { "get": { "tags": [ "auth" ], "summary": "User Timelogs", "operationId": "user_timelogs_users__uid__timelogs_get", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/events": { "get": { "tags": [ "events" ], "summary": "Recent Events", "operationId": "recent_events_events_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Recent Events Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/media/upload": { "post": { "tags": [ "media" ], "summary": "Upload Attachment", "description": "Store an arbitrary attachment (note images, etc.) and return its key.", "operationId": "upload_attachment_media_upload_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_attachment_media_upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Attachment Media Upload Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/media/thumbnail": { "post": { "tags": [ "media" ], "summary": "Upload Thumbnail", "description": "Store a *downscaled* image as an object thumbnail, so we never keep a\nuser's full-resolution upload just to show a tiny thumbnail.", "operationId": "upload_thumbnail_media_thumbnail_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_thumbnail_media_thumbnail_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Thumbnail Media Thumbnail Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/versions/{version_id}/reviewable": { "post": { "tags": [ "media" ], "summary": "Upload Reviewable", "description": "Accept a reviewable and return immediately with a pending Representation.\n\nThe thumbnail/proxy transcode is scheduled as a background task; poll\n``GET /versions/{id}/reviewable`` for the status.", "operationId": "upload_reviewable_versions__version_id__reviewable_post", "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Version Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_reviewable_versions__version_id__reviewable_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "media" ], "summary": "Get Reviewable Status", "description": "Poll the transcode job status for a version's reviewable.", "operationId": "get_reviewable_status_versions__version_id__reviewable_get", "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Version Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Reviewable Status Versions Version Id Reviewable Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/playlists/{playlist_id}/report": { "get": { "tags": [ "media" ], "summary": "Playlist Report", "description": "Generate a downloadable PDF review report for a playlist (VAL-33).", "operationId": "playlist_report_playlists__playlist_id__report_get", "parameters": [ { "name": "playlist_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playlist Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/media/{key}": { "get": { "tags": [ "media" ], "summary": "Get Media", "operationId": "get_media_media__key__get", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/playlists/{playlist_id}/share": { "post": { "tags": [ "share" ], "summary": "Create Share", "description": "Generate (or rotate) a public share token for a playlist.", "operationId": "create_share_playlists__playlist_id__share_post", "parameters": [ { "name": "playlist_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playlist Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Share Playlists Playlist Id Share Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "share" ], "summary": "Revoke Share", "description": "Revoke a playlist's share token (existing links stop working).", "operationId": "revoke_share_playlists__playlist_id__share_delete", "parameters": [ { "name": "playlist_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playlist Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revoke Share Playlists Playlist Id Share Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/shared/{token}/notes": { "post": { "tags": [ "share" ], "summary": "Shared Add Note", "description": "Capture a guest's comment (+ optional approval) back as a Note.\n\nThe token scopes writes to the shared playlist's versions only \u2014 a guest\ncan never post to anything else in the system.", "operationId": "shared_add_note_shared__token__notes_post", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuestNote" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Shared Add Note Shared Token Notes Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/shared/{token}": { "get": { "tags": [ "share" ], "summary": "Shared Review", "description": "Public, read-only review payload for a shared playlist (no auth).", "operationId": "shared_review_shared__token__get", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Shared Review Shared Token Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/actions": { "get": { "tags": [ "actions" ], "summary": "List Actions", "description": "List actions applicable to an entity type (or all).", "operationId": "list_actions_actions_get", "parameters": [ { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Type" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Actions Actions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/actions/{action_id}/run": { "post": { "tags": [ "actions" ], "summary": "Run Action", "description": "Run a registered action over the selected records.", "operationId": "run_action_actions__action_id__run_post", "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Action Actions Action Id Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/addons": { "get": { "tags": [ "addons" ], "summary": "List Addons", "description": "List installed addons and what each contributes.", "operationId": "list_addons_addons_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Addons Addons Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/addons/refresh": { "post": { "tags": [ "addons" ], "summary": "Refresh Addons", "description": "Rescan the addons directory, registering any new/updated manifests.", "operationId": "refresh_addons_addons_refresh_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Refresh Addons Addons Refresh Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/addons/{name}/enable": { "post": { "tags": [ "addons" ], "summary": "Enable Addon", "description": "Enable an addon \u2014 applies its schema and loads its entry module.", "operationId": "enable_addon_addons__name__enable_post", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Enable Addon Addons Name Enable Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/addons/{name}/disable": { "post": { "tags": [ "addons" ], "summary": "Disable Addon", "description": "Disable an addon (full unload of code hooks needs a restart).", "operationId": "disable_addon_addons__name__disable_post", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Disable Addon Addons Name Disable Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scheduler/jobs": { "get": { "tags": [ "scheduler" ], "summary": "List Jobs", "description": "List registered scheduled jobs with their cadence and last run.", "operationId": "list_jobs_scheduler_jobs_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Jobs Scheduler Jobs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scheduler/jobs/{name}/run": { "post": { "tags": [ "scheduler" ], "summary": "Run Job", "description": "Run a scheduled job immediately.", "operationId": "run_job_scheduler_jobs__name__run_post", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Job Scheduler Jobs Name Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/farm/jobs": { "post": { "tags": [ "farm" ], "summary": "Submit Job", "description": "Submit a render-farm job and track it.", "operationId": "submit_job_farm_jobs_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Submit Job Farm Jobs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "farm" ], "summary": "List Jobs", "description": "List tracked farm jobs.", "operationId": "list_jobs_farm_jobs_get", "parameters": [ { "name": "task_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Id" } }, { "name": "version_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Jobs Farm Jobs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/farm/jobs/{job_id}/status": { "post": { "tags": [ "farm" ], "summary": "Set Status", "description": "Update a farm job's status/progress (a farm callback).", "operationId": "set_status_farm_jobs__job_id__status_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fxq__api__routers__farm__StatusBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Status Farm Jobs Job Id Status Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sync/jobs": { "post": { "tags": [ "sitesync" ], "summary": "Request Sync", "description": "Queue a transfer of a representation's files to a target site.", "operationId": "request_sync_sync_jobs_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Request Sync Sync Jobs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "sitesync" ], "summary": "List Sync Jobs", "description": "List transfer jobs.", "operationId": "list_sync_jobs_sync_jobs_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Sync Jobs Sync Jobs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sync/jobs/{job_id}/process": { "post": { "tags": [ "sitesync" ], "summary": "Process One", "description": "Run one transfer attempt for a job.", "operationId": "process_one_sync_jobs__job_id__process_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Process One Sync Jobs Job Id Process Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sync/process": { "post": { "tags": [ "sitesync" ], "summary": "Process All", "description": "Process every queued transfer job once.", "operationId": "process_all_sync_process_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Process All Sync Process Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/healthz": { "get": { "summary": "Healthz", "operationId": "healthz_healthz_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Healthz Healthz Get" } } } } } } } }, "components": { "schemas": { "AnatomyBody": { "properties": { "templates": { "additionalProperties": true, "type": "object", "title": "Templates", "default": {} }, "roots": { "additionalProperties": true, "type": "object", "title": "Roots", "default": {} } }, "type": "object", "title": "AnatomyBody" }, "AnatomyResolveBody": { "properties": { "template_key": { "type": "string", "title": "Template Key" }, "entity_type": { "type": "string", "title": "Entity Type" }, "entity_id": { "type": "string", "title": "Entity Id" }, "extra": { "additionalProperties": true, "type": "object", "title": "Extra", "default": {} }, "site_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Id" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" }, "root_name": { "type": "string", "title": "Root Name", "default": "work" } }, "type": "object", "required": [ "template_key", "entity_type", "entity_id" ], "title": "AnatomyResolveBody" }, "ApiKeyBody": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "ApiKeyBody" }, "ApplicationsBody": { "properties": { "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ApplicationsBody" }, "Body_upload_attachment_media_upload_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_attachment_media_upload_post" }, "Body_upload_reviewable_versions__version_id__reviewable_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_reviewable_versions__version_id__reviewable_post" }, "Body_upload_thumbnail_media_thumbnail_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_thumbnail_media_thumbnail_post" }, "BrandingBody": { "properties": { "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Name" }, "logo_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logo Key" }, "accent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accent" }, "favicon_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Favicon Key" }, "show_company_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Company Name" } }, "type": "object", "title": "BrandingBody" }, "CodeRename": { "properties": { "new_code": { "type": "string", "title": "New Code" } }, "type": "object", "required": [ "new_code" ], "title": "CodeRename" }, "CreateBody": { "properties": { "data": { "additionalProperties": true, "type": "object", "title": "Data" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, "type": "object", "required": [ "data" ], "title": "CreateBody" }, "EntityTypeBody": { "properties": { "code": { "type": "string", "title": "Code" }, "display_name": { "type": "string", "title": "Display Name" }, "hierarchy_mode": { "type": "string", "title": "Hierarchy Mode", "default": "none" }, "parent_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Field" } }, "type": "object", "required": [ "code", "display_name" ], "title": "EntityTypeBody" }, "FieldBody": { "properties": { "code": { "type": "string", "title": "Code" }, "display_name": { "type": "string", "title": "Display Name" }, "data_type": { "type": "string", "title": "Data Type" }, "config": { "additionalProperties": true, "type": "object", "title": "Config", "default": {} }, "is_required": { "type": "boolean", "title": "Is Required", "default": false } }, "type": "object", "required": [ "code", "display_name", "data_type" ], "title": "FieldBody" }, "FieldPatch": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "title": "FieldPatch" }, "GuestNote": { "properties": { "version_id": { "type": "string", "title": "Version Id" }, "body": { "type": "string", "title": "Body", "default": "" }, "author": { "type": "string", "title": "Author", "default": "Guest" }, "approval": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approval" } }, "type": "object", "required": [ "version_id" ], "title": "GuestNote" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImportBody": { "properties": { "project_id": { "type": "string", "title": "Project Id" }, "entity_type": { "type": "string", "title": "Entity Type" }, "rows": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Rows" }, "status_map": { "additionalProperties": true, "type": "object", "title": "Status Map", "default": {} }, "create_missing_parents": { "type": "boolean", "title": "Create Missing Parents", "default": true } }, "type": "object", "required": [ "project_id", "entity_type", "rows" ], "title": "ImportBody" }, "InventoryBody": { "properties": { "version_ids": { "items": { "type": "string" }, "type": "array", "title": "Version Ids" } }, "type": "object", "required": [ "version_ids" ], "title": "InventoryBody" }, "LoaderBrowseBody": { "properties": { "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Type" }, "entity_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Type" }, "entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "latest_only": { "type": "boolean", "title": "Latest Only", "default": true } }, "type": "object", "title": "LoaderBrowseBody" }, "LoginBody": { "properties": { "email": { "type": "string", "title": "Email" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginBody" }, "ObjectTransitionsBody": { "properties": { "entity_code": { "type": "string", "title": "Entity Code" }, "edges": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array", "title": "Edges" } }, "type": "object", "required": [ "entity_code", "edges" ], "title": "ObjectTransitionsBody" }, "OptionRename": { "properties": { "old": { "type": "string", "title": "Old" }, "new": { "type": "string", "title": "New" } }, "type": "object", "required": [ "old", "new" ], "title": "OptionRename" }, "PriorityBody": { "properties": { "code": { "type": "string", "title": "Code" }, "name": { "type": "string", "title": "Name" }, "color": { "type": "string", "title": "Color", "default": "#888888" }, "value": { "type": "integer", "title": "Value", "default": 0 }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "required": [ "code", "name" ], "title": "PriorityBody" }, "PriorityPatch": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Value" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "title": "PriorityPatch" }, "PublishBody": { "properties": { "task_id": { "type": "string", "title": "Task Id" }, "product": { "type": "string", "title": "Product" }, "product_type": { "type": "string", "title": "Product Type" }, "representations": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Representations" }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "inputs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Inputs" }, "source_workfile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Workfile Id" }, "frame_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Frame Start" }, "frame_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Frame End" }, "fps": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Fps" }, "site_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Id" } }, "type": "object", "required": [ "task_id", "product", "product_type", "representations" ], "title": "PublishBody" }, "QueryBody": { "properties": { "filters": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Filters" }, "fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "sort": { "anyOf": [ { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, { "type": "null" } ], "title": "Sort" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "default": 100 }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Offset" } }, "type": "object", "title": "QueryBody" }, "ReactBody": { "properties": { "emoji": { "type": "string", "title": "Emoji" } }, "type": "object", "required": [ "emoji" ], "title": "ReactBody" }, "RegisterBody": { "properties": { "email": { "type": "string", "title": "Email" }, "password": { "type": "string", "title": "Password" }, "name": { "type": "string", "title": "Name" }, "role": { "type": "string", "title": "Role", "default": "Artist" } }, "type": "object", "required": [ "email", "password", "name" ], "title": "RegisterBody" }, "RenameBody": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "title": "RenameBody" }, "ResolveBody": { "properties": { "template": { "type": "string", "title": "Template" }, "context": { "additionalProperties": true, "type": "object", "title": "Context" }, "site_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Site Id" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, "type": "object", "required": [ "template", "context" ], "title": "ResolveBody" }, "RunBody": { "properties": { "entity_type": { "type": "string", "title": "Entity Type" }, "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids" }, "values": { "additionalProperties": true, "type": "object", "title": "Values", "default": {} } }, "type": "object", "required": [ "entity_type", "ids" ], "title": "RunBody" }, "SiteRootsBody": { "properties": { "roots": { "additionalProperties": true, "type": "object", "title": "Roots", "default": {} } }, "type": "object", "title": "SiteRootsBody" }, "StatusPatch": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "entity_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Code" } }, "type": "object", "title": "StatusPatch" }, "StepBody": { "properties": { "code": { "type": "string", "title": "Code" }, "name": { "type": "string", "title": "Name" }, "color": { "type": "string", "title": "Color", "default": "#888888" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "required": [ "code", "name" ], "title": "StepBody" }, "StepPatch": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "title": "StepPatch" }, "StepReorder": { "properties": { "codes": { "items": { "type": "string" }, "type": "array", "title": "Codes" } }, "type": "object", "required": [ "codes" ], "title": "StepReorder" }, "SubmitBody": { "properties": { "name": { "type": "string", "title": "Name" }, "job_type": { "type": "string", "title": "Job Type", "default": "render" }, "frames": { "type": "string", "title": "Frames", "default": "1-1" }, "plugin": { "type": "string", "title": "Plugin", "default": "CommandLine" }, "task_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Id" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output" }, "priority": { "type": "integer", "title": "Priority", "default": 50 }, "pool": { "type": "string", "title": "Pool", "default": "none" }, "group": { "type": "string", "title": "Group", "default": "none" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "extra_job": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extra Job" }, "extra_plugin": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extra Plugin" } }, "type": "object", "required": [ "name" ], "title": "SubmitBody" }, "SyncRequest": { "properties": { "representation_id": { "type": "string", "title": "Representation Id" }, "target_site_id": { "type": "string", "title": "Target Site Id" }, "target_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Path" } }, "type": "object", "required": [ "representation_id", "target_site_id" ], "title": "SyncRequest" }, "TaskTemplatesBody": { "properties": { "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "TaskTemplatesBody" }, "ToolsBody": { "properties": { "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ToolsBody" }, "UpdateBody": { "properties": { "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "type": "object", "title": "UpdateBody" }, "ValidationError": { "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" }, "WorkflowBody": { "properties": { "entity_code": { "type": "string", "title": "Entity Code" }, "from_status": { "type": "string", "title": "From Status" }, "to_status": { "type": "string", "title": "To Status" } }, "type": "object", "required": [ "entity_code", "from_status", "to_status" ], "title": "WorkflowBody" }, "fxq__api__routers__farm__StatusBody": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "progress": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Progress" }, "log": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Log" } }, "type": "object", "title": "StatusBody" }, "fxq__api__routers__schema__StatusBody": { "properties": { "code": { "type": "string", "title": "Code" }, "name": { "type": "string", "title": "Name" }, "color": { "type": "string", "title": "Color", "default": "#888888" }, "state": { "type": "string", "title": "State", "default": "in_progress" }, "short_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Short Name" }, "entity_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Code" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon" } }, "type": "object", "required": [ "code", "name" ], "title": "StatusBody" } } } }