{ "openapi": "3.2.0", "info": { "title": "AntFlow API", "description": "OpenAPI contract for the AntFlow ticket and project management API.\n\nBearer-token API calls are rate limited per API token. A throttled request returns HTTP 429 with Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.", "version": "1.0.0" }, "servers": [ { "url": "/", "description": "Current host" } ], "paths": { "/api/dashboard/widgets": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard widget configuration", "operationId": "dashboardWidgetGet", "responses": { "200": { "description": "Dashboard widget configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetConfig" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "put": { "tags": [ "Dashboard" ], "summary": "Update dashboard widget configuration", "operationId": "dashboardWidgetUpdate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetConfig" } } } }, "responses": { "200": { "description": "Updated dashboard widget configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetConfig" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "patch": { "tags": [ "Dashboard" ], "summary": "Update dashboard widget configuration", "operationId": "dashboardWidgetPatch", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetConfig" } } } }, "responses": { "200": { "description": "Updated dashboard widget configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetConfig" } } } } } } }, "/api/users/{user}": { "get": { "tags": [ "Users" ], "summary": "Get user", "operationId": "userGet", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "put": { "tags": [ "Users" ], "summary": "Update user", "operationId": "userUpdate", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWriteRequest" } } } }, "responses": { "200": { "description": "Updated user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "409": { "description": "Conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid user payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "patch": { "tags": [ "Users" ], "summary": "Update user", "operationId": "userPatch", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWriteRequest" } } } }, "responses": { "200": { "description": "Updated user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/api/projects/{project}": { "get": { "tags": [ "Projects" ], "summary": "Get project", "operationId": "projectGet", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "404": { "description": "Project not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "put": { "tags": [ "Projects" ], "summary": "Update project", "operationId": "projectUpdate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectWriteRequest" } } } }, "responses": { "200": { "description": "Updated project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Project not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete project", "operationId": "projectDelete", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Project not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "patch": { "tags": [ "Projects" ], "summary": "Update project", "operationId": "projectPatch", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectWriteRequest" } } } }, "responses": { "200": { "description": "Updated project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } } } } }, "/api/projects/{project}/sprints/{sprint}": { "put": { "tags": [ "Sprints" ], "summary": "Update sprint", "operationId": "sprintReplace", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintWriteRequest" } } } }, "responses": { "200": { "description": "Updated sprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } } } } }, "delete": { "tags": [ "Sprints" ], "summary": "Delete sprint", "operationId": "sprintDelete", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sprint deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Sprint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "patch": { "tags": [ "Sprints" ], "summary": "Update sprint", "operationId": "sprintUpdate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintWriteRequest" } } } }, "responses": { "200": { "description": "Updated sprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Sprint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/projects/{project}/workflow": { "put": { "tags": [ "Statuses" ], "summary": "Update project workflow", "operationId": "statusWorkflowReplace", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUpdateRequest" } } } }, "responses": { "200": { "description": "Updated workflow.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } } } } } } }, "patch": { "tags": [ "Statuses" ], "summary": "Update project workflow", "operationId": "statusWorkflowUpdate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUpdateRequest" } } } }, "responses": { "200": { "description": "Updated workflow.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/issuetypes/{issueType}": { "put": { "tags": [ "Issue types" ], "summary": "Update issue type", "operationId": "issueTypeUpdate", "parameters": [ { "name": "issueType", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeWriteRequest" } } } }, "responses": { "200": { "description": "Updated issue type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Issue type not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Issue types" ], "summary": "Delete issue type", "operationId": "issueTypeDelete", "parameters": [ { "name": "issueType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reassignTo", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Issue type deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeDeleteResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "409": { "description": "Issue type still in use.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeDeleteConflictResponse" } } } } } }, "patch": { "tags": [ "Issue types" ], "summary": "Update issue type", "operationId": "issueTypePatch", "parameters": [ { "name": "issueType", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeWriteRequest" } } } }, "responses": { "200": { "description": "Updated issue type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } } } } } }, "/api/statuses/{status}": { "put": { "tags": [ "Statuses" ], "summary": "Update status", "operationId": "statusUpdate", "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusWriteRequest" } } } }, "responses": { "200": { "description": "Updated status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Status not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Statuses" ], "summary": "Delete status", "operationId": "statusDelete", "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Status deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "patch": { "tags": [ "Statuses" ], "summary": "Update status", "operationId": "statusPatch", "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusWriteRequest" } } } }, "responses": { "200": { "description": "Updated status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } } } } }, "/api/tags/{tag}": { "put": { "tags": [ "Tags" ], "summary": "Update tag", "operationId": "tagReplace", "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagWriteRequest" } } } }, "responses": { "200": { "description": "Updated tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } } } }, "delete": { "tags": [ "Tags" ], "summary": "Delete tag", "operationId": "tagDelete", "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "patch": { "tags": [ "Tags" ], "summary": "Update tag", "operationId": "tagUpdate", "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagWriteRequest" } } } }, "responses": { "200": { "description": "Updated tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/timers/active": { "get": { "tags": [ "Timers" ], "summary": "Active timer", "operationId": "timerActive", "responses": { "200": { "description": "Active timer.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Timer" }, { "type": "null" } ] } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "put": { "tags": [ "Timers" ], "summary": "Update active timer", "operationId": "timerReplaceActive", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerWriteRequest" } } } }, "responses": { "200": { "description": "Updated timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } } } }, "patch": { "tags": [ "Timers" ], "summary": "Update active timer", "operationId": "timerUpdateActive", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerWriteRequest" } } } }, "responses": { "200": { "description": "Updated timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } }, "404": { "description": "No active timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/timers/{timer}": { "put": { "tags": [ "Timers" ], "summary": "Update timer", "operationId": "timerReplace", "parameters": [ { "name": "timer", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerWriteRequest" } } } }, "responses": { "200": { "description": "Updated timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } } } }, "delete": { "tags": [ "Timers" ], "summary": "Delete timer", "operationId": "timerDelete", "parameters": [ { "name": "timer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemovedResponse" } } } } } }, "patch": { "tags": [ "Timers" ], "summary": "Update timer", "operationId": "timerUpdate", "parameters": [ { "name": "timer", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerWriteRequest" } } } }, "responses": { "200": { "description": "Updated timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } }, "404": { "description": "Timer not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/time-entries/{timeEntry}": { "put": { "tags": [ "Time entries" ], "summary": "Update time entry", "operationId": "timeEntryReplace", "parameters": [ { "name": "timeEntry", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryWriteRequest" } } } }, "responses": { "200": { "description": "Updated time entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryReport" } } } } } }, "delete": { "tags": [ "Time entries" ], "summary": "Delete time entry", "operationId": "timeEntryDeleteById", "parameters": [ { "name": "timeEntry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted time entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } }, "patch": { "tags": [ "Time entries" ], "summary": "Update time entry", "operationId": "timeEntryUpdate", "parameters": [ { "name": "timeEntry", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryWriteRequest" } } } }, "responses": { "200": { "description": "Updated time entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryReport" } } } }, "404": { "description": "Time entry not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/companies/{company}": { "put": { "tags": [ "Companies" ], "summary": "Update company", "description": "Updates company-scoped settings. The authenticated user must be an active company Administrator/Owner or SuperAdmin; bearer token scope company:admin is only an additional cap and does not grant that role.", "operationId": "companyReplace", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyAdminUpdateRequest" } } } }, "responses": { "200": { "description": "Updated company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } } }, "patch": { "tags": [ "Companies" ], "summary": "Update company", "description": "Updates company-scoped settings. The authenticated user must be an active company Administrator/Owner or SuperAdmin; bearer token scope company:admin is only an additional cap and does not grant that role.", "operationId": "companyUpdate", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyAdminUpdateRequest" } } } }, "responses": { "200": { "description": "Updated company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/tickets/{ticket}/comments/{comment}": { "put": { "tags": [ "Comments" ], "summary": "Update ticket comment", "operationId": "commentReplace", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentWriteRequest" } } } }, "responses": { "200": { "description": "Updated comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } } } }, "delete": { "tags": [ "Comments" ], "summary": "Delete ticket comment", "operationId": "commentDelete", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } }, "patch": { "tags": [ "Comments" ], "summary": "Update ticket comment", "operationId": "commentUpdate", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentWriteRequest" } } } }, "responses": { "200": { "description": "Updated comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } } } } }, "/api/presets/{preset}": { "get": { "tags": [ "Presets" ], "summary": "Get preset", "operationId": "presetGet", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preset" } } } }, "404": { "description": "Preset not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "put": { "tags": [ "Presets" ], "summary": "Update preset", "operationId": "presetReplace", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetWriteRequest" } } } }, "responses": { "200": { "description": "Updated preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preset" } } } } } }, "delete": { "tags": [ "Presets" ], "summary": "Delete preset", "operationId": "presetDelete", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "patch": { "tags": [ "Presets" ], "summary": "Update preset", "operationId": "presetUpdate", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetWriteRequest" } } } }, "responses": { "200": { "description": "Updated preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preset" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/auth/login/discovery": { "post": { "tags": [ "Authentication" ], "summary": "Discover tenant-aware login methods", "operationId": "authLoginDiscovery", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthLoginDiscoveryRequest" } } } }, "responses": { "200": { "description": "Available login methods or a required company choice.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthLoginDiscoveryResponse" } } } }, "404": { "description": "Requested company not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid email address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [] } }, "/api/auth/login": { "post": { "tags": [ "Authentication" ], "summary": "Login", "operationId": "authLogin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthLoginRequest" } } } }, "responses": { "200": { "description": "Authenticated session or two-factor challenge.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } } }, "401": { "description": "Invalid credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Invitation still pending.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [] } }, "/api/auth/login/2fa": { "post": { "tags": [ "Authentication" ], "summary": "Complete two-factor login", "operationId": "authTwoFactorLogin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthCodeRequest" } } } }, "responses": { "200": { "description": "Authenticated session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } } }, "401": { "description": "Invalid or expired two-factor challenge.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/auth/logout": { "post": { "tags": [ "Authentication" ], "summary": "Logout", "operationId": "authLogout", "responses": { "200": { "description": "Logged out.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/auth/me": { "get": { "tags": [ "Authentication" ], "summary": "Current authentication state", "operationId": "authMe", "responses": { "200": { "description": "Authenticated session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } } }, "401": { "description": "Unauthenticated session or pending two-factor verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthSessionResponse" } } } } } } }, "/api/auth/password-policy": { "get": { "tags": [ "Authentication" ], "summary": "Current password policy", "operationId": "authPasswordPolicy", "responses": { "200": { "description": "Password policy.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "/api/register": { "get": { "tags": [ "Authentication" ], "summary": "Public registration status", "operationId": "registrationStatus", "responses": { "200": { "description": "Registration availability.", "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" } } } } }, "security": [] } }, "/api/auth/invitations/{token}": { "get": { "tags": [ "Authentication" ], "summary": "Invitation details", "operationId": "authInvitation", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invitation details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthInvitationResponse" } } } }, "404": { "description": "Invalid invitation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "410": { "description": "Invitation expired or already accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/api/auth/invitations/{token}/accept": { "post": { "tags": [ "Authentication" ], "summary": "Accept invitation", "operationId": "authAcceptInvitation", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthAcceptInvitationRequest" } } } }, "responses": { "200": { "description": "Invitation accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "404": { "description": "Invalid invitation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "Seat limit reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "410": { "description": "Invitation expired or already accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Invalid setup data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [] } }, "/api/auth/password-resets": { "post": { "tags": [ "Authentication" ], "summary": "Request password reset", "operationId": "authRequestPasswordReset", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthEmailRequest" } } } }, "responses": { "200": { "description": "Password reset accepted if the account exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "422": { "description": "Email missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [] } }, "/api/auth/password-resets/{token}": { "get": { "tags": [ "Authentication" ], "summary": "Password reset details", "operationId": "authPasswordReset", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Password reset details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthPasswordResetResponse" } } } }, "404": { "description": "Invalid password reset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "410": { "description": "Password reset expired or already used.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/api/auth/password-resets/{token}/reset": { "post": { "tags": [ "Authentication" ], "summary": "Reset password", "operationId": "authResetPassword", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthPasswordRequest" } } } }, "responses": { "200": { "description": "Password reset completed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "404": { "description": "Invalid password reset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "410": { "description": "Password reset expired or already used.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Password invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [] } }, "/api/auth/email-changes/{token}": { "get": { "tags": [ "Authentication" ], "summary": "Email change details", "operationId": "authEmailChange", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Email change details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthEmailChangeResponse" } } } }, "404": { "description": "Invalid email confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "410": { "description": "Email confirmation expired or already used.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/api/auth/email-changes/{token}/confirm": { "post": { "tags": [ "Authentication" ], "summary": "Confirm email change", "operationId": "authConfirmEmailChange", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Email change confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "404": { "description": "Invalid email confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "Email already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "410": { "description": "Email confirmation expired or already used.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/api/auth/email-verifications/{token}": { "get": { "tags": [ "Authentication" ], "summary": "Email verification details", "operationId": "authEmailVerification", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Email verification details.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Invalid email verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "410": { "description": "Email verification expired or already used.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/api/auth/email-verifications/{token}/confirm": { "post": { "tags": [ "Authentication" ], "summary": "Confirm email verification", "operationId": "authConfirmEmailVerification", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Email verified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "404": { "description": "Invalid email verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "410": { "description": "Email verification expired or already used.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [] } }, "/api/auth/changePassword": { "post": { "tags": [ "Authentication" ], "summary": "Change current user password", "operationId": "authChangePassword", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthChangePasswordRequest" } } } }, "responses": { "200": { "description": "Password changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "401": { "description": "Not authenticated or current password incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Invalid password payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/auth/2fa": { "get": { "tags": [ "Authentication" ], "summary": "Two-factor status", "operationId": "authTwoFactorStatus", "responses": { "200": { "description": "Two-factor status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTwoFactorStatusResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/auth/2fa/setup": { "post": { "tags": [ "Authentication" ], "summary": "Start two-factor setup", "operationId": "authTwoFactorSetup", "responses": { "200": { "description": "Two-factor setup secret and QR data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTwoFactorSetupResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/auth/2fa/confirm": { "post": { "tags": [ "Authentication" ], "summary": "Confirm two-factor setup", "operationId": "authConfirmTwoFactorSetup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthCodeRequest" } } } }, "responses": { "200": { "description": "Two-factor setup confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTwoFactorSetupConfirmedResponse" } } } }, "401": { "description": "Invalid code or not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "410": { "description": "Two-factor setup expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/auth/2fa/disable": { "post": { "tags": [ "Authentication" ], "summary": "Disable two-factor authentication", "operationId": "authDisableTwoFactor", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthDisableTwoFactorRequest" } } } }, "responses": { "200": { "description": "Two-factor disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTwoFactorStatusResponse" } } } }, "401": { "description": "Invalid password, invalid code, or not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Password missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/projects/{project}/billing-profiles": { "get": { "tags": [ "Billing" ], "summary": "List project billing profiles", "operationId": "billingProfileList", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Billing profiles.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } }, "post": { "tags": [ "Billing" ], "summary": "Create billing profile", "operationId": "billingProfileCreate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "201": { "description": "Created billing profile.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/projects/{project}/billing-profiles/{billingProfile}": { "delete": { "tags": [ "Billing" ], "summary": "Delete or archive billing profile", "operationId": "billingProfileDelete", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "billingProfile", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted or archived billing profile.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Billing profile is used by historical time entries." } } }, "patch": { "tags": [ "Billing" ], "summary": "Update billing profile", "operationId": "billingProfileUpdate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "billingProfile", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Updated billing profile.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/projects/{project}/billing-profiles/{billingProfile}/restore": { "post": { "tags": [ "Billing" ], "summary": "Restore archived billing profile", "operationId": "billingProfileRestore", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "billingProfile", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Restored billing profile.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/projects/{project}/billing-report": { "get": { "tags": [ "Billing" ], "summary": "Project billing report", "operationId": "billingReport", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Billing report.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/projects/{project}/billing-report.csv": { "get": { "tags": [ "Billing" ], "summary": "Project billing CSV export", "operationId": "billingReportCsv", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Billing CSV.", "content": { "text/csv": [] } } } } }, "/api/projects/{project}/billing-impact": { "post": { "tags": [ "Billing" ], "summary": "Preview billing impact for a time entry", "operationId": "billingImpact", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Billing impact.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/calendars": { "get": { "tags": [ "Calendars" ], "summary": "List Calendars", "operationId": "calendarList", "responses": { "200": { "description": "Calendars.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarSummary" } } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Calendars" ], "summary": "Create a Calendar", "operationId": "calendarCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } } } }, "responses": { "201": { "description": "Created Calendar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid Calendar payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/reorder": { "post": { "tags": [ "Calendars" ], "summary": "Reorder Calendars", "operationId": "calendarReorder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarReorderRequest" } } } }, "responses": { "200": { "description": "Reordered Calendars.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarSummary" } } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/calendars/{calendar}": { "get": { "tags": [ "Calendars" ], "summary": "Get a Calendar", "operationId": "calendarGet", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calendar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Calendar not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Calendars" ], "summary": "Delete a Calendar", "operationId": "calendarDelete", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted Calendar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "patch": { "tags": [ "Calendars" ], "summary": "Update a Calendar", "operationId": "calendarUpdate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarWriteRequest" } } } }, "responses": { "200": { "description": "Updated Calendar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid Calendar payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/share": { "patch": { "tags": [ "Calendars" ], "summary": "Update public read-only sharing", "operationId": "calendarShareUpdate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarShareRequest" } } } }, "responses": { "200": { "description": "Updated sharing settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarSummary" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/calendars/{calendar}/rings": { "post": { "tags": [ "Calendars" ], "summary": "Create a Calendar ring", "operationId": "calendarRingCreate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarRingWriteRequest" } } } }, "responses": { "201": { "description": "Created ring.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid ring payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/rings/{ring}": { "delete": { "tags": [ "Calendars" ], "summary": "Delete a Calendar ring", "operationId": "calendarRingDelete", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted ring.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Ring not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "patch": { "tags": [ "Calendars" ], "summary": "Update a Calendar ring", "operationId": "calendarRingUpdate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarRingWriteRequest" } } } }, "responses": { "200": { "description": "Updated ring.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Ring not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid ring payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/rings/{ring}/sources": { "post": { "tags": [ "Calendars" ], "summary": "Create a ring source", "operationId": "calendarSourceCreate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarSourceWriteRequest" } } } }, "responses": { "201": { "description": "Created source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Ring not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid source payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/rings/{ring}/sources/{source}": { "delete": { "tags": [ "Calendars" ], "summary": "Delete a ring source", "operationId": "calendarSourceDelete", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Source not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "patch": { "tags": [ "Calendars" ], "summary": "Update a ring source", "operationId": "calendarSourceUpdate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarSourceWriteRequest" } } } }, "responses": { "200": { "description": "Updated source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Source not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid source payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/rings/{ring}/sources/{source}/sync": { "post": { "tags": [ "Calendars" ], "summary": "Synchronize an iCal source", "operationId": "calendarSourceSync", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Synchronized iCal source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarSyncResponse" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Source not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "Source is not an iCal source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Synchronization failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/rings/{ring}/sources/{source}/events": { "post": { "tags": [ "Calendars" ], "summary": "Create a custom source event", "operationId": "calendarEventCreate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventWriteRequest" } } } }, "responses": { "201": { "description": "Created event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "409": { "description": "Only custom sources can be edited manually.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid event payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/calendars/{calendar}/rings/{ring}/sources/{source}/events/{event}": { "delete": { "tags": [ "Calendars" ], "summary": "Delete a custom source event", "operationId": "calendarEventDelete", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "event", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Event not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "Only custom events can be deleted manually.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } } } }, "patch": { "tags": [ "Calendars" ], "summary": "Update a custom source event", "operationId": "calendarEventUpdate", "parameters": [ { "name": "calendar", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "event", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventWriteRequest" } } } }, "responses": { "200": { "description": "Updated event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "403": { "description": "Current-company manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Event not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "Only custom events can be edited manually.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid event payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/public/calendars/{token}.ics": { "get": { "tags": [ "Public" ], "summary": "Public Calendar iCal feed", "operationId": "publicCalendarIcalGet", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public Calendar iCal feed.", "content": { "text/calendar": { "schema": { "type": "string" } } } }, "404": { "description": "Public Calendar not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/public/calendars/{token}/rings/{ring}.ics": { "get": { "tags": [ "Public" ], "summary": "Public Calendar ring iCal feed", "operationId": "publicCalendarRingIcalGet", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public Calendar ring iCal feed.", "content": { "text/calendar": { "schema": { "type": "string" } } } }, "404": { "description": "Public Calendar not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/public/calendars/{token}/rings/{ring}/sources/{source}.ics": { "get": { "tags": [ "Public" ], "summary": "Public Calendar source iCal feed", "operationId": "publicCalendarSourceIcalGet", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ring", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public Calendar source iCal feed.", "content": { "text/calendar": { "schema": { "type": "string" } } } }, "404": { "description": "Public Calendar not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/public/calendars/{token}": { "get": { "tags": [ "Public" ], "summary": "Public read-only Calendar", "operationId": "publicCalendarGet", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public Calendar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } } }, "404": { "description": "Public Calendar not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/chat/bootstrap": { "get": { "tags": [ "Chat" ], "summary": "Chat bootstrap", "operationId": "chatBootstrap", "responses": { "200": { "description": "Chat bootstrap data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatBootstrapResponse" } } } } } } }, "/api/chat/gifs": { "get": { "tags": [ "Chat" ], "summary": "Search or browse trending GIFs", "operationId": "chatGifSearch", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 100 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 24, "maximum": 48, "minimum": 1 } }, { "name": "pos", "in": "query", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Normalized KLIPY GIF results." }, "503": { "description": "GIF search is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/gifs/favorites": { "get": { "tags": [ "Chat" ], "summary": "List the current user GIF favorites", "operationId": "chatGifFavorites", "responses": { "200": { "description": "Account-level GIF favorites." } } }, "post": { "tags": [ "Chat" ], "summary": "Add or remove an account-level GIF favorite", "operationId": "chatUpdateGifFavorite", "responses": { "200": { "description": "Updated account-level GIF favorites." }, "422": { "description": "Invalid GIF metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/presence": { "get": { "tags": [ "Chat" ], "summary": "Chat presence", "operationId": "chatPresence", "responses": { "200": { "description": "Chat presence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatPresenceResponse" } } } } } } }, "/api/chat/channel-presence-stats": { "post": { "tags": [ "Chat" ], "summary": "Chat channel presence stats", "operationId": "chatChannelPresenceStats", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatPresenceStatsRequest" } } } }, "responses": { "200": { "description": "Channel presence stats.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatPresenceStatsResponse" } } } } } } }, "/api/chat/calls/token": { "post": { "tags": [ "Chat" ], "summary": "Create chat call join token", "operationId": "chatCallToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallTokenRequest" } } } }, "responses": { "200": { "description": "RTC join token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallTokenResponse" } } } }, "503": { "description": "RTC is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/status": { "post": { "tags": [ "Chat" ], "summary": "Read active chat call state", "operationId": "chatCallStatus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallTokenRequest" } } } }, "responses": { "200": { "description": "RTC room state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallStatusResponse" } } } }, "503": { "description": "RTC is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/signal": { "post": { "tags": [ "Chat" ], "summary": "Publish chat call state", "operationId": "chatCallSignal", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallSignalRequest" } } } }, "responses": { "200": { "description": "Call signal accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallSignalResponse" } } } } } } }, "/api/chat/calls/invite": { "post": { "tags": [ "Chat" ], "summary": "Invite users to an active chat call", "operationId": "chatCallInvite", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallInviteRequest" } } } }, "responses": { "200": { "description": "Call invites sent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "503": { "description": "RTC is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/ingress": { "post": { "tags": [ "Chat" ], "summary": "Create chat call streaming endpoint", "operationId": "chatCallIngress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallIngressRequest" } } } }, "responses": { "200": { "description": "Created streaming endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallIngressResponse" } } } }, "503": { "description": "RTC streaming is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/ingress/status": { "post": { "tags": [ "Chat" ], "summary": "Read chat call streaming endpoint state", "operationId": "chatCallIngressStatus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallIngressStatusRequest" } } } }, "responses": { "200": { "description": "Streaming endpoint state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallIngressResponse" } } } }, "503": { "description": "RTC streaming is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/ingress/delete": { "post": { "tags": [ "Chat" ], "summary": "Delete chat call streaming endpoint", "operationId": "chatCallIngressDelete", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallIngressDeleteRequest" } } } }, "responses": { "200": { "description": "Streaming endpoint delete result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "503": { "description": "RTC streaming is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/egress": { "post": { "tags": [ "Chat" ], "summary": "Start chat call recording or outbound stream", "operationId": "chatCallEgress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallEgressRequest" } } } }, "responses": { "200": { "description": "Started recording or outbound stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallEgressResponse" } } } }, "409": { "description": "A recording or outbound stream is already active.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "RTC recording is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/egress/status": { "post": { "tags": [ "Chat" ], "summary": "Read chat call recording or outbound stream state", "operationId": "chatCallEgressStatus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallEgressStatusRequest" } } } }, "responses": { "200": { "description": "Recording or outbound stream state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallEgressResponse" } } } }, "503": { "description": "RTC recording is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/egress/stop": { "post": { "tags": [ "Chat" ], "summary": "Stop chat call recording or outbound stream", "operationId": "chatCallEgressStop", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallEgressStopRequest" } } } }, "responses": { "200": { "description": "Stopped recording or outbound stream.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCallEgressStopResponse" } } } }, "503": { "description": "RTC recording is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/calls/egress/download": { "get": { "tags": [ "Chat" ], "summary": "Redirect to a chat call recording object", "operationId": "chatCallEgressDownload", "parameters": [ { "name": "conversation", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "filename", "in": "query", "schema": { "type": "string" } }, { "name": "mediaType", "in": "query", "schema": { "type": "string" } } ], "responses": { "302": { "description": "Redirect to public or presigned recording URL." }, "403": { "description": "The user cannot access this conversation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The recording object could not be signed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/chat/direct/{user}/messages": { "get": { "tags": [ "Chat" ], "summary": "Direct chat messages", "operationId": "chatDirectMessages", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Direct messages.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessagePageResponse" } } } } } }, "post": { "tags": [ "Chat" ], "summary": "Post direct chat message", "operationId": "chatPostDirectMessage", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } } } }, "responses": { "201": { "description": "Created direct message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } } } } }, "/api/chat/direct/{user}/typing": { "post": { "tags": [ "Chat" ], "summary": "Post direct typing state", "operationId": "chatPostDirectTyping", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Typing state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/direct/{user}/read": { "post": { "tags": [ "Chat" ], "summary": "Mark direct chat read", "operationId": "chatPostDirectRead", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Read state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/groups": { "post": { "tags": [ "Chat" ], "summary": "Create group chat", "operationId": "chatCreateGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "userIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Created group chat.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatChannelSummary" } } } } } } }, "/api/chat/groups/{group}/messages": { "get": { "tags": [ "Chat" ], "summary": "Group chat messages", "operationId": "chatGroupMessages", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Group chat messages.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessagePageResponse" } } } } } }, "post": { "tags": [ "Chat" ], "summary": "Post group chat message", "operationId": "chatPostGroupMessage", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } } } }, "responses": { "201": { "description": "Created group message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } } } } }, "/api/chat/groups/{group}/presence": { "get": { "tags": [ "Chat" ], "summary": "Group chat members", "operationId": "chatGroupPresence", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Group members.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatPresenceResponse" } } } } } } }, "/api/chat/groups/{group}/members": { "post": { "tags": [ "Chat" ], "summary": "Add members to group chat", "operationId": "chatAddGroupMembers", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "userIds" ], "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "includeHistory": { "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "201": { "description": "Added group members.", "content": { "application/json": { "schema": { "properties": { "group": { "$ref": "#/components/schemas/ChatChannelSummary" }, "message": { "$ref": "#/components/schemas/ChatMessage" } }, "type": "object" } } } } } } }, "/api/chat/groups/{group}/typing": { "post": { "tags": [ "Chat" ], "summary": "Post group typing state", "operationId": "chatPostGroupTyping", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Typing state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/groups/{group}/read": { "post": { "tags": [ "Chat" ], "summary": "Mark group chat read", "operationId": "chatPostGroupRead", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Read state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/projects/{project}/messages": { "get": { "tags": [ "Chat" ], "summary": "Project chat messages", "operationId": "chatProjectMessages", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project chat messages.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessagePageResponse" } } } } } }, "post": { "tags": [ "Chat" ], "summary": "Post project chat message", "operationId": "chatPostProjectMessage", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } } } }, "responses": { "201": { "description": "Created project message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } } } } }, "/api/chat/projects/{project}/presence": { "get": { "tags": [ "Chat" ], "summary": "Project chat presence", "operationId": "chatProjectPresence", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project presence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatPresenceResponse" } } } } } } }, "/api/chat/projects/{project}/typing": { "post": { "tags": [ "Chat" ], "summary": "Post project typing state", "operationId": "chatPostProjectTyping", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Typing state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/projects/{project}/read": { "post": { "tags": [ "Chat" ], "summary": "Mark project chat read", "operationId": "chatPostProjectRead", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Read state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/channels/{type}/{channel}/leave": { "post": { "tags": [ "Chat" ], "summary": "Leave a chat channel", "operationId": "chatLeaveChannel", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "project", "board", "group" ] } }, { "name": "channel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created leave message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } } } } }, "/api/chat/channels/{type}/{channel}/join": { "post": { "tags": [ "Chat" ], "summary": "Publish a chat channel join message", "operationId": "chatJoinChannel", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "project", "board" ] } }, { "name": "channel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created join message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } } } } }, "/api/chat/boards/search": { "get": { "tags": [ "Chat" ], "summary": "Search board chat channels", "operationId": "chatBoardSearch", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 50, "minimum": 1 } } ], "responses": { "200": { "description": "Matching board channels.", "content": { "application/json": { "schema": { "properties": { "boardChannels": { "type": "array", "items": { "$ref": "#/components/schemas/ChatChannelSummary" } } }, "type": "object" } } } } } } }, "/api/chat/boards/{board}/messages": { "get": { "tags": [ "Chat" ], "summary": "Board chat messages", "operationId": "chatBoardMessages", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Board chat messages.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessagePageResponse" } } } } } }, "post": { "tags": [ "Chat" ], "summary": "Post board chat message", "operationId": "chatPostBoardMessage", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageCreateRequest" } } } }, "responses": { "201": { "description": "Created board message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } } } } }, "/api/chat/boards/{board}/presence": { "get": { "tags": [ "Chat" ], "summary": "Board chat presence", "operationId": "chatBoardPresence", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Board presence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatPresenceResponse" } } } } } } }, "/api/chat/boards/{board}/typing": { "post": { "tags": [ "Chat" ], "summary": "Post board typing state", "operationId": "chatPostBoardTyping", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Typing state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/chat/boards/{board}/read": { "post": { "tags": [ "Chat" ], "summary": "Mark board chat read", "operationId": "chatPostBoardRead", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Read state accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/docs/pages": { "get": { "tags": [ "Docs" ], "summary": "List documentation pages", "operationId": "docsPageList", "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "all", "project", "company", "private" ] } }, { "name": "parentId", "in": "query", "schema": { "type": "string" } }, { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Documentation pages grouped by visibility.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPagesResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "post": { "tags": [ "Docs" ], "summary": "Create documentation page", "operationId": "docsPageCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageCreateRequest" } } } }, "responses": { "201": { "description": "Created documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid page payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/docs/pages/search": { "get": { "tags": [ "Docs" ], "summary": "Search documentation pages for linking", "operationId": "docsPageSearch", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "query", "in": "query", "schema": { "type": "string", "minLength": 3 } }, { "name": "sourceVisibility", "in": "query", "schema": { "type": "string", "enum": [ "project", "company", "private" ] } }, { "name": "scope", "in": "query", "schema": { "type": "string", "enum": [ "all", "project", "company", "private" ] } }, { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 50, "minimum": 1 } } ], "responses": { "200": { "description": "Matching documentation page link targets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsSearchResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/navigation": { "get": { "tags": [ "Docs" ], "summary": "Documentation navigation shortcuts", "operationId": "docsNavigation", "parameters": [ { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 50, "minimum": 1 } } ], "responses": { "200": { "description": "Recent, favorite and popular documentation pages.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsNavigationResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/favorites/reorder": { "post": { "tags": [ "Docs" ], "summary": "Reorder documentation favorites", "operationId": "docsFavoriteReorder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFavoriteReorderRequest" } } } }, "responses": { "200": { "description": "Reordered favorites.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFavoriteReorderResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/docs/pages/{page}": { "get": { "tags": [ "Docs" ], "summary": "Get documentation page", "operationId": "docsPageGet", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Page not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "put": { "tags": [ "Docs" ], "summary": "Replace documentation page", "operationId": "docsPageReplace", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageUpdateRequest" } } } }, "responses": { "200": { "description": "Updated documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid page payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "delete": { "tags": [ "Docs" ], "summary": "Delete documentation page", "operationId": "docsPageDelete", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeSubpages", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Deleted documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "patch": { "tags": [ "Docs" ], "summary": "Update documentation page", "operationId": "docsPageUpdate", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageUpdateRequest" } } } }, "responses": { "200": { "description": "Updated documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid page payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/docs/pages/{page}/versions": { "get": { "tags": [ "Docs" ], "summary": "List documentation page versions", "operationId": "docsPageVersions", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 200, "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "Documentation page versions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageVersionsResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/versions/{version}/revert": { "post": { "tags": [ "Docs" ], "summary": "Revert documentation page version", "operationId": "docsPageVersionRevert", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reverted documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/move": { "post": { "tags": [ "Docs" ], "summary": "Move documentation page", "operationId": "docsPageMove", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageMoveRequest" } } } }, "responses": { "200": { "description": "Moved documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid move target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "patch": { "tags": [ "Docs" ], "summary": "Move documentation page", "operationId": "docsPageMovePatch", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageMoveRequest" } } } }, "responses": { "200": { "description": "Moved documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/copy": { "post": { "tags": [ "Docs" ], "summary": "Copy documentation page", "operationId": "docsPageCopy", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPageCopyRequest" } } } }, "responses": { "201": { "description": "Copied documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/assets": { "post": { "tags": [ "Docs" ], "summary": "Upload documentation asset", "operationId": "docsPageAssetUpload", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object", "additionalProperties": false } } } }, "responses": { "201": { "description": "Uploaded documentation asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsAssetUploadResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid upload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/docs/pages/{page}/assets/{asset}": { "get": { "tags": [ "Docs" ], "summary": "Download documentation asset", "operationId": "docsPageAssetDownload", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Documentation asset file.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Asset not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Docs" ], "summary": "Delete documentation asset", "operationId": "docsPageAssetDelete", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted documentation asset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/favorite": { "put": { "tags": [ "Docs" ], "summary": "Set documentation favorite state", "operationId": "docsPageFavoritePut", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFavoriteRequest" } } } }, "responses": { "200": { "description": "Updated favorite state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFavoriteResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "post": { "tags": [ "Docs" ], "summary": "Set documentation favorite state", "operationId": "docsPageFavorite", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFavoriteRequest" } } } }, "responses": { "200": { "description": "Updated favorite state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsFavoriteResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/permissions": { "get": { "tags": [ "Docs" ], "summary": "Get documentation page permissions", "operationId": "docsPagePermissions", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Documentation page permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPermissionsResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Private page permissions are not shared.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "put": { "tags": [ "Docs" ], "summary": "Update documentation page permissions", "operationId": "docsPagePermissionsReplace", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPermissionsWriteRequest" } } } }, "responses": { "200": { "description": "Updated documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "patch": { "tags": [ "Docs" ], "summary": "Update documentation page permissions", "operationId": "docsPagePermissionsPatch", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPermissionsWriteRequest" } } } }, "responses": { "200": { "description": "Updated documentation page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsPage" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/docs/pages/{page}/toc-tree": { "get": { "tags": [ "Docs" ], "summary": "Get documentation page table of contents tree", "operationId": "docsPageTocTree", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "depth", "in": "query", "schema": { "type": "integer", "maximum": 6, "minimum": 1 } } ], "responses": { "200": { "description": "Documentation page table of contents tree.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocsTocTreeResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/docs/pages/{page}/export/pdf": { "get": { "tags": [ "Docs" ], "summary": "Export documentation page as PDF", "operationId": "docsPageExportPdf", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeFiles", "in": "query", "schema": { "type": "boolean" } }, { "name": "separatePages", "in": "query", "schema": { "type": "boolean" } }, { "name": "mode", "in": "query", "schema": { "type": "string", "enum": [ "single", "subpages", "linked" ] } }, { "name": "depth", "in": "query", "schema": { "type": "integer", "maximum": 4, "minimum": 0 } }, { "name": "linkDepth", "in": "query", "schema": { "type": "integer", "maximum": 3, "minimum": 0 } } ], "responses": { "200": { "description": "PDF or ZIP export.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "502": { "description": "Export failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/docs/pages/{page}/export/docx": { "get": { "tags": [ "Docs" ], "summary": "Export documentation page as DOCX", "operationId": "docsPageExportDocx", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeFiles", "in": "query", "schema": { "type": "boolean" } }, { "name": "separatePages", "in": "query", "schema": { "type": "boolean" } }, { "name": "mode", "in": "query", "schema": { "type": "string", "enum": [ "single", "subpages", "linked" ] } }, { "name": "depth", "in": "query", "schema": { "type": "integer", "maximum": 4, "minimum": 0 } }, { "name": "linkDepth", "in": "query", "schema": { "type": "integer", "maximum": 3, "minimum": 0 } } ], "responses": { "200": { "description": "DOCX or ZIP export.", "content": { "application/vnd.openxmlformats-officedocument.wordprocessingml.document": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "502": { "description": "Export failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/docs/pages/{page}/export/odt": { "get": { "tags": [ "Docs" ], "summary": "Export documentation page as ODT", "operationId": "docsPageExportOdt", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeFiles", "in": "query", "schema": { "type": "boolean" } }, { "name": "separatePages", "in": "query", "schema": { "type": "boolean" } }, { "name": "mode", "in": "query", "schema": { "type": "string", "enum": [ "single", "subpages", "linked" ] } }, { "name": "depth", "in": "query", "schema": { "type": "integer", "maximum": 4, "minimum": 0 } }, { "name": "linkDepth", "in": "query", "schema": { "type": "integer", "maximum": 3, "minimum": 0 } } ], "responses": { "200": { "description": "ODT or ZIP export.", "content": { "application/vnd.oasis.opendocument.text": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "502": { "description": "Export failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/docs/pages/{page}/export/markdown": { "get": { "tags": [ "Docs" ], "summary": "Export documentation page as Markdown", "operationId": "docsPageExportMarkdown", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeFiles", "in": "query", "schema": { "type": "boolean" } }, { "name": "separatePages", "in": "query", "schema": { "type": "boolean" } }, { "name": "mode", "in": "query", "schema": { "type": "string", "enum": [ "single", "subpages", "linked" ] } }, { "name": "depth", "in": "query", "schema": { "type": "integer", "maximum": 4, "minimum": 0 } }, { "name": "linkDepth", "in": "query", "schema": { "type": "integer", "maximum": 3, "minimum": 0 } } ], "responses": { "200": { "description": "Markdown or ZIP export.", "content": { "text/markdown": { "schema": { "type": "string" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "502": { "description": "Export failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/docs/pages/{page}/export/html": { "get": { "tags": [ "Docs" ], "summary": "Export documentation page as HTML", "operationId": "docsPageExportHtml", "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeFiles", "in": "query", "schema": { "type": "boolean" } }, { "name": "separatePages", "in": "query", "schema": { "type": "boolean" } }, { "name": "mode", "in": "query", "schema": { "type": "string", "enum": [ "single", "subpages", "linked" ] } }, { "name": "depth", "in": "query", "schema": { "type": "integer", "maximum": 4, "minimum": 0 } }, { "name": "linkDepth", "in": "query", "schema": { "type": "integer", "maximum": 3, "minimum": 0 } } ], "responses": { "200": { "description": "HTML or ZIP export.", "content": { "text/html": { "schema": { "type": "string" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "502": { "description": "Export failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/users": { "get": { "tags": [ "Users" ], "summary": "List users", "operationId": "userList", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "withTotal", "in": "query", "schema": { "type": "boolean" } }, { "name": "companyOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "activeOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "acceptedOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "groupId", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "sprintId", "in": "query", "schema": { "type": "string" } }, { "name": "selectedUserId", "in": "query", "schema": { "type": "string" } }, { "name": "selectedUserIds", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Users.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UserPageResponse" }, { "type": "array", "items": { "$ref": "#/components/schemas/User" } } ] } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "post": { "tags": [ "Users" ], "summary": "Create or invite user", "operationId": "userCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWriteRequest" } } } }, "responses": { "201": { "description": "Created user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "409": { "description": "Conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid user payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/users/{user}/avatar": { "get": { "tags": [ "Users" ], "summary": "Download user avatar", "operationId": "userAvatar", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Avatar image.", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Avatar not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "post": { "tags": [ "Users" ], "summary": "Upload user avatar", "operationId": "userUploadAvatar", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "201": { "description": "Updated user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "422": { "description": "Invalid avatar upload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Delete user avatar", "operationId": "userDeleteAvatar", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updated user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/timers/mine": { "get": { "tags": [ "Timers" ], "summary": "Current user timers", "operationId": "timerMine", "responses": { "200": { "description": "Current user timers.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Timer" } } } } } } } }, "/api/timers": { "get": { "tags": [ "Timers" ], "summary": "List timers", "operationId": "timerList", "responses": { "200": { "description": "Timers.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Timer" } } } } } } } }, "/api/timers/start": { "post": { "tags": [ "Timers" ], "summary": "Start timer", "operationId": "timerStart", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerWriteRequest" } } } }, "responses": { "201": { "description": "Started timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } }, "422": { "description": "Invalid timer payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/timers/stop": { "post": { "tags": [ "Timers" ], "summary": "Stop active timer", "operationId": "timerStop", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerStopRequest" } } } }, "responses": { "200": { "description": "Stopped timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerStopResponse" } } } }, "404": { "description": "No active timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/timers/{timer}/pause": { "post": { "tags": [ "Timers" ], "summary": "Pause timer", "operationId": "timerPause", "parameters": [ { "name": "timer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paused timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } } } } }, "/api/timers/{timer}/resume": { "post": { "tags": [ "Timers" ], "summary": "Resume timer", "operationId": "timerResume", "parameters": [ { "name": "timer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resumed timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Timer" } } } } } } }, "/api/timers/{timer}/stop": { "post": { "tags": [ "Timers" ], "summary": "Stop timer", "operationId": "timerStopOne", "parameters": [ { "name": "timer", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerStopRequest" } } } }, "responses": { "200": { "description": "Stopped timer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimerStopResponse" } } } } } } }, "/api/time-entries/mine": { "get": { "tags": [ "Time entries" ], "summary": "Current user time entries", "operationId": "timeEntryMine", "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string" } }, { "name": "end", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "overlap", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Time entries.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryReport" } } } } } } } }, "/api/time-entries": { "post": { "tags": [ "Time entries" ], "summary": "Create unticketed time entry", "operationId": "timeEntryCreateUnticketed", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryWriteRequest" } } } }, "responses": { "201": { "description": "Created time entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } }, "422": { "description": "Invalid time entry payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/tickets/{ticket}/time": { "get": { "tags": [ "Time entries" ], "summary": "List ticket time entries", "operationId": "timeEntryList", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket time entries.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "post": { "tags": [ "Time entries" ], "summary": "Create ticket time entry", "operationId": "timeEntryCreate", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryWriteRequest" } } } }, "responses": { "201": { "description": "Created time entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/api/tickets/{ticket}/time/{timeEntry}": { "delete": { "tags": [ "Time entries" ], "summary": "Delete ticket time entry", "operationId": "timeEntryDelete", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "timeEntry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted time entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/companies": { "get": { "tags": [ "Companies" ], "summary": "List companies", "operationId": "companyList", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Companies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyListResponse" } } } } } } }, "/api/companies/{company}/lifecycle": { "get": { "tags": [ "Companies" ], "summary": "Get retention, storage usage, quota, and deletion impact", "operationId": "companyLifecycle", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Company lifecycle settings and usage.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/companies/{company}/export": { "get": { "tags": [ "Companies" ], "summary": "Download a portable company JSON export", "operationId": "companyExport", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Company JSON export.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/companies/{company}/select": { "post": { "tags": [ "Companies" ], "summary": "Select current company", "operationId": "companySelect", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Selected company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/api/companies/by-slug/{slug}/select": { "post": { "tags": [ "Companies" ], "summary": "Select current company by slug", "operationId": "companySelectBySlug", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Selected company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/api/companies/{company}/members": { "get": { "tags": [ "Companies" ], "summary": "List company members", "operationId": "companyMembers", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "withTotal", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Company members.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UserPageResponse" }, { "type": "array", "items": { "$ref": "#/components/schemas/User" } } ] } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Add company member", "operationId": "companyAddMember", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMemberAddRequest" } } } }, "responses": { "200": { "description": "Added company member.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "202": { "description": "Company access invitation sent.", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean", "example": true }, "invited": { "type": "boolean", "example": true } }, "type": "object" } } } } } } }, "/api/companies/{company}/members/{user}": { "delete": { "tags": [ "Companies" ], "summary": "Remove company member", "operationId": "companyRemoveMember", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Removed company member.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/companies/{company}/logo": { "get": { "tags": [ "Companies" ], "summary": "Download company logo", "operationId": "companyLogo", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Company logo image.", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Logo not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Upload company logo", "operationId": "companyUploadLogo", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updated company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete company logo", "operationId": "companyDeleteLogo", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updated company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/api/tickets/{ticket}/comments": { "get": { "tags": [ "Comments" ], "summary": "List ticket comments", "operationId": "commentList", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket comments.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } } } } } }, "post": { "tags": [ "Comments" ], "summary": "Create ticket comment", "operationId": "commentCreate", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentWriteRequest" } } } }, "responses": { "201": { "description": "Created comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } } } } }, "/api/tickets/{ticket}/attachments": { "get": { "tags": [ "Attachments" ], "summary": "List ticket attachments", "operationId": "attachmentList", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket attachments.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } } } } } } }, "post": { "tags": [ "Attachments" ], "summary": "Upload ticket attachments", "operationId": "attachmentUpload", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object", "additionalProperties": true } } } }, "responses": { "201": { "description": "Uploaded attachment result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentUploadResponse" } } } }, "422": { "description": "Invalid upload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/projects/{project}/attachments": { "get": { "tags": [ "Attachments" ], "summary": "List and summarize project or board attachments", "operationId": "projectAttachmentList", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "board", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "all", "image", "document", "media", "archive", "other" ] } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "maximum": 100, "minimum": 10 } } ], "responses": { "200": { "description": "Paginated attachment inventory.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } } }, "/api/tickets/{ticket}/attachments/{attachment}": { "get": { "tags": [ "Attachments" ], "summary": "Download ticket attachment", "operationId": "attachmentDownload", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Attachment file.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Attachment not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Attachments" ], "summary": "Delete ticket attachment", "operationId": "attachmentDelete", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted attachment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/dashboard/board-issues": { "get": { "tags": [ "Dashboard" ], "summary": "Dashboard board issues", "operationId": "dashboardBoardIssues", "parameters": [ { "name": "boardId", "in": "query", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } }, { "name": "assignedUserId", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "hideCompleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Dashboard board issues.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardBoardIssuesResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/archive/projects": { "get": { "tags": [ "Archive" ], "summary": "Archived projects", "operationId": "archiveProjects", "responses": { "200": { "description": "Archived projects.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveProjectPageResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/archive/boards": { "get": { "tags": [ "Archive" ], "summary": "Archived boards", "operationId": "archiveBoards", "responses": { "200": { "description": "Archived boards.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveBoardPageResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/archive/tickets": { "get": { "tags": [ "Archive" ], "summary": "Archived tickets", "operationId": "archiveTickets", "responses": { "200": { "description": "Archived tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveTicketPageResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/projects": { "get": { "tags": [ "Projects" ], "summary": "List projects", "operationId": "projectList", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "includeSprints", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Projects.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ProjectPageResponse" }, { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } ] } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Create project", "operationId": "projectCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectWriteRequest" } } } }, "responses": { "201": { "description": "Created project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid project payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/projects/by-key/{key}": { "get": { "tags": [ "Projects" ], "summary": "Get project by key", "operationId": "projectGetByKey", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "board" ] } } ], "responses": { "200": { "description": "Project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "404": { "description": "Project not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/projects/{project}/insights": { "get": { "tags": [ "Projects" ], "summary": "Flow-based project insights", "description": "Reports lead and cycle time, cumulative flow, throughput, time in status, aging WIP, blocked time, sprint velocity, estimate accuracy, and release forecasts.", "operationId": "projectFlowInsights", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "query", "description": "Optional sprint identifier, or backlog for tickets without a sprint.", "schema": { "type": "string" } }, { "name": "days", "in": "query", "description": "Reporting window in days.", "schema": { "type": "integer", "default": 90, "maximum": 365, "minimum": 30 } }, { "name": "bucket", "in": "query", "description": "Throughput aggregation period.", "schema": { "type": "string", "default": "week", "enum": [ "week", "month" ] } } ], "responses": { "200": { "description": "Flow insights.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowInsightsResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Project or sprint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid reporting window or bucket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/projects/{project}/clone": { "post": { "tags": [ "Projects" ], "summary": "Clone project", "operationId": "projectClone", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCloneRequest" } } } }, "responses": { "201": { "description": "Cloned project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/{project}/archive": { "post": { "tags": [ "Projects" ], "summary": "Archive project", "operationId": "projectArchive", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Archived project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectArchiveResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/{project}/restore": { "post": { "tags": [ "Projects" ], "summary": "Restore project", "operationId": "projectRestore", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Restored project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectArchiveResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/releases": { "get": { "tags": [ "Planning" ], "summary": "List project releases for accessible projects in the current company", "operationId": "companyProjectReleaseList", "responses": { "200": { "description": "Project releases for accessible projects.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRelease" } } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/{project}/releases": { "get": { "tags": [ "Planning" ], "summary": "List project releases", "operationId": "projectReleaseList", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Project releases.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRelease" } } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Project not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "post": { "tags": [ "Planning" ], "summary": "Create project release", "operationId": "projectReleaseCreate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectReleaseWriteRequest" } } } }, "responses": { "201": { "description": "Created project release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRelease" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid release payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/projects/{project}/releases/{release}": { "delete": { "tags": [ "Planning" ], "summary": "Delete project release", "operationId": "projectReleaseDelete", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted project release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Release not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "patch": { "tags": [ "Planning" ], "summary": "Update project release", "operationId": "projectReleaseUpdate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectReleaseWriteRequest" } } } }, "responses": { "200": { "description": "Updated project release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRelease" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Release not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/projects/{project}/releases/{release}/boards": { "post": { "tags": [ "Planning" ], "summary": "Create a board from a project release and move selected tickets", "operationId": "projectReleaseBoardCreate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "release", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseBoardCreateRequest" } } } }, "responses": { "201": { "description": "Created board and moved tickets.", "content": { "application/json": { "schema": { "required": [ "board", "moved" ], "properties": { "board": { "$ref": "#/components/schemas/Sprint" }, "moved": { "type": "integer", "minimum": 1 }, "tickets": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } }, "type": "object" } } } }, "409": { "description": "Board conflict acknowledgement required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid board or ticket selection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/sprints/mine": { "get": { "tags": [ "Sprints" ], "summary": "Current user sprints", "operationId": "sprintMine", "responses": { "200": { "description": "Current user sprints.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sprint" } } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/projects/{project}/sprints": { "get": { "tags": [ "Sprints" ], "summary": "List project sprints", "operationId": "sprintList", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "withCounts", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Project sprints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardListResponse" } } } }, "404": { "description": "Project not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "post": { "tags": [ "Sprints" ], "summary": "Create sprint", "operationId": "sprintCreate", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintWriteRequest" } } } }, "responses": { "201": { "description": "Created sprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sprint" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid sprint payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/projects/{project}/sprints/order": { "patch": { "tags": [ "Sprints" ], "summary": "Reorder project sprint boards", "operationId": "sprintReorder", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintOrderRequest" } } } }, "responses": { "200": { "description": "Reordered sprint boards.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardListResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/{project}/sprints/{sprint}/archive": { "post": { "tags": [ "Sprints" ], "summary": "Archive sprint", "operationId": "sprintArchive", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Archived sprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintArchiveResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/{project}/sprints/{sprint}/restore": { "post": { "tags": [ "Sprints" ], "summary": "Restore sprint", "operationId": "sprintRestore", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Restored sprint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SprintArchiveResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/projects/{project}/sprints/{sprint}/burndown": { "get": { "tags": [ "Sprints" ], "summary": "Sprint burndown series", "operationId": "sprintBurndown", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sprint", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sprint burndown series.", "content": { "application/json": { "schema": { "properties": { "sprintId": { "type": "string" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "effectiveEndAt": { "type": "string", "format": "date-time" }, "totalPoints": { "type": "integer" }, "donePoints": { "type": "integer" }, "remainingPoints": { "type": "integer" }, "scopeChange": { "properties": { "netPoints": { "type": "integer" }, "addedPoints": { "type": "integer" }, "removedPoints": { "type": "integer" }, "changedPoints": { "type": "integer" }, "addedCount": { "type": "integer" }, "removedCount": { "type": "integer" }, "changedCount": { "type": "integer" } }, "type": "object" }, "series": { "type": "array", "items": { "properties": { "at": { "type": "string", "format": "date-time" }, "remaining": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Sprint not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Burndown unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/issuetypes": { "get": { "tags": [ "Issue types" ], "summary": "List issue types", "operationId": "issueTypeList", "parameters": [ { "name": "project", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Issue types.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssueType" } } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Issue types" ], "summary": "Create issue type", "operationId": "issueTypeCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeWriteRequest" } } } }, "responses": { "201": { "description": "Created issue type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueType" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid issue type payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/statuses": { "get": { "tags": [ "Statuses" ], "summary": "List statuses", "operationId": "statusList", "parameters": [ { "name": "project", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Statuses.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Statuses" ], "summary": "Create status", "operationId": "statusCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusWriteRequest" } } } }, "responses": { "201": { "description": "Created status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid status payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/tags": { "get": { "tags": [ "Tags" ], "summary": "List tags", "operationId": "tagList", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "usage", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "available", "in": "query", "schema": { "type": "boolean" } }, { "name": "ids", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tags.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Tags" ], "summary": "Create tag", "operationId": "tagCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagWriteRequest" } } } }, "responses": { "201": { "description": "Created tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/tags/order": { "post": { "tags": [ "Tags" ], "summary": "Reorder tags", "operationId": "tagReorder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagOrderRequest" } } } }, "responses": { "200": { "description": "Reordered tags.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/tags/{tag}/merge": { "post": { "tags": [ "Tags" ], "summary": "Merge tags", "operationId": "tagMerge", "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagMergeRequest" } } } }, "responses": { "200": { "description": "Merged tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagMergeResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/presets": { "get": { "tags": [ "Presets" ], "summary": "List presets", "operationId": "presetList", "responses": { "200": { "description": "Presets.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Preset" } } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Presets" ], "summary": "Create preset", "operationId": "presetCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetWriteRequest" } } } }, "responses": { "201": { "description": "Created preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Preset" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/presets/{preset}/apply": { "post": { "tags": [ "Presets" ], "summary": "Apply preset", "operationId": "presetApply", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetProjectRequest" } } } }, "responses": { "200": { "description": "Applied preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetApplyResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/presets/{preset}/sync-preview": { "post": { "tags": [ "Presets" ], "summary": "Preview preset sync", "operationId": "presetSyncPreview", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetProjectRequest" } } } }, "responses": { "200": { "description": "Preset sync preview.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetSyncPreviewResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/presets/{preset}/sync": { "post": { "tags": [ "Presets" ], "summary": "Sync preset", "operationId": "presetSync", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetProjectRequest" } } } }, "responses": { "200": { "description": "Synced preset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetSyncResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/presets/{preset}/sync-linked": { "post": { "tags": [ "Presets" ], "summary": "Sync linked projects for preset", "operationId": "presetSyncLinked", "parameters": [ { "name": "preset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Synced linked projects.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresetSyncResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/public/projects/{project}": { "get": { "tags": [ "Public" ], "summary": "Public project", "operationId": "publicProject", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBoardResponse" } } } }, "404": { "description": "Project not found or not public.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/public/projects/{project}/board": { "get": { "tags": [ "Public" ], "summary": "Public project board", "operationId": "publicProjectBoard", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public project board.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } }, "security": [] } }, "/api/public/boards/{board}": { "get": { "tags": [ "Public" ], "summary": "Public board info", "operationId": "publicBoardInfo", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public board info.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBoardResponse" } } } } }, "security": [] } }, "/api/public/boards/{board}/tickets": { "get": { "tags": [ "Public" ], "summary": "Public board tickets", "operationId": "publicBoardTickets", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public board tickets.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } }, "security": [] } }, "/api/public/tickets/{ticket}": { "get": { "tags": [ "Public" ], "summary": "Public ticket", "operationId": "publicTicket", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicTicket" } } } } }, "security": [] } }, "/api/public/tickets/{ticket}/comments": { "get": { "tags": [ "Public" ], "summary": "Public ticket comments", "operationId": "publicComments", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public ticket comments.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicComment" } } } } } }, "security": [] }, "post": { "tags": [ "Public" ], "summary": "Post public ticket comment", "operationId": "publicPostComment", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentWriteRequest" } } } }, "responses": { "201": { "description": "Created public comment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicComment" } } } }, "403": { "description": "Public comments disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [] } }, "/api/boards/{board}/export": { "get": { "tags": [ "Boards" ], "summary": "Export board CSV", "operationId": "boardExport", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "antflow", "jira" ] } } ], "responses": { "200": { "description": "Board export CSV.", "content": { "text/csv": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/boards/{board}/import": { "post": { "tags": [ "Boards" ], "summary": "Import board CSV", "operationId": "boardImport", "parameters": [ { "name": "board", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "antflow", "jira" ] } }, { "name": "preview", "in": "query", "description": "Set to 1 to validate the CSV and return row counts and diagnostics without creating tickets.", "schema": { "type": "integer", "default": 0, "enum": [ 0, 1 ] } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "CSV preflight result when preview=1.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardImportPreviewResponse" } } } }, "201": { "description": "Board import result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardImportResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid CSV import.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/auth/login/companies/{slug}/logo": { "get": { "tags": [ "Authentication" ], "summary": "Download public company login logo", "operationId": "authLoginCompanyLogo", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Company login logo image.", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Company or logo not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/chat/messages/{message}/attachments/{attachment}": { "get": { "tags": [ "Chat" ], "summary": "Download chat attachment", "operationId": "chatAttachmentDownload", "parameters": [ { "name": "message", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Chat attachment file.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Attachment not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/public/tickets/{ticket}/attachments/{attachment}": { "get": { "tags": [ "Public" ], "summary": "Download public ticket attachment", "operationId": "publicAttachmentDownload", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Public attachment file.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Attachment not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [] } }, "/api/webhooks/{company}/development": { "post": { "tags": [ "Webhooks" ], "summary": "Development webhook", "operationId": "developmentWebhook", "parameters": [ { "name": "company", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevelopmentWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevelopmentWebhookResponse" } } } }, "403": { "description": "Invalid webhook secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [] } }, "/api/webhooks/by-slug/{slug}/development": { "post": { "tags": [ "Webhooks" ], "summary": "Development webhook by company slug", "operationId": "developmentWebhookBySlug", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevelopmentWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevelopmentWebhookResponse" } } } }, "403": { "description": "Invalid webhook secret.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [] } }, "/api/tickets/search/views": { "get": { "tags": [ "Search" ], "summary": "List visible saved ticket search views", "operationId": "savedTicketViewList", "responses": { "200": { "description": "Personal and accessible project-shared views.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketViewListResponse" } } } }, "403": { "description": "No authenticated current-company scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "post": { "tags": [ "Search" ], "summary": "Create a saved ticket search view", "operationId": "savedTicketViewCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketViewCreateRequest" } } } }, "responses": { "201": { "description": "Created saved view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketView" } } } }, "403": { "description": "Project-shared view creation is not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "409": { "description": "View limit or name conflict.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "422": { "description": "Invalid saved-view payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/tickets/search/views/{savedView}": { "get": { "tags": [ "Search" ], "summary": "Get a saved ticket search view", "operationId": "savedTicketViewGet", "parameters": [ { "name": "savedView", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Saved view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketView" } } } }, "404": { "description": "Saved view not found or not visible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "delete": { "tags": [ "Search" ], "summary": "Delete a saved ticket search view", "operationId": "savedTicketViewDelete", "parameters": [ { "name": "savedView", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Saved view deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketViewDeleteResponse" } } } }, "403": { "description": "The visible saved view cannot be deleted by the current user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Saved view not found or not visible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "patch": { "tags": [ "Search" ], "summary": "Update a saved ticket search view", "operationId": "savedTicketViewUpdate", "parameters": [ { "name": "savedView", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketViewUpdateRequest" } } } }, "responses": { "200": { "description": "Updated saved view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedTicketView" } } } }, "403": { "description": "The visible saved view cannot be updated by the current user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Saved view not found or not visible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "A view with this name already exists in the scope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid payload or attempted scope change.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/settings": { "get": { "tags": [ "Settings" ], "summary": "Public client settings", "description": "Returns branding, language and realtime connection settings used to bootstrap the frontend.", "operationId": "getSettings", "responses": { "200": { "description": "Public client settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsResponse" } } } } }, "security": [] } }, "/api/tickets": { "get": { "tags": [ "Tickets" ], "summary": "List tickets", "operationId": "ticketList", "parameters": [ { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "sprint", "in": "query", "schema": { "type": "string" } }, { "name": "release", "in": "query", "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "view", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketListResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Create ticket", "operationId": "ticketCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketWriteRequest" } } } }, "responses": { "201": { "description": "Created ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "422": { "description": "Invalid ticket payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/tickets/summary": { "get": { "tags": [ "Tickets" ], "summary": "Ticket summary", "operationId": "ticketSummary", "parameters": [ { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "sprint", "in": "query", "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSummaryStatsResponse" } } } } } } }, "/api/tickets/candidates": { "get": { "tags": [ "Tickets" ], "summary": "Ticket candidates", "operationId": "ticketCandidates", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "excludeIds", "in": "query", "schema": { "type": "string" } }, { "name": "excludeDescendantsOfIds", "in": "query", "schema": { "type": "string" } }, { "name": "issueTypeIds", "in": "query", "schema": { "type": "string" } }, { "name": "withoutParent", "in": "query", "schema": { "type": "boolean" } }, { "name": "withoutEpic", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ticket candidates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketCandidatesResponse" } } } } } } }, "/api/tickets/search": { "get": { "tags": [ "Search" ], "summary": "Search tickets", "operationId": "ticketSearch", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "searchMode", "in": "query", "schema": { "type": "string" } }, { "name": "semanticMode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket search results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSearchResponse" } } } } } } }, "/api/tickets/search/conversation": { "post": { "tags": [ "Search" ], "summary": "Search conversation", "operationId": "searchConversation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchConversationRequest" } } } }, "responses": { "200": { "description": "Search conversation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchConversationResponse" } } } } } } }, "/api/tickets/search/conversation/ticket-drafts": { "post": { "tags": [ "Search" ], "summary": "Draft ticket creation from conversation", "operationId": "searchTicketDrafts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketDraftsRequest" } } } }, "responses": { "200": { "description": "Ticket draft result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketDraftsResponse" } } } } } } }, "/api/tickets/search/conversation/stream": { "post": { "tags": [ "Search" ], "summary": "Stream search conversation", "operationId": "searchConversationStream", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchConversationRequest" } } } }, "responses": { "200": { "description": "Server-sent event stream.", "content": { "text/event-stream": { "schema": { "type": "string" } } } } } } }, "/api/tickets/mine": { "get": { "tags": [ "Tickets" ], "summary": "Current user tickets", "operationId": "ticketMine", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "tableFilters", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current user tickets.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TicketPagedResponse" }, { "$ref": "#/components/schemas/TicketListResponse" } ] } } } } } } }, "/api/tickets/reported": { "get": { "tags": [ "Tickets" ], "summary": "Reported tickets", "operationId": "ticketReported", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "tableFilters", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reported tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketPagedResponse" } } } } } } }, "/api/tickets/watched": { "get": { "tags": [ "Tickets" ], "summary": "Watched tickets", "operationId": "ticketWatched", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "tableFilters", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Watched tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketPagedResponse" } } } } } } }, "/api/tickets/activity": { "get": { "tags": [ "Tickets" ], "summary": "Recent ticket activity", "operationId": "ticketLastActions", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "mode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recent ticket activity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketActivityListResponse" } } } } } } }, "/api/tickets/by-key/{key}": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket by key", "operationId": "ticketGetByKey", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "404": { "description": "Ticket not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/tickets/{ticket}": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket", "operationId": "ticketGet", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "404": { "description": "Ticket not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "put": { "tags": [ "Tickets" ], "summary": "Update ticket", "operationId": "ticketUpdate", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketWriteRequest" } } } }, "responses": { "200": { "description": "Updated ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid ticket payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Delete ticket", "operationId": "ticketDelete", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cascadeChildren", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Deleted ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } } }, "/api/tickets/{ticket}/details": { "get": { "tags": [ "Tickets" ], "summary": "Ticket details", "operationId": "ticketDetails", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeIssueTypes", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ticket details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketDetailsResponse" } } } } } } }, "/api/tickets/{ticket}/activity": { "get": { "tags": [ "Tickets" ], "summary": "Ticket activity", "operationId": "ticketActivity", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "Ticket activity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketActivityListResponse" } } } } } } }, "/api/tickets/{ticket}/status": { "patch": { "tags": [ "Tickets" ], "summary": "Update ticket status", "operationId": "ticketUpdateStatus", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketStatusUpdateRequest" } } } }, "responses": { "200": { "description": "Updated ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/api/tickets/{ticket}/impediment": { "patch": { "tags": [ "Tickets" ], "summary": "Set or resolve a manual ticket impediment", "operationId": "ticketUpdateImpediment", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketImpedimentUpdateRequest" } } } }, "responses": { "200": { "description": "Updated ticket impediment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "409": { "description": "Ticket revision conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Invalid impediment payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/tickets/{ticket}/archive": { "post": { "tags": [ "Tickets" ], "summary": "Archive ticket", "operationId": "ticketArchive", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketArchiveRequest" } } } }, "responses": { "200": { "description": "Archived ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketActionResponse" } } } } } } }, "/api/tickets/{ticket}/restore": { "post": { "tags": [ "Tickets" ], "summary": "Restore ticket", "operationId": "ticketRestore", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Restored ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketActionResponse" } } } } } } }, "/api/tickets/{ticket}/watchers/me": { "post": { "tags": [ "Tickets" ], "summary": "Watch ticket", "operationId": "ticketWatch", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Watching ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Unwatch ticket", "operationId": "ticketUnwatch", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Unwatched ticket.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/api/tickets/{ticket}/reminder": { "put": { "tags": [ "Tickets" ], "summary": "Set ticket reminder", "operationId": "ticketSetReminder", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketReminderRequest" } } } }, "responses": { "200": { "description": "Updated reminder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Clear ticket reminder", "operationId": "ticketClearReminder", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cleared reminder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/api/tickets/board-order": { "patch": { "tags": [ "Tickets" ], "summary": "Batch update ticket board order", "operationId": "ticketBatchBoardOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBoardOrderRequest" } } } }, "responses": { "200": { "description": "Updated ticket board order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } } }, "/api/tickets/assign": { "patch": { "tags": [ "Tickets" ], "summary": "Batch assign tickets", "operationId": "ticketBatchAssign", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchAssignRequest" } } } }, "responses": { "200": { "description": "Assigned tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } } } } }, "/api/tickets/release": { "patch": { "tags": [ "Tickets" ], "summary": "Batch assign tickets to a release", "operationId": "ticketBatchRelease", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchReleaseRequest" } } } }, "responses": { "200": { "description": "Updated ticket releases.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } }, "422": { "description": "Invalid release assignment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/tickets/batch": { "patch": { "tags": [ "Tickets" ], "summary": "Batch update tickets", "operationId": "ticketBatchUpdate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchUpdateRequest" } } } }, "responses": { "200": { "description": "Updated tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } } } } }, "/api/tickets/copy": { "post": { "tags": [ "Tickets" ], "summary": "Batch copy tickets", "operationId": "ticketBatchCopy", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketCopyRequest" } } } }, "responses": { "200": { "description": "Copied tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } } } } }, "/api/tickets/archive": { "post": { "tags": [ "Tickets" ], "summary": "Batch archive tickets", "operationId": "ticketBatchArchive", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchIdsRequest" } } } }, "responses": { "200": { "description": "Archived tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } } } } }, "/api/tickets/restore": { "post": { "tags": [ "Tickets" ], "summary": "Batch restore tickets", "operationId": "ticketBatchRestore", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchIdsRequest" } } } }, "responses": { "200": { "description": "Restored tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } } } } }, "/api/tickets/delete": { "post": { "tags": [ "Tickets" ], "summary": "Batch delete tickets", "operationId": "ticketBatchDelete", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchIdsRequest" } } } }, "responses": { "200": { "description": "Deleted tickets.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBatchResponse" } } } } } } }, "/api/tickets/{ticket}/relations": { "get": { "tags": [ "Ticket relations" ], "summary": "List ticket relations", "operationId": "ticketRelationList", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket relations.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketRelation" } } } } } } } }, "/api/tickets/{ticket}/relations/to/{targetTicket}": { "post": { "tags": [ "Ticket relations" ], "summary": "Create ticket relation", "operationId": "ticketRelationCreate", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "targetTicket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketRelationCreateRequest" } } } }, "responses": { "201": { "description": "Created relation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketRelation" } } } } } } }, "/api/tickets/{ticket}/relations/{ticketRelation}": { "delete": { "tags": [ "Ticket relations" ], "summary": "Delete ticket relation", "operationId": "ticketRelationDelete", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketRelation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted relation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResponse" } } } } } } }, "/api/ticket-templates": { "get": { "tags": [ "Ticket templates" ], "summary": "List company and project ticket templates", "operationId": "ticketTemplateLibraryList", "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Visible template library.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "post": { "tags": [ "Ticket templates" ], "summary": "Create a template or snapshot a board", "operationId": "ticketTemplateLibraryCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "201": { "description": "Version-one template snapshot.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "422": { "description": "Invalid template or board snapshot.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/ticket-templates/{ticketTemplate}": { "get": { "tags": [ "Ticket templates" ], "summary": "Get a ticket template", "operationId": "ticketTemplateLibraryGet", "parameters": [ { "name": "ticketTemplate", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Template snapshot.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "delete": { "tags": [ "Ticket templates" ], "summary": "Delete a template without changing created tickets", "operationId": "ticketTemplateLibraryDelete", "parameters": [ { "name": "ticketTemplate", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Template deleted.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "patch": { "tags": [ "Ticket templates" ], "summary": "Safely update a template and increment its snapshot version", "operationId": "ticketTemplateLibraryUpdate", "parameters": [ { "name": "ticketTemplate", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Updated template.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } } }, "/api/ticket-templates/{ticketTemplate}/instantiate": { "post": { "tags": [ "Ticket templates" ], "summary": "Create a ticket tree from an immutable template snapshot", "operationId": "ticketTemplateLibraryInstantiate", "parameters": [ { "name": "ticketTemplate", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "projectId" ], "properties": { "projectId": { "type": "string" }, "sprintId": { "type": [ "string", "null" ] } }, "type": "object" } } } }, "responses": { "201": { "description": "Created ticket identifiers and compatibility warnings.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "422": { "description": "The snapshot cannot be mapped to the target project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/ticket-templates/{ticketTemplate}/instantiate-board": { "post": { "tags": [ "Ticket templates" ], "summary": "Create a new board and populate it from a template snapshot", "operationId": "ticketTemplateLibraryInstantiateBoard", "parameters": [ { "name": "ticketTemplate", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "projectId", "title" ], "properties": { "projectId": { "type": "string" }, "title": { "type": "string", "maxLength": 160 }, "sprintBoard": { "type": "boolean" }, "startDate": { "type": [ "string", "null" ], "format": "date" }, "endDate": { "type": [ "string", "null" ], "format": "date" }, "definitionOfDone": { "type": [ "string", "null" ] } }, "type": "object" } } } }, "responses": { "201": { "description": "Created board and template tickets.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "403": { "description": "Manager access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "The board or template cannot be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/user-groups": { "get": { "tags": [ "User groups" ], "summary": "List user groups", "description": "Returns current-company user groups. With page, offset, or withTotal set, the response is paged; otherwise it is a compact array for lookup controls.", "operationId": "userGroupList", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 100, "minimum": 1 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "withTotal", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "selectedGroupId", "in": "query", "schema": { "type": "string" } }, { "name": "selectedGroupIds", "in": "query", "description": "Comma-separated group ids to force into lookup results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "User group list.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UserGroupListResponse" }, { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResponse" } } ] } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Insufficient user-directory permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } } }, "post": { "tags": [ "User groups" ], "summary": "Create a user group", "operationId": "userGroupCreate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupWriteRequest" } } } }, "responses": { "201": { "description": "Created user group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Current-company administrator access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "Invalid user group payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/api/user-groups/{group}": { "get": { "tags": [ "User groups" ], "summary": "Get a user group", "operationId": "userGroupGet", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Insufficient user-directory permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "User group not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } }, "put": { "tags": [ "User groups" ], "summary": "Update a user group", "operationId": "userGroupReplace", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupWriteRequest" } } } }, "responses": { "200": { "description": "Updated user group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Current-company administrator access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "User group not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid user group payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } }, "delete": { "tags": [ "User groups" ], "summary": "Archive or permanently delete a user group", "operationId": "userGroupDelete", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "permanent", "in": "query", "description": "Permanently delete an already archived group.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "User group archived or deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupDeleteResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Current-company administrator access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "User group not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "409": { "description": "Permanent delete requires the group to be archived first.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } } } }, "patch": { "tags": [ "User groups" ], "summary": "Update a user group", "operationId": "userGroupUpdate", "parameters": [ { "name": "group", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupWriteRequest" } } } }, "responses": { "200": { "description": "Updated user group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupResponse" } } } }, "401": { "description": "Not authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Current-company administrator access required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "User group not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid user group payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } } }, "components": { "schemas": { "AiChatSettings": { "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "AuthAcceptInvitationRequest": { "properties": { "displayName": { "type": "string", "example": "Ada Lovelace" }, "password": { "description": "Must satisfy the configured password policy. See /api/auth/password-policy.", "type": "string", "format": "password" } }, "type": "object" }, "AuthChangePasswordRequest": { "required": [ "currentPassword", "newPassword" ], "properties": { "currentPassword": { "type": "string", "format": "password" }, "newPassword": { "description": "Must satisfy the configured password policy. See /api/auth/password-policy.", "type": "string", "format": "password" } }, "type": "object" }, "AuthCodeRequest": { "required": [ "code" ], "properties": { "code": { "type": "string", "example": "123456" } }, "type": "object" }, "AuthCompanySummary": { "required": [ "id", "name", "slug" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": "string", "example": "Acme Inc." }, "slug": { "type": "string", "example": "acme" }, "description": { "type": [ "string", "null" ] }, "hasLogo": { "type": "boolean" }, "logoUrl": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "AuthDisableTwoFactorRequest": { "required": [ "password", "code" ], "properties": { "password": { "type": "string", "format": "password" }, "code": { "type": "string", "example": "123456" } }, "type": "object" }, "AuthEmailChangeResponse": { "required": [ "currentEmail", "pendingEmail", "displayName" ], "properties": { "currentEmail": { "type": "string", "format": "email" }, "pendingEmail": { "type": [ "string", "null" ], "format": "email" }, "displayName": { "type": "string" }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "AuthEmailRequest": { "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "user@example.com" } }, "type": "object" }, "AuthInvitationResponse": { "required": [ "mode", "requiresPassword", "email", "displayName", "company" ], "properties": { "mode": { "type": "string", "enum": [ "companyAccess", "accountSetup" ] }, "requiresPassword": { "type": "boolean" }, "email": { "type": "string", "format": "email" }, "displayName": { "type": "string" }, "company": { "oneOf": [ { "$ref": "#/components/schemas/AuthCompanySummary" }, { "type": "null" } ] }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "AuthLoginDiscoveryRequest": { "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "user@example.com" }, "companySlug": { "description": "Optional company context derived from the requested tenant URL.", "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "AuthLoginDiscoveryResponse": { "required": [ "requiresCompanySelection", "company", "companies", "passwordLoginEnabled", "passkeyAvailable", "providers" ], "properties": { "requiresCompanySelection": { "type": "boolean" }, "company": { "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "logoUrl": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "companies": { "type": "array", "items": { "required": [ "slug", "name" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "logoUrl": { "type": [ "string", "null" ] } }, "type": "object" } }, "passwordLoginEnabled": { "type": "boolean" }, "passkeyAvailable": { "type": "boolean" }, "providers": { "type": "array", "items": { "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "type": "object", "additionalProperties": false }, "AuthLoginRequest": { "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email", "example": "user@example.com" }, "password": { "type": "string", "format": "password", "minLength": 1 }, "companySlug": { "description": "Optional company context used to apply the correct tenant login policy.", "type": "string" } }, "type": "object" }, "AuthPasswordRequest": { "required": [ "password" ], "properties": { "password": { "description": "Must satisfy the configured password policy. See /api/auth/password-policy.", "type": "string", "format": "password" } }, "type": "object" }, "AuthPasswordResetResponse": { "required": [ "email", "displayName" ], "properties": { "email": { "type": "string", "format": "email" }, "displayName": { "type": "string" }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object" }, "AuthSessionResponse": { "properties": { "authenticated": { "type": "boolean", "example": true }, "twoFactorRequired": { "type": "boolean", "example": false }, "csrfToken": { "type": "string" }, "user": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "isSuperAdmin": { "type": "boolean" }, "isAdmin": { "type": "boolean" }, "isManager": { "type": "boolean" }, "isReporter": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "AuthTwoFactorSetupConfirmedResponse": { "allOf": [ { "$ref": "#/components/schemas/AuthTwoFactorStatusResponse" }, { "required": [ "recoveryCodes" ], "properties": { "recoveryCodes": { "type": "array", "items": { "type": "string" } } }, "type": "object" } ] }, "AuthTwoFactorSetupResponse": { "required": [ "secret", "otpauthUri" ], "properties": { "secret": { "type": "string" }, "otpauthUri": { "type": "string" }, "qrCodeDataUri": { "type": "string" } }, "type": "object", "additionalProperties": false }, "AuthTwoFactorStatusResponse": { "required": [ "enabled", "recoveryCodeCount" ], "properties": { "enabled": { "type": "boolean" }, "enabledAt": { "type": [ "string", "null" ], "format": "date-time" }, "recoveryCodeCount": { "type": "integer", "minimum": 0 } }, "type": "object" }, "OkResponse": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "example": true } }, "type": "object" }, "BrandingSettings": { "description": "Branding assets and display names used by the client.", "required": [ "name", "logoUrl", "iconUrl", "notificationAudio" ], "properties": { "name": { "type": "string", "example": "AntFlow" }, "logoUrl": { "type": "string", "example": "/assets/logo.svg" }, "iconUrl": { "type": "string", "example": "/assets/icon.svg" }, "notificationAudio": { "$ref": "#/components/schemas/NotificationAudioSettings" } }, "type": "object" }, "CalendarSummary": { "required": [ "id", "name", "startYear", "startMonth", "numberOfMonths", "sortOrder", "showSprintsRing", "showReleasesRing", "publicEnabled" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "startYear": { "type": "integer", "maximum": 2200, "minimum": 1970 }, "startMonth": { "type": "integer", "maximum": 12, "minimum": 1 }, "numberOfMonths": { "type": "integer", "maximum": 36, "minimum": 1 }, "sortOrder": { "type": "integer", "minimum": 0 }, "showSprintsRing": { "type": "boolean" }, "showReleasesRing": { "type": "boolean" }, "ringOrder": { "type": "array", "items": { "type": "string" } }, "displaySettings": { "$ref": "#/components/schemas/CalendarDisplaySettings" }, "publicEnabled": { "type": "boolean" }, "publicToken": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "Calendar": { "allOf": [ { "$ref": "#/components/schemas/CalendarSummary" }, { "required": [ "rings" ], "properties": { "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "rings": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarRing" } } }, "type": "object" } ] }, "CalendarDisplaySettings": { "required": [ "defaultView", "segmentUnit", "sameRingHeight", "showRingHeaders", "showEventLabels", "showMonthNames", "showWeekNumbers", "showDayNumbers", "showQuarters", "showMonthYear", "firstDayOfWeek", "splitSprintsByGroup", "generatedRings" ], "properties": { "defaultView": { "type": "string", "enum": [ "disc", "calendar", "linear" ] }, "segmentUnit": { "type": "string", "enum": [ "day", "week", "month", "quarter" ] }, "sameRingHeight": { "type": "boolean" }, "showRingHeaders": { "type": "boolean" }, "showEventLabels": { "type": "boolean" }, "showMonthNames": { "type": "boolean" }, "showWeekNumbers": { "type": "boolean" }, "showDayNumbers": { "type": "boolean" }, "showQuarters": { "type": "boolean" }, "showMonthYear": { "type": "boolean" }, "firstDayOfWeek": { "type": "integer", "maximum": 6, "minimum": 0 }, "splitSprintsByGroup": { "type": "boolean" }, "generatedRings": { "$ref": "#/components/schemas/CalendarGeneratedRingsDisplaySettings" } }, "type": "object", "additionalProperties": false }, "CalendarGeneratedRingsDisplaySettings": { "required": [ "sprints", "releases" ], "properties": { "sprints": { "$ref": "#/components/schemas/CalendarGeneratedRingDisplaySettings" }, "releases": { "$ref": "#/components/schemas/CalendarGeneratedRingDisplaySettings" } }, "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CalendarGeneratedRingDisplaySettings" } }, "CalendarGeneratedRingDisplaySettings": { "required": [ "color", "foregroundColor", "size", "visibleByDefault" ], "properties": { "color": { "type": "string" }, "foregroundColor": { "type": [ "string", "null" ] }, "size": { "type": "string", "enum": [ "small", "normal", "large" ] }, "visibleByDefault": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "CalendarRing": { "required": [ "id", "name", "generated", "visibleByDefault", "sortOrder", "color", "size", "sources", "events" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sourceType": { "type": "string", "enum": [ "mixed" ] }, "generated": { "type": "boolean" }, "visibleByDefault": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "color": { "type": "string" }, "size": { "type": "string", "enum": [ "small", "normal", "large" ] }, "foregroundColor": { "type": [ "string", "null" ] }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarSource" } }, "createdAt": { "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } } }, "type": "object", "additionalProperties": false }, "CalendarSource": { "required": [ "id", "ringId", "name", "sourceType", "generated", "sortOrder", "color", "events" ], "properties": { "id": { "type": "string" }, "ringId": { "type": "string" }, "name": { "type": "string" }, "sourceType": { "type": "string", "enum": [ "sprints", "releases", "custom", "team", "ical" ] }, "generated": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "color": { "type": "string" }, "ringColor": { "type": "string" }, "useAsNoWorkTime": { "type": "boolean" }, "showDayBadges": { "type": "boolean" }, "teamGroup": { "oneOf": [ { "$ref": "#/components/schemas/UserGroupSummary" }, { "type": "null" } ] }, "icalUrl": { "type": [ "string", "null" ] }, "icalLastSyncedAt": { "type": [ "string", "null" ], "format": "date-time" }, "icalSyncError": { "type": [ "string", "null" ] }, "createdAt": { "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } } }, "type": "object", "additionalProperties": false }, "CalendarEvent": { "required": [ "id", "sourceType", "title", "startDate", "endDate", "color" ], "properties": { "id": { "type": "string" }, "seriesEventId": { "type": [ "string", "null" ] }, "sourceType": { "type": "string", "enum": [ "custom", "ical", "sprint", "release" ] }, "sourceId": { "type": [ "string", "null" ] }, "calendarSourceId": { "type": [ "string", "null" ] }, "externalUid": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "seriesStartDate": { "type": [ "string", "null" ], "format": "date" }, "seriesEndDate": { "type": [ "string", "null" ], "format": "date" }, "color": { "type": "string" }, "foregroundColor": { "type": [ "string", "null" ] }, "ringId": { "type": [ "string", "null" ] }, "recurrenceFrequency": { "type": [ "string", "null" ], "enum": [ "daily", "weekly", "monthly", "yearly" ] }, "recurrenceInterval": { "type": [ "integer", "null" ], "maximum": 99, "minimum": 1 }, "recurrenceUntilDate": { "type": [ "string", "null" ], "format": "date" }, "recurrenceCount": { "type": [ "integer", "null" ], "maximum": 999, "minimum": 1 }, "recurrenceOccurrence": { "type": [ "integer", "null" ], "minimum": 1 }, "status": { "type": [ "string", "null" ] }, "project": { "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": [ "object", "null" ] }, "createdAt": { "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object", "additionalProperties": true }, "CalendarWriteRequest": { "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 160 }, "description": { "type": [ "string", "null" ] }, "startYear": { "type": "integer", "maximum": 2200, "minimum": 1970 }, "startMonth": { "type": "integer", "maximum": 12, "minimum": 1 }, "numberOfMonths": { "type": "integer", "maximum": 36, "minimum": 1 }, "showSprintsRing": { "type": "boolean" }, "showReleasesRing": { "type": "boolean" }, "ringOrder": { "type": "array", "items": { "type": "string" } }, "displaySettings": { "$ref": "#/components/schemas/CalendarDisplaySettings" } }, "type": "object", "additionalProperties": false }, "CalendarReorderRequest": { "required": [ "calendarIds" ], "properties": { "calendarIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "CalendarShareRequest": { "properties": { "publicEnabled": { "type": "boolean" }, "rotateToken": { "type": "boolean" }, "clearToken": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "CalendarRingWriteRequest": { "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 160 }, "color": { "type": [ "string", "null" ] }, "size": { "type": "string", "enum": [ "small", "normal", "large" ] }, "visibleByDefault": { "type": "boolean" }, "sortOrder": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "CalendarSourceWriteRequest": { "required": [ "name", "sourceType" ], "properties": { "name": { "type": "string", "maxLength": 160 }, "sourceType": { "type": "string", "enum": [ "custom", "team", "ical", "sprints", "releases" ] }, "color": { "type": [ "string", "null" ] }, "useAsNoWorkTime": { "type": "boolean" }, "showDayBadges": { "type": "boolean" }, "sortOrder": { "type": "integer", "minimum": 0 }, "teamGroupId": { "type": [ "string", "null" ] }, "icalUrl": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "CalendarEventWriteRequest": { "required": [ "title", "startDate" ], "properties": { "title": { "type": "string", "maxLength": 220 }, "description": { "type": [ "string", "null" ] }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "color": { "type": [ "string", "null" ] }, "recurrenceFrequency": { "type": [ "string", "null" ], "enum": [ "daily", "weekly", "monthly", "yearly" ] }, "recurrenceInterval": { "type": [ "integer", "null" ], "maximum": 99, "minimum": 1 }, "recurrenceUntilDate": { "type": [ "string", "null" ], "format": "date" }, "recurrenceCount": { "type": [ "integer", "null" ], "maximum": 999, "minimum": 1 } }, "type": "object", "additionalProperties": false }, "CalendarSyncResponse": { "required": [ "imported", "calendar" ], "properties": { "imported": { "type": "integer", "minimum": 0 }, "calendar": { "$ref": "#/components/schemas/Calendar" } }, "type": "object", "additionalProperties": false }, "ConflictResponse": { "description": "The request conflicts with the current resource state.", "required": [ "error" ], "properties": { "error": { "description": "Machine-readable or human-readable error message.", "type": "string", "example": "conflict" }, "code": { "description": "Stable machine-readable error code.", "type": [ "string", "null" ], "example": "owned_company_limit_reached" }, "message": { "description": "Optional client-displayable message.", "type": [ "string", "null" ], "example": "You have reached the limit for companies you can create yourself." } }, "type": "object", "additionalProperties": false }, "DocsElement": { "required": [ "type" ], "properties": { "type": { "type": "string", "example": "rte" }, "document": { "type": [ "object", "null" ], "additionalProperties": true }, "content": [], "data": { "type": [ "object", "null" ], "additionalProperties": true } }, "type": "object", "additionalProperties": true }, "DocsBreadcrumb": { "required": [ "id", "title", "visibility" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "projectId": { "type": [ "string", "null" ] }, "projectKey": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "DocsPermissionOption": { "required": [ "id", "label" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "type": "object", "additionalProperties": false }, "DocsEffectivePermission": { "required": [ "mode", "groupIds", "roleIds", "inherited", "restricted" ], "properties": { "mode": { "type": "string", "enum": [ "inherit", "everyone", "project_members", "restricted" ] }, "groupIds": { "type": "array", "items": { "type": "string" } }, "roleIds": { "type": "array", "items": { "type": "string" } }, "inherited": { "type": "boolean" }, "sourcePageId": { "type": [ "string", "null" ] }, "restricted": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "DocsPermissionSummary": { "required": [ "mode", "restricted", "inherited", "groupCount", "roleCount", "projectMembers", "visibility" ], "properties": { "mode": { "type": "string", "enum": [ "inherit", "everyone", "project_members", "restricted" ] }, "restricted": { "type": "boolean" }, "inherited": { "type": "boolean" }, "groupCount": { "type": "integer", "minimum": 0 }, "roleCount": { "type": "integer", "minimum": 0 }, "projectMembers": { "type": "boolean" }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPermissionOption" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPermissionOption" } }, "sourcePageId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "DocsPermissions": { "required": [ "mode", "groupIds", "roleIds", "effective", "summary" ], "properties": { "mode": { "type": "string", "enum": [ "inherit", "everyone", "project_members", "restricted" ] }, "groupIds": { "type": "array", "items": { "type": "string" } }, "roleIds": { "type": "array", "items": { "type": "string" } }, "effective": { "$ref": "#/components/schemas/DocsEffectivePermission" }, "summary": { "$ref": "#/components/schemas/DocsPermissionSummary" }, "affectedSubpageCount": { "type": "integer", "minimum": 0 }, "options": { "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupSummary" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPermissionOption" } }, "canAssignRoles": { "type": "boolean" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "DocsAsset": { "required": [ "id", "pageId", "filename", "mediaType", "fileSize", "isImage", "createdAt", "url" ], "properties": { "id": { "type": [ "string", "null" ] }, "pageId": { "type": [ "string", "null" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "fileSize": { "type": "integer", "minimum": 0 }, "isImage": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "uploader": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "url": { "type": "string" } }, "type": "object", "additionalProperties": false }, "DocsWhiteboardScene": { "required": [ "elements", "appState", "files" ], "properties": { "elements": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "appState": { "type": "object", "additionalProperties": true }, "files": { "type": "object", "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "DocsPage": { "required": [ "id", "title", "slug", "visibility", "pageType", "sortOrder", "currentVersion", "createdAt", "updatedAt", "canEdit", "canManagePermissions", "permissions", "hasChildren", "viewCount" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "slug": { "type": "string" }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "pageType": { "type": "string", "enum": [ "document", "whiteboard" ] }, "companyId": { "type": [ "string", "null" ] }, "projectId": { "type": [ "string", "null" ] }, "projectKey": { "type": [ "string", "null" ] }, "projectName": { "type": [ "string", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "ownerId": { "type": [ "string", "null" ] }, "sortOrder": { "type": "integer" }, "currentVersion": { "type": "integer", "minimum": 1 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdBy": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "updatedBy": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "canEdit": { "type": "boolean" }, "canManagePermissions": { "type": "boolean" }, "permissions": { "$ref": "#/components/schemas/DocsPermissions" }, "hasChildren": { "type": "boolean" }, "viewCount": { "type": "integer", "minimum": 0 }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/DocsElement" } }, "metadata": { "type": "object", "additionalProperties": true }, "realtimeChannel": { "type": [ "string", "null" ] }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/DocsAsset" } }, "breadcrumbs": { "type": "array", "items": { "$ref": "#/components/schemas/DocsBreadcrumb" } }, "depth": { "type": "integer", "minimum": 0 }, "favorite": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "DocsPageTreeNode": { "allOf": [ { "$ref": "#/components/schemas/DocsPage" }, { "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageTreeNode" } } }, "type": "object" } ] }, "DocsPageSummary": { "required": [ "id", "title", "visibility", "viewCount", "breadcrumbs" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "projectId": { "type": [ "string", "null" ] }, "projectKey": { "type": [ "string", "null" ] }, "projectName": { "type": [ "string", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "viewCount": { "type": "integer", "minimum": 0 }, "breadcrumbs": { "type": "array", "items": { "$ref": "#/components/schemas/DocsBreadcrumb" } }, "favorite": { "type": "boolean" }, "lastViewedAt": { "type": [ "string", "null" ], "format": "date-time" }, "favoritedAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object", "additionalProperties": false }, "DocsPageLink": { "required": [ "id", "title", "visibility" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "projectId": { "type": [ "string", "null" ] }, "projectKey": { "type": [ "string", "null" ] }, "projectName": { "type": [ "string", "null" ] }, "parentId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "DocsPagesResponse": { "required": [ "sections", "pages" ], "properties": { "sections": { "properties": { "project": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageTreeNode" } }, "company": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageTreeNode" } }, "private": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageTreeNode" } } }, "type": "object", "additionalProperties": false }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPage" } } }, "type": "object", "additionalProperties": false }, "DocsSearchResponse": { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageLink" } } }, "type": "object", "additionalProperties": false }, "DocsNavigationResponse": { "required": [ "limit", "recent", "favorites", "mostViewed" ], "properties": { "limit": { "type": "integer", "maximum": 50, "minimum": 1 }, "recent": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageSummary" } }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageSummary" } }, "mostViewed": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageSummary" } } }, "type": "object", "additionalProperties": false }, "DocsFavoriteReorderResponse": { "required": [ "favorites" ], "properties": { "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageSummary" } } }, "type": "object", "additionalProperties": false }, "DocsPageVersion": { "required": [ "id", "versionNumber", "title", "createdAt", "elements", "metadata" ], "properties": { "id": { "type": [ "string", "null" ] }, "versionNumber": { "type": "integer", "minimum": 1 }, "title": { "type": "string" }, "changeSummary": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/DocsElement" } }, "metadata": { "type": "object", "additionalProperties": true }, "editedBy": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "DocsPageVersionsResponse": { "required": [ "items", "offset", "limit", "nextOffset", "total", "hasMore" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageVersion" } }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "maximum": 200, "minimum": 1 }, "nextOffset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "hasMore": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "DocsAssetUploadResponse": { "required": [ "created" ], "properties": { "created": { "$ref": "#/components/schemas/DocsAsset" } }, "type": "object", "additionalProperties": false }, "DocsFavoriteResponse": { "required": [ "pageId", "favorite" ], "properties": { "pageId": { "type": "string" }, "favorite": { "type": "boolean" }, "favoritedAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object", "additionalProperties": false }, "DocsPermissionsResponse": { "required": [ "permissions" ], "properties": { "permissions": { "$ref": "#/components/schemas/DocsPermissions" } }, "type": "object", "additionalProperties": false }, "DocsTocTreeResponse": { "required": [ "pageId", "depth", "items" ], "properties": { "pageId": { "type": [ "string", "null" ] }, "depth": { "type": "integer", "maximum": 6, "minimum": 1 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocsPageTreeNode" } } }, "type": "object", "additionalProperties": false }, "DocsPageCreateRequest": { "required": [ "title" ], "properties": { "title": { "type": "string", "maxLength": 180 }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "projectId": { "type": [ "string", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "sortOrder": { "type": [ "integer", "null" ] }, "pageType": { "type": "string", "enum": [ "document", "whiteboard" ] }, "sceneData": { "$ref": "#/components/schemas/DocsWhiteboardScene" }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/DocsElement" } }, "metadata": { "type": "object", "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "DocsPageUpdateRequest": { "properties": { "title": { "type": "string", "maxLength": 180 }, "pageType": { "type": "string", "enum": [ "document", "whiteboard" ] }, "sceneData": { "$ref": "#/components/schemas/DocsWhiteboardScene" }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/DocsElement" } }, "metadata": { "type": "object", "additionalProperties": true }, "changeSummary": { "type": "string" }, "createVersion": { "description": "For whiteboard pages, false updates the current snapshot without creating a history version.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "DocsPageMoveRequest": { "properties": { "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "projectId": { "type": [ "string", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "sortOrder": { "type": [ "integer", "null" ] }, "includeSubpages": { "type": "boolean", "default": true } }, "type": "object", "additionalProperties": false }, "DocsPageCopyRequest": { "properties": { "title": { "type": [ "string", "null" ], "maxLength": 180 }, "visibility": { "type": "string", "enum": [ "project", "company", "private" ] }, "projectId": { "type": [ "string", "null" ] }, "parentId": { "type": [ "string", "null" ] }, "sortOrder": { "type": [ "integer", "null" ] }, "includeSubpages": { "type": "boolean", "default": true } }, "type": "object", "additionalProperties": false }, "DocsFavoriteRequest": { "properties": { "favorite": { "type": "boolean", "default": true } }, "type": "object", "additionalProperties": false }, "DocsFavoriteReorderRequest": { "required": [ "pageIds" ], "properties": { "pageIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "DocsPermissionsWriteRequest": { "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "inherit", "everyone", "project_members", "restricted" ] }, "groupIds": { "type": "array", "items": { "type": "string" } }, "roleIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "AppliedPresetSummary": { "required": [ "id", "name", "drifted" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "appliedAt": { "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "drifted": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "Attachment": { "required": [ "id", "filename", "mediaType", "size", "createdAt", "isImage" ], "properties": { "id": { "type": [ "string", "null" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "size": { "type": "integer", "minimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "uploader": { "oneOf": [ { "$ref": "#/components/schemas/AttachmentUploader" }, { "type": "null" } ] }, "isImage": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "AttachmentUploader": { "required": [ "id", "displayName" ], "properties": { "id": { "type": [ "string", "null" ] }, "displayName": { "type": "string" } }, "type": "object", "additionalProperties": false }, "BoardSettings": { "properties": { "ticketTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTemplate" } }, "swimlanesEnabled": { "type": "boolean" }, "swimlaneMode": { "type": "string", "enum": [ "none", "parent", "epic", "assignee" ] }, "showTagsOnCards": { "type": "boolean" } }, "type": "object", "additionalProperties": true }, "ChatAttachment": { "required": [ "id", "filename", "mediaType", "size", "createdAt", "isImage" ], "properties": { "id": { "type": [ "string", "null" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "size": { "type": "integer", "minimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "isImage": { "type": "boolean" }, "url": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "ChatMessage": { "required": [ "id", "content", "senderName", "createdAt", "attachments" ], "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/ChatAttachment" } }, "silent": { "type": "boolean" }, "id": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "sender": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "senderId": { "type": [ "string", "null" ] }, "senderName": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "privateToUser": { "type": [ "boolean", "null" ] }, "poll": { "type": [ "object", "null" ], "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "Comment": { "required": [ "id", "content", "authorName", "createdAt" ], "properties": { "id": { "type": [ "string", "null" ] }, "content": { "type": "string" }, "contentDocument": { "oneOf": [ { "$ref": "#/components/schemas/RichTextDocument" }, { "type": "null" } ] }, "authorName": { "type": "string" }, "authorId": { "type": [ "string", "null" ] }, "author": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "replyToCommentId": { "type": [ "string", "null" ] }, "replyToAuthorName": { "type": [ "string", "null" ] }, "replyToContent": { "type": [ "string", "null" ] }, "replyToContentDocument": { "oneOf": [ { "$ref": "#/components/schemas/RichTextDocument" }, { "type": "null" } ] }, "replyToDeleted": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "Company": { "required": [ "id", "name", "slug", "hasLogo", "aiChatEnabled", "developmentWebhookConfigured" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "hasLogo": { "type": "boolean" }, "logoUrl": { "type": [ "string", "null" ] }, "logoUpdatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "seatLimit": { "type": [ "integer", "null" ], "minimum": 1 }, "timerPauseSplitThresholdMinutes": { "type": [ "integer", "null" ], "minimum": 0 }, "timerRoundingEnabled": { "type": "boolean" }, "workdayMinutes": { "type": [ "integer", "null" ], "minimum": 0 }, "workweekDays": { "type": "integer", "maximum": 7, "minimum": 1 }, "apiTokenCreationEnabled": { "type": "boolean" }, "apiTokenMaxLifetimeDays": { "type": [ "integer", "null" ], "minimum": 1 }, "aiChatEnabled": { "type": "boolean" }, "developmentWebhookConfigured": { "type": "boolean" }, "identityPolicy": { "type": "object", "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "CustomFieldDefinition": { "required": [ "key", "name", "type", "required", "options", "showOnCard", "showInTableByDefault", "searchable", "sortOrder", "archived" ], "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOption" } }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "text", "user", "userOrGroup", "number", "select", "date" ] }, "required": { "type": "boolean" }, "showOnCard": { "type": "boolean" }, "showInTableByDefault": { "type": "boolean" }, "searchable": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "archived": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "CustomFieldOption": { "required": [ "key", "label", "color" ], "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" } }, "type": "object", "additionalProperties": false }, "DeleteCascadeCounts": { "required": [ "subtickets", "groupedTickets", "total" ], "properties": { "subtickets": { "type": "integer", "minimum": 0 }, "groupedTickets": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "DevelopmentReference": { "required": [ "id", "provider", "type", "externalId", "createdAt", "updatedAt" ], "properties": { "id": { "type": [ "string", "null" ] }, "provider": { "type": "string" }, "type": { "type": "string" }, "externalId": { "type": "string" }, "repositoryName": { "type": [ "string", "null" ] }, "repositoryUrl": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "branch": { "type": [ "string", "null" ] }, "targetBranch": { "type": [ "string", "null" ] }, "sha": { "type": [ "string", "null" ] }, "shortSha": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "authorName": { "type": [ "string", "null" ] }, "externalCreatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "DevelopmentSummary": { "required": [ "branches", "commits", "pullRequests", "builds", "deployments", "counts" ], "properties": { "branches": { "type": "array", "items": { "$ref": "#/components/schemas/DevelopmentReference" } }, "commits": { "type": "array", "items": { "$ref": "#/components/schemas/DevelopmentReference" } }, "pullRequests": { "type": "array", "items": { "$ref": "#/components/schemas/DevelopmentReference" } }, "builds": { "type": "array", "items": { "$ref": "#/components/schemas/DevelopmentReference" } }, "deployments": { "type": "array", "items": { "$ref": "#/components/schemas/DevelopmentReference" } }, "counts": { "$ref": "#/components/schemas/DevelopmentSummaryCounts" } }, "type": "object", "additionalProperties": false }, "DevelopmentSummaryCounts": { "properties": { "branches": { "type": "integer", "minimum": 0 }, "commits": { "type": "integer", "minimum": 0 }, "pullRequests": { "type": "integer", "minimum": 0 }, "builds": { "type": "integer", "minimum": 0 }, "deployments": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "UserTimerPreferences": { "required": [ "topView", "hideWeekend", "workdayStartHour", "workdayEndHour" ], "properties": { "topView": { "type": "string", "enum": [ "running", "listing", "calendar" ] }, "hideWeekend": { "type": "boolean" }, "workdayStartHour": { "type": "integer", "maximum": 23, "minimum": 0 }, "workdayEndHour": { "type": "integer", "maximum": 24, "minimum": 1 } }, "type": "object", "additionalProperties": false }, "UserNotificationPreferences": { "required": [ "emailEnabled", "mentionsEnabled", "inAppEnabled", "inAppVisualEnabled", "inAppAudioEnabled", "inAppBrowserEnabled", "timerAudioEnabled", "chatAudioEnabled", "chatAudioMode", "chatCallAudioEnabled", "chatBrowserEnabled" ], "properties": { "emailEnabled": { "type": "boolean" }, "mentionsEnabled": { "type": "boolean" }, "inAppEnabled": { "type": "boolean" }, "inAppVisualEnabled": { "type": "boolean" }, "inAppAudioEnabled": { "type": "boolean" }, "inAppBrowserEnabled": { "type": "boolean" }, "timerAudioEnabled": { "type": "boolean" }, "chatAudioEnabled": { "type": "boolean" }, "chatAudioMode": { "type": "string", "enum": [ "none", "mentions_direct", "all" ] }, "chatCallAudioEnabled": { "type": "boolean" }, "chatBrowserEnabled": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "UserProjectAccess": { "required": [ "restricted", "projectIds" ], "properties": { "restricted": { "type": "boolean" }, "projectIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "WorktimeMinutesByDay": { "properties": { "monday": { "type": "integer", "maximum": 1440, "minimum": 0 }, "tuesday": { "type": "integer", "maximum": 1440, "minimum": 0 }, "wednesday": { "type": "integer", "maximum": 1440, "minimum": 0 }, "thursday": { "type": "integer", "maximum": 1440, "minimum": 0 }, "friday": { "type": "integer", "maximum": 1440, "minimum": 0 }, "saturday": { "type": "integer", "maximum": 1440, "minimum": 0 }, "sunday": { "type": "integer", "maximum": 1440, "minimum": 0 } }, "type": "object", "additionalProperties": false }, "RichTextDocument": { "description": "Sanitized rich-text document tree.", "type": "object", "additionalProperties": true }, "FlowDurationSummary": { "required": [ "count", "averageHours", "medianHours", "p85Hours", "minHours", "maxHours" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "averageHours": { "type": [ "number", "null" ] }, "medianHours": { "type": [ "number", "null" ] }, "p85Hours": { "type": [ "number", "null" ] }, "minHours": { "type": [ "number", "null" ] }, "maxHours": { "type": [ "number", "null" ] } }, "type": "object", "additionalProperties": false }, "FlowStatusDefinition": { "required": [ "key", "name", "color", "sortOrder", "category", "done", "closed" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer" }, "category": { "type": "string", "enum": [ "waiting", "active", "blocked", "done", "closed" ] }, "done": { "type": "boolean" }, "closed": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "FlowThroughputPeriod": { "required": [ "periodStart", "completed", "points" ], "properties": { "periodStart": { "type": "string", "format": "date" }, "completed": { "type": "integer", "minimum": 0 }, "points": { "type": "integer", "minimum": 0 }, "averageLeadHours": { "type": [ "number", "null" ] }, "averageCycleHours": { "type": [ "number", "null" ] } }, "type": "object", "additionalProperties": false }, "CumulativeFlowPoint": { "required": [ "date", "counts" ], "properties": { "date": { "type": "string", "format": "date" }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } } }, "type": "object", "additionalProperties": false }, "FlowTimeInStatus": { "required": [ "key", "name", "color", "category", "totalHours", "averageHours", "visits", "ticketCount", "sortOrder" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "category": { "type": "string" }, "totalHours": { "type": "number" }, "averageHours": { "type": [ "number", "null" ] }, "visits": { "type": "integer", "minimum": 0 }, "ticketCount": { "type": "integer", "minimum": 0 }, "sortOrder": { "type": "integer" } }, "type": "object", "additionalProperties": false }, "AgingWipItem": { "required": [ "id", "key", "title", "status", "category", "points", "ageHours", "since", "partial" ], "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "string" }, "category": { "type": "string" }, "points": { "type": "integer" }, "ageHours": { "type": "number" }, "since": { "type": "string", "format": "date-time" }, "partial": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "SprintVelocityPoint": { "required": [ "id", "title", "startDate", "endDate", "plannedPoints", "completedPoints", "completionPercent" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "startDate": { "type": [ "string", "null" ], "format": "date" }, "endDate": { "type": [ "string", "null" ], "format": "date" }, "plannedPoints": { "type": "integer" }, "completedPoints": { "type": "integer" }, "completionPercent": { "type": [ "number", "null" ] } }, "type": "object", "additionalProperties": false }, "ReleaseForecast": { "required": [ "id", "name", "plannedReleaseDate", "ticketCount", "completedTicketCount", "remainingTicketCount", "totalPoints", "completedPoints", "progressPercent", "forecastDate", "forecastStatus", "confidence" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plannedReleaseDate": { "type": "string", "format": "date" }, "ticketCount": { "type": "integer" }, "completedTicketCount": { "type": "integer" }, "remainingTicketCount": { "type": "integer" }, "totalPoints": { "type": "integer" }, "completedPoints": { "type": "integer" }, "progressPercent": { "type": "number" }, "forecastDate": { "type": [ "string", "null" ], "format": "date" }, "forecastStatus": { "type": "string", "enum": [ "complete", "on_track", "at_risk", "late", "insufficient_data" ] }, "confidence": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "type": "object", "additionalProperties": false }, "FlowInsightsResponse": { "required": [ "projectId", "generatedAt", "scope", "window", "statusDefinitions", "summary", "leadCycleTime", "cumulativeFlow", "throughput", "timeInStatus", "agingWip", "blockedTime", "blockers", "velocity", "estimateVsActual", "releases", "warnings" ], "properties": { "projectId": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "scope": { "type": "object", "additionalProperties": true }, "window": { "type": "object", "additionalProperties": true }, "statusDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/FlowStatusDefinition" } }, "summary": { "type": "object", "additionalProperties": true }, "leadCycleTime": { "required": [ "leadTime", "cycleTime", "partialCycleSamples", "series" ], "properties": { "leadTime": { "$ref": "#/components/schemas/FlowDurationSummary" }, "cycleTime": { "$ref": "#/components/schemas/FlowDurationSummary" }, "partialCycleSamples": { "type": "integer" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/FlowThroughputPeriod" } } }, "type": "object" }, "cumulativeFlow": { "required": [ "series" ], "properties": { "series": { "type": "array", "items": { "$ref": "#/components/schemas/CumulativeFlowPoint" } } }, "type": "object" }, "throughput": { "required": [ "bucket", "averagePerPeriod", "series" ], "properties": { "bucket": { "type": "string", "enum": [ "week", "month" ] }, "averagePerPeriod": { "type": "number" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/FlowThroughputPeriod" } } }, "type": "object" }, "timeInStatus": { "required": [ "statuses" ], "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/FlowTimeInStatus" } } }, "type": "object" }, "agingWip": { "required": [ "total", "olderThan7Days", "olderThan14Days", "olderThan30Days", "partialCount", "items" ], "properties": { "total": { "type": "integer" }, "olderThan7Days": { "type": "integer" }, "olderThan14Days": { "type": "integer" }, "olderThan30Days": { "type": "integer" }, "partialCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AgingWipItem" } } }, "type": "object" }, "blockedTime": { "type": "object", "additionalProperties": true }, "blockers": { "type": "object", "additionalProperties": true }, "velocity": { "required": [ "averageCompletedPoints", "series" ], "properties": { "averageCompletedPoints": { "type": [ "number", "null" ] }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/SprintVelocityPoint" } } }, "type": "object" }, "estimateVsActual": { "type": "object", "additionalProperties": true }, "releases": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseForecast" } }, "warnings": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "IssueType": { "required": [ "id", "name", "color", "icon", "allowsSubtickets", "showSubticketsInBoardCard", "allowsIssues", "sortOrder" ], "properties": { "id": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] }, "presetKey": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "allowsSubtickets": { "type": "boolean" }, "showSubticketsInBoardCard": { "type": "boolean" }, "allowsIssues": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "project": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReference" }, { "type": "null" } ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "IssueTypeSummary": { "required": [ "id", "name", "color", "icon", "allowsSubtickets", "showSubticketsInBoardCard", "allowsIssues", "sortOrder" ], "properties": { "id": { "type": [ "string", "null" ] }, "key": { "type": [ "string", "null" ] }, "presetKey": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "allowsSubtickets": { "type": "boolean" }, "showSubticketsInBoardCard": { "type": "boolean" }, "allowsIssues": { "type": "boolean" }, "sortOrder": { "type": "integer" } }, "type": "object", "additionalProperties": false }, "PageMeta": { "required": [ "total", "page", "perPage", "totalPages" ], "properties": { "total": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 1 }, "perPage": { "type": "integer", "minimum": 1 }, "totalPages": { "type": "integer", "minimum": 1 } }, "type": "object" }, "LimitPageMeta": { "required": [ "total", "page", "limit", "totalPages" ], "properties": { "total": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 1 }, "limit": { "type": "integer", "minimum": 1 }, "totalPages": { "type": "integer", "minimum": 1 } }, "type": "object" }, "OffsetPageMeta": { "required": [ "total", "limit", "offset" ], "properties": { "total": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1 }, "offset": { "type": "integer", "minimum": 0 } }, "type": "object" }, "PageWindowMeta": { "required": [ "page", "perPage" ], "properties": { "page": { "type": "integer", "minimum": 1 }, "perPage": { "type": "integer", "minimum": 1 } }, "type": "object" }, "Preset": { "required": [ "id", "name", "defaultPreset", "issueTypes", "statuses", "customFields", "boardSettings", "linkedProjectCount", "createdAt", "updatedAt" ], "properties": { "issueTypes": { "type": "array", "items": { "$ref": "#/components/schemas/PresetIssueType" } }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/PresetStatus" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinition" } }, "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "defaultPreset": { "type": "boolean" }, "boardSettings": { "$ref": "#/components/schemas/BoardSettings" }, "linkedProjectCount": { "type": "integer", "minimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "linkedProjectsNeedSync": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "PresetIssueType": { "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "allowsSubtickets": { "type": "boolean" }, "showSubticketsInBoardCard": { "type": "boolean" }, "allowsIssues": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "PresetStatus": { "required": [ "key", "name", "color", "doneStatus", "closedStatus", "sortOrder", "timeTrackingLocked", "creationAllowed" ], "properties": { "timeTrackingLockedByRole": { "type": [ "object", "null" ], "additionalProperties": { "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "doneStatus": { "type": "boolean" }, "closedStatus": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "timeTrackingLocked": { "type": "boolean" }, "autoHideAfterMinutes": { "type": [ "integer", "null" ], "minimum": 0 }, "autoArchiveAfterMinutes": { "type": [ "integer", "null" ], "minimum": 0 }, "creationAllowed": { "type": "boolean" } }, "type": "boolean" } }, "creationAllowedByRole": { "type": [ "object", "null" ], "additionalProperties": { "type": "boolean" } }, "transitionTargets": { "type": [ "array", "null" ], "items": { "type": "string" } }, "transitionTargetsByRole": { "type": [ "object", "null" ], "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "Project": { "required": [ "id", "name", "key", "publicBoard", "publicComments", "archived" ], "properties": { "projectBoardTicketTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTemplate" } }, "customFieldDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinition" } }, "projectBoardAssignedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "projectBoardAssignedGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupSummary" } }, "projectBoardEffectiveAssignedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "sprints": { "type": "array", "items": { "$ref": "#/components/schemas/Sprint" } }, "issueTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IssueType" } }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } }, "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "key": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "appliedPreset": { "oneOf": [ { "$ref": "#/components/schemas/AppliedPresetSummary" }, { "type": "null" } ] }, "publicBoard": { "type": "boolean" }, "publicComments": { "type": "boolean" }, "projectBoardSwimlanesEnabled": { "type": "boolean" }, "projectBoardSwimlaneMode": { "type": "string", "enum": [ "none", "parent", "epic", "assignee" ] }, "projectBoardShowTagsOnCards": { "type": "boolean" }, "enforceHardBlockers": { "type": "boolean" }, "billingTimeZone": { "type": "string" }, "defaultBillingProfile": { "type": [ "object", "null" ] }, "projectBoardDefaultBillingProfile": { "type": [ "object", "null" ] }, "archived": { "type": "boolean" }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "archivedBy": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "boardCount": { "type": "integer", "minimum": 0 }, "ticketCount": { "type": "integer", "minimum": 0 }, "backlogTicketCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "ProjectBoard": { "required": [ "id", "boardScope", "isBacklog", "sprintBoard", "started", "completed", "sortOrder" ], "properties": { "ticketTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTemplate" } }, "assignedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "assignedGroups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupSummary" } }, "effectiveAssignedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "id": { "type": [ "string", "null" ] }, "boardScope": { "type": "string" }, "isBacklog": { "type": "boolean" }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "sprintBoard": { "type": "boolean" }, "startDate": { "type": [ "string", "null" ], "format": "date" }, "endDate": { "type": [ "string", "null" ], "format": "date" }, "definitionOfDone": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "started": { "type": "boolean" }, "completed": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "swimlanesEnabled": { "type": "boolean" }, "swimlaneMode": { "type": "string", "enum": [ "none", "parent", "epic", "assignee" ] }, "showTagsOnCards": { "type": "boolean" }, "defaultBillingProfile": { "type": [ "object", "null" ] }, "publicBoard": { "type": "boolean" }, "publicComments": { "type": "boolean" }, "archived": { "type": "boolean" }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "archivedBy": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "project": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReference" }, { "type": "null" } ] }, "createdAt": { "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "ticketCount": { "type": "integer", "minimum": 0 }, "sourceRelease": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReleaseSummary" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "ProjectListSummary": { "required": [ "id", "name", "key", "customFieldDefinitions" ], "properties": { "customFieldDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinition" } }, "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "key": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ProjectReference": { "required": [ "id", "key", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ProjectRelease": { "required": [ "id", "name", "plannedReleaseDate", "createdAt", "updatedAt", "ticketCount", "completedTicketCount" ], "properties": { "generatedBoards": { "type": "array", "items": { "$ref": "#/components/schemas/SprintSummary" } }, "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "plannedReleaseDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "project": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReference" }, { "type": "null" } ] }, "ticketCount": { "type": "integer", "minimum": 0 }, "completedTicketCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "ProjectReleaseSummary": { "required": [ "id", "name", "plannedReleaseDate" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "plannedReleaseDate": { "type": "string", "format": "date" } }, "type": "object", "additionalProperties": false }, "ChatCallEgressRequest": { "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "outputType": { "type": "string", "default": "file", "enum": [ "file", "stream" ] }, "fileMode": { "type": "string", "default": "audio", "enum": [ "audio", "video" ] }, "streamProtocol": { "type": "string", "default": "rtmp", "enum": [ "rtmp", "srt" ] }, "streamUrl": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "ChatCallEgressStatusRequest": { "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "egressId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatCallEgressStopRequest": { "required": [ "type", "id", "egressId" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "egressId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatCallIngressDeleteRequest": { "required": [ "type", "id", "ingressId" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "ingressId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatCallIngressRequest": { "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "inputType": { "type": "string", "default": "rtmp", "enum": [ "rtmp", "whip" ] } }, "type": "object", "additionalProperties": false }, "ChatCallIngressStatusRequest": { "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "ingressId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatCallInviteRequest": { "required": [ "userIds" ], "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "direct", "group", "project", "board" ] }, "id": { "type": "string" }, "roomName": { "type": "string" }, "mode": { "type": "string", "default": "voice", "enum": [ "voice", "video" ] }, "chatTitle": { "type": "string" }, "inviteToken": { "description": "Signed call invite token, used when an invited participant invites someone else.", "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatCallSignalRequest": { "required": [ "type", "id", "event" ], "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board" ] }, "id": { "type": "string" }, "event": { "type": "string", "enum": [ "left", "ended" ] }, "mode": { "type": "string", "default": "voice", "enum": [ "voice", "video" ] }, "roomName": { "type": "string" }, "joinedAt": { "type": [ "string", "null" ], "format": "date-time" }, "endRequested": { "type": "boolean", "default": false } }, "type": "object", "additionalProperties": false }, "ChatCallTokenRequest": { "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board" ] }, "id": { "type": "string" }, "mode": { "type": "string", "default": "voice", "enum": [ "voice", "video" ] }, "intent": { "type": "string", "default": "join", "enum": [ "start", "join" ] }, "priority": { "description": "Only used when starting a new shared chat call. Important calls ask clients to play the ringing loop.", "type": "string", "default": "normal", "enum": [ "normal", "important" ] }, "inviteToken": { "description": "Signed short-lived call invite token. When present, type and id are not required.", "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatMessageCreateRequest": { "properties": { "content": { "type": "string" }, "file": { "type": "string", "format": "binary" } }, "type": "object", "additionalProperties": false }, "ChatPresenceStatsRequest": { "required": [ "channels" ], "properties": { "channels": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "CommentWriteRequest": { "required": [ "contentDocument" ], "properties": { "contentDocument": { "oneOf": [ { "$ref": "#/components/schemas/RichTextDocument" }, { "type": "null" } ] }, "authorName": { "type": "string" }, "replyToCommentId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "CompanyAdminUpdateRequest": { "description": "Company-scoped settings. attachmentMaxFileSizeBytes and aiChatEnabled are accepted only for SuperAdmin sessions.", "properties": { "timerPauseSplitThresholdMinutes": { "type": [ "integer", "null" ], "minimum": 0 }, "timerRoundingEnabled": { "type": [ "boolean", "null" ] }, "workdayMinutes": { "type": "integer", "minimum": 1 }, "workweekDays": { "type": "integer", "maximum": 7, "minimum": 1 }, "apiTokenCreationEnabled": { "type": [ "boolean", "null" ] }, "apiTokenMaxLifetimeDays": { "type": [ "integer", "null" ], "minimum": 1 }, "aiChatEnabled": { "description": "SuperAdmin session only.", "type": [ "boolean", "null" ] }, "developmentWebhookSecret": { "type": [ "string", "null" ] }, "attachmentStorageQuotaBytes": { "type": [ "integer", "null" ], "minimum": 1 }, "attachmentMaxFileSizeBytes": { "type": [ "integer", "null" ], "minimum": 1 }, "retentionPolicies": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "integer", "null" ], "minimum": 1 } }, "identityPolicy": { "type": [ "object", "null" ], "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "CompanyMemberAddRequest": { "required": [ "userId" ], "properties": { "userId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "DevelopmentWebhookPayload": { "description": "Provider-specific webhook payload accepted by the development-reference importer.", "properties": { "provider": { "type": "string" }, "event": { "type": "string" }, "repository": { "type": "object", "additionalProperties": true }, "pull_request": { "type": "object", "additionalProperties": true }, "commits": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "type": "object", "additionalProperties": true }, "IssueTypeWriteRequest": { "properties": { "projectId": { "type": "string" }, "key": { "type": "string" }, "presetKey": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "allowsSubtickets": { "type": "boolean" }, "showSubticketsInBoardCard": { "type": "boolean" }, "allowsIssues": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "PresetProjectRequest": { "required": [ "projectId" ], "properties": { "projectId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "PresetWriteRequest": { "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "defaultPreset": { "type": "boolean" }, "issueTypes": { "type": "array", "items": { "$ref": "#/components/schemas/PresetIssueType" } }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/PresetStatus" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinition" } }, "boardSettings": { "$ref": "#/components/schemas/BoardSettings" } }, "type": "object", "additionalProperties": false }, "ProjectCloneRequest": { "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "ProjectReleaseWriteRequest": { "required": [ "name", "plannedReleaseDate" ], "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "plannedReleaseDate": { "type": "string", "format": "date" } }, "type": "object", "additionalProperties": false }, "ProjectWriteRequest": { "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "publicBoard": { "type": "boolean" }, "publicComments": { "type": "boolean" }, "memberIds": { "type": "array", "items": { "type": "string" } }, "presetId": { "type": "string" }, "projectBoardSwimlanesEnabled": { "type": "boolean" }, "projectBoardSwimlaneMode": { "type": "string", "enum": [ "none", "parent", "epic", "assignee" ] }, "projectBoardShowTagsOnCards": { "type": "boolean" }, "enforceHardBlockers": { "type": "boolean" }, "projectBoardTicketTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTemplate" } }, "projectBoardAssignedUserIds": { "type": "array", "items": { "type": "string" } }, "projectBoardAssignedGroupIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "ReleaseBoardCreateRequest": { "required": [ "board", "ticketIds", "acknowledgeConflicts" ], "properties": { "board": { "$ref": "#/components/schemas/SprintWriteRequest" }, "ticketIds": { "type": "array", "items": { "type": "string" } }, "acknowledgeConflicts": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "SavedTicketViewCreateRequest": { "required": [ "name", "query" ], "properties": { "name": { "type": "string", "maxLength": 120 }, "query": { "$ref": "#/components/schemas/SavedTicketViewQuery" }, "visibility": { "type": "string", "default": "private", "enum": [ "private", "project" ] }, "projectId": { "description": "Required when visibility is project; ignored for private views.", "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "SavedTicketViewUpdateRequest": { "description": "Updates the name and/or query. Visibility and project are immutable; when supplied they must match the stored values.", "properties": { "name": { "type": "string", "maxLength": 120 }, "query": { "$ref": "#/components/schemas/SavedTicketViewQuery" }, "visibility": { "description": "If supplied, must equal the current visibility.", "type": "string", "enum": [ "private", "project" ] }, "projectId": { "description": "If supplied, must equal the current project identifier; use null for a private view.", "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "SearchConversationMessage": { "required": [ "role", "content" ], "properties": { "role": { "type": "string", "enum": [ "user", "assistant", "system" ] }, "content": { "type": "string" } }, "type": "object", "additionalProperties": false }, "SearchConversationRequest": { "required": [ "messages" ], "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/SearchConversationMessage" } }, "query": { "type": "string" }, "projectId": { "type": "string" }, "scope": { "type": "string" }, "searchMode": { "type": "string" }, "semanticMode": { "type": "string" } }, "type": "object", "additionalProperties": false }, "SprintOrderRequest": { "required": [ "boardIds" ], "properties": { "boardIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "SprintWriteRequest": { "properties": { "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "sprintBoard": { "type": "boolean" }, "startDate": { "type": [ "string", "null" ], "format": "date" }, "endDate": { "type": [ "string", "null" ], "format": "date" }, "definitionOfDone": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "prepared", "started", "completed" ] }, "started": { "type": "boolean" }, "completed": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "swimlanesEnabled": { "type": "boolean" }, "swimlaneMode": { "type": "string", "enum": [ "none", "parent", "epic", "assignee" ] }, "showTagsOnCards": { "type": "boolean" }, "ticketTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTemplate" } }, "publicBoard": { "type": "boolean" }, "publicComments": { "type": "boolean" }, "assignedUserIds": { "type": "array", "items": { "type": "string" } }, "assignedGroupIds": { "type": "array", "items": { "type": "string" } }, "defaultBillingProfileId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "StatusWriteRequest": { "properties": { "projectId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer" }, "doneStatus": { "type": "boolean" }, "closedStatus": { "type": "boolean" }, "creationAllowedByRole": { "type": "object", "additionalProperties": { "type": "boolean" } }, "timeTrackingLocked": { "type": "boolean" }, "timeTrackingLockedByRole": { "type": "object", "additionalProperties": { "type": "boolean" } }, "autoHideAfterMinutes": { "type": [ "integer", "null" ] }, "autoArchiveAfterMinutes": { "type": [ "integer", "null" ] }, "transitionTargetsByRole": { "type": "object", "additionalProperties": true } }, "type": "object", "additionalProperties": false }, "TagMergeRequest": { "required": [ "sourceTagIds" ], "properties": { "sourceTagIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "TagOrderRequest": { "required": [ "tagIds" ], "properties": { "tagIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "TagWriteRequest": { "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "allowedRoles": { "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TicketArchiveRequest": { "properties": { "includeChildren": { "type": "boolean" }, "cascadeChildren": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TicketBatchAssignRequest": { "required": [ "ticketIds" ], "properties": { "ticketIds": { "type": "array", "items": { "type": "string" } }, "assigneeId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "TicketBatchIdsRequest": { "required": [ "ticketIds" ], "properties": { "ticketIds": { "type": "array", "items": { "type": "string" } }, "includeChildren": { "type": "boolean" }, "cascadeChildren": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TicketBatchReleaseRequest": { "required": [ "ticketIds" ], "properties": { "ticketIds": { "type": "array", "items": { "type": "string" } }, "releaseId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "TicketBatchUpdateRequest": { "required": [ "ticketIds" ], "properties": { "ticketIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "sprintId": { "type": [ "string", "null" ] }, "assigneeId": { "type": [ "string", "null" ] }, "priority": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "TicketBoardOrderRequest": { "required": [ "updates" ], "properties": { "updates": { "type": "array", "items": { "$ref": "#/components/schemas/TicketBoardOrderUpdate" } } }, "type": "object", "additionalProperties": false }, "TicketBoardOrderUpdate": { "required": [ "ticketId", "boardOrder" ], "properties": { "ticketId": { "type": "string" }, "boardOrder": { "type": "integer", "minimum": 0 }, "expectedRevision": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TicketCopyRequest": { "required": [ "ticketIds" ], "properties": { "ticketIds": { "type": "array", "items": { "type": "string" } }, "targetProjectId": { "type": "string" }, "targetSprintId": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "TicketDraftsRequest": { "properties": { "conversation": { "type": "array", "items": { "$ref": "#/components/schemas/SearchConversationMessage" } }, "projectId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "TicketImpedimentUpdateRequest": { "properties": { "active": { "type": "boolean" }, "reason": { "type": [ "string", "null" ], "maxLength": 2000 }, "hard": { "type": "boolean" }, "expectedRevision": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TicketRelationCreateRequest": { "properties": { "type": { "type": "string" }, "hard": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TicketReminderRequest": { "properties": { "title": { "type": [ "string", "null" ] }, "reminderAt": { "type": [ "string", "null" ], "format": "date-time" }, "note": { "type": [ "string", "null" ] }, "userIds": { "type": "array", "items": { "type": "string" } }, "groupIds": { "type": "array", "items": { "type": "string" } }, "customEmails": { "type": "array", "items": { "type": "string", "format": "email" } } }, "type": "object", "additionalProperties": false }, "TicketStatusUpdateRequest": { "required": [ "status" ], "properties": { "status": { "type": "string" }, "expectedRevision": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TicketWriteRequest": { "properties": { "projectId": { "type": "string" }, "sprintId": { "type": [ "string", "null" ] }, "releaseId": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "descriptionDocument": { "oneOf": [ { "$ref": "#/components/schemas/RichTextDocument" }, { "type": "null" } ] }, "status": { "type": "string" }, "points": { "type": [ "integer", "null" ] }, "estimatedMinutes": { "type": [ "integer", "null" ] }, "priority": { "type": "string" }, "boardOrder": { "type": "integer" }, "assigneeId": { "type": [ "string", "null" ] }, "reporterId": { "type": [ "string", "null" ] }, "issueTypeId": { "type": "string" }, "parentId": { "type": [ "string", "null" ] }, "epicId": { "type": [ "string", "null" ] }, "tagIds": { "type": "array", "items": { "type": "string" } }, "dueDate": { "type": [ "string", "null" ], "format": "date" }, "customFieldValues": { "type": "object", "additionalProperties": true }, "expectedRevision": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TimeEntryWriteRequest": { "properties": { "minutes": { "type": "integer", "minimum": 1 }, "comment": { "type": [ "string", "null" ] }, "loggedAt": { "type": "string", "format": "date-time" }, "ticketId": { "type": [ "string", "null" ] }, "billable": { "type": "boolean" }, "userId": { "type": "string" }, "companyId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "TimerStopRequest": { "properties": { "minutes": { "type": "integer", "minimum": 1 }, "ticketId": { "type": [ "string", "null" ] }, "splitByPauses": { "type": "boolean" }, "billable": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TimerWriteRequest": { "properties": { "ticketId": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "startedAt": { "type": "string", "format": "date-time" }, "activeSince": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "UserProjectAccessWriteRequest": { "properties": { "restricted": { "type": "boolean" }, "projectIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "UserWriteRequest": { "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "format": "password" }, "displayName": { "type": "string" }, "invite": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } }, "companyAccessExpiresOn": { "type": [ "string", "null" ], "format": "date" }, "projectAccess": { "$ref": "#/components/schemas/UserProjectAccessWriteRequest" }, "timerPreferences": { "$ref": "#/components/schemas/UserTimerPreferences" }, "worktimeMinutesByDay": { "$ref": "#/components/schemas/WorktimeMinutesByDay" }, "themePreference": { "type": "string" }, "timeFormatPreference": { "type": "string" }, "languagePreference": { "type": "string" }, "startPagePreference": { "type": "string" }, "uiPreferences": { "type": "object", "additionalProperties": true }, "notificationPreferences": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "type": "object", "additionalProperties": false }, "WorkflowUpdateRequest": { "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/StatusWriteRequest" } } }, "type": "object", "additionalProperties": false }, "UserPageResponse": { "allOf": [ { "$ref": "#/components/schemas/LimitPageMeta" }, { "required": [ "items", "query" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "query": { "type": "string" } }, "type": "object" } ] }, "ProjectPageResponse": { "allOf": [ { "$ref": "#/components/schemas/PageMeta" }, { "required": [ "items", "sort" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "sort": { "type": "string", "enum": [ "activity", "name", "key", "tickets", "boards" ] } }, "type": "object" } ] }, "ProjectArchiveResponse": { "required": [ "ok", "project", "boardCount", "ticketCount" ], "properties": { "ok": { "type": "boolean" }, "project": { "$ref": "#/components/schemas/Project" }, "boardCount": { "type": "integer", "minimum": 0 }, "ticketCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "SprintArchiveResponse": { "required": [ "ok", "board", "ticketCount" ], "properties": { "ok": { "type": "boolean" }, "board": { "$ref": "#/components/schemas/Sprint" }, "ticketCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "BoardListResponse": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ProjectBoard" }, { "$ref": "#/components/schemas/Sprint" } ] } }, { "allOf": [ { "$ref": "#/components/schemas/OffsetPageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Sprint" } } }, "type": "object" } ] } ] }, "BoardImportDiagnostic": { "required": [ "severity", "code", "row", "field", "message" ], "properties": { "severity": { "type": "string", "example": "warning", "enum": [ "error", "warning" ] }, "code": { "type": "string", "example": "unknown_status" }, "row": { "type": [ "integer", "null" ], "example": 3, "minimum": 1 }, "field": { "type": [ "string", "null" ], "example": "Status" }, "message": { "type": "string", "example": "Unknown status; the project default will be used." } }, "type": "object", "additionalProperties": false }, "BoardImportResponse": { "required": [ "imported", "skipped", "ignored", "warningCount", "diagnostics", "warnings" ], "properties": { "imported": { "type": "integer", "minimum": 0 }, "skipped": { "type": "integer", "minimum": 0 }, "ignored": { "type": "integer", "minimum": 0 }, "warningCount": { "description": "Total diagnostic count, including diagnostics omitted when the returned detail list is capped.", "type": "integer", "minimum": 0 }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/BoardImportDiagnostic" } }, "warnings": { "description": "Legacy human-readable warning messages retained for API compatibility.", "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "BoardImportPreviewResponse": { "required": [ "preview", "canImport", "totalRows", "importable", "skipped", "ignored", "warningCount", "diagnostics", "warnings" ], "properties": { "preview": { "type": "boolean", "example": true }, "canImport": { "description": "Whether the analyzed file has at least one importable row and no file-level blocking error.", "type": "boolean" }, "totalRows": { "type": "integer", "minimum": 0 }, "importable": { "type": "integer", "minimum": 0 }, "skipped": { "type": "integer", "minimum": 0 }, "ignored": { "type": "integer", "minimum": 0 }, "warningCount": { "description": "Total diagnostic count, including diagnostics omitted when the returned detail list is capped.", "type": "integer", "minimum": 0 }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/BoardImportDiagnostic" } }, "warnings": { "description": "Legacy human-readable warning messages retained for API compatibility.", "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "CompanyListResponse": { "oneOf": [ { "$ref": "#/components/schemas/CompanyPageResponse" }, { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } ] }, "CompanyPageResponse": { "allOf": [ { "$ref": "#/components/schemas/PageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } }, "type": "object" } ] }, "ArchiveProjectPageResponse": { "allOf": [ { "$ref": "#/components/schemas/PageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } }, "type": "object" } ] }, "ArchiveBoardPageResponse": { "allOf": [ { "$ref": "#/components/schemas/PageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ProjectBoard" }, { "$ref": "#/components/schemas/Sprint" } ] } } }, "type": "object" } ] }, "ArchiveTicketPageResponse": { "allOf": [ { "$ref": "#/components/schemas/PageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketListItem" } } }, "type": "object" } ] }, "DashboardWidgetConfig": { "required": [ "rows" ], "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidgetRow" } } }, "type": "object", "additionalProperties": false }, "DashboardWidgetRow": { "required": [ "id", "widgets" ], "properties": { "id": { "type": "string" }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" } } }, "type": "object", "additionalProperties": false }, "DashboardWidget": { "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "type": "object", "additionalProperties": true }, "DashboardBoardIssuesResponse": { "allOf": [ { "$ref": "#/components/schemas/LimitPageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketListItem" } } }, "type": "object" } ] }, "TicketListResponse": { "type": "array", "items": { "$ref": "#/components/schemas/TicketListItem" } }, "TicketPagedResponse": { "allOf": [ { "$ref": "#/components/schemas/PageMeta" }, { "required": [ "items", "summary" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketListItem" } }, "summary": { "$ref": "#/components/schemas/TicketPageSummary" } }, "type": "object" } ] }, "TicketPageSummary": { "required": [ "count", "points", "minutes" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "points": { "type": "integer", "minimum": 0 }, "minutes": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TicketSummaryStatsResponse": { "properties": { "total": { "type": "integer", "minimum": 0 }, "byStatus": { "type": "object", "additionalProperties": { "type": "integer" } }, "byPriority": { "type": "object", "additionalProperties": { "type": "integer" } } }, "type": "object", "additionalProperties": false }, "TicketCandidatesResponse": { "allOf": [ { "$ref": "#/components/schemas/PageWindowMeta" }, { "required": [ "query", "results" ], "properties": { "query": { "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TicketCandidateResult" } } }, "type": "object" } ] }, "TicketCandidateResult": { "required": [ "ticket", "matches" ], "properties": { "ticket": { "$ref": "#/components/schemas/TicketListItem" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SearchMatch" } } }, "type": "object", "additionalProperties": false }, "SearchMatch": { "required": [ "field", "snippet" ], "properties": { "field": { "type": "string" }, "snippet": { "type": "string" } }, "type": "object", "additionalProperties": false }, "TicketSearchResult": { "required": [ "ticket", "textMatch", "matches" ], "properties": { "ticket": { "$ref": "#/components/schemas/Ticket" }, "textMatch": { "type": "integer" }, "wordMatchCount": { "type": "integer", "minimum": 0 }, "searchBucket": { "type": "integer", "minimum": 0 }, "semanticDistance": { "type": [ "number", "null" ], "format": "float" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SearchMatch" } } }, "type": "object", "additionalProperties": false }, "ProjectSearchResult": { "required": [ "project", "textMatch", "matches" ], "properties": { "project": { "$ref": "#/components/schemas/Project" }, "textMatch": { "type": "integer" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SearchMatch" } } }, "type": "object", "additionalProperties": false }, "BoardSearchResult": { "required": [ "board", "textMatch", "matches" ], "properties": { "board": { "$ref": "#/components/schemas/Sprint" }, "textMatch": { "type": "integer" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/SearchMatch" } } }, "type": "object", "additionalProperties": false }, "TicketSearchResponse": { "required": [ "query", "found", "projectFound", "boardFound", "page", "perPage", "results", "projects", "boards", "engine" ], "properties": { "query": { "type": "string" }, "found": { "type": "integer", "minimum": 0 }, "projectFound": { "type": "integer", "minimum": 0 }, "boardFound": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 1 }, "perPage": { "type": "integer", "minimum": 1 }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSearchResult" } }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectSearchResult" } }, "boards": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSearchResult" } }, "engine": { "type": "string", "enum": [ "typesense", "fallback" ] } }, "type": "object", "additionalProperties": false }, "SearchConversationResponse": { "properties": { "answer": { "type": "string" }, "message": { "type": "string" }, "tickets": { "type": "array", "items": { "$ref": "#/components/schemas/TicketListItem" } }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/TicketListItem" } } }, "type": "object", "additionalProperties": true }, "TicketDraftsResponse": { "properties": { "drafts": { "type": "array", "items": { "$ref": "#/components/schemas/TicketDraft" } } }, "type": "object", "additionalProperties": false }, "TicketDraft": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "string" }, "estimatedMinutes": { "type": [ "integer", "null" ] } }, "type": "object", "additionalProperties": true }, "TicketDetailsResponse": { "required": [ "ticket" ], "properties": { "ticket": { "$ref": "#/components/schemas/Ticket" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "timeEntries": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/TicketRelation" } }, "development": { "$ref": "#/components/schemas/DevelopmentSummary" }, "issueTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IssueType" } } }, "type": "object", "additionalProperties": false }, "AttachmentUploadResponse": { "required": [ "created", "errors" ], "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UploadError" } } }, "type": "object", "additionalProperties": false }, "UploadError": { "required": [ "name", "error" ], "properties": { "name": { "type": [ "string", "null" ] }, "error": { "type": "string" } }, "type": "object", "additionalProperties": false }, "TicketActivityListResponse": { "allOf": [ { "$ref": "#/components/schemas/OffsetPageMeta" }, { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketActivity" } } }, "type": "object" } ] }, "TicketActionResponse": { "properties": { "ok": { "type": "boolean" }, "ticket": { "$ref": "#/components/schemas/Ticket" }, "archived": { "type": "boolean" }, "archivedCount": { "type": "integer", "minimum": 0 }, "deleted": { "type": "integer", "minimum": 0 }, "watching": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TicketBatchResponse": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } }, { "properties": { "ok": { "type": "boolean" }, "tickets": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } }, "updated": { "type": "integer", "minimum": 0 }, "copied": { "type": "integer", "minimum": 0 }, "archived": { "type": "integer", "minimum": 0 }, "restored": { "type": "integer", "minimum": 0 }, "deleted": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false } ] }, "TimerStopResponse": { "required": [ "timer", "entry" ], "properties": { "timer": { "$ref": "#/components/schemas/Timer" }, "entry": { "oneOf": [ { "$ref": "#/components/schemas/TimeEntry" }, { "type": "null" } ] }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } } }, "type": "object", "additionalProperties": false }, "RemovedResponse": { "required": [ "removed" ], "properties": { "removed": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "IssueTypeDeleteConflictResponse": { "required": [ "error", "usageCount" ], "properties": { "error": { "type": "string" }, "usageCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "IssueTypeDeleteResponse": { "required": [ "ok", "reassigned" ], "properties": { "ok": { "type": "boolean" }, "reassigned": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TagMergeResponse": { "required": [ "ok", "tag", "mergedCount" ], "properties": { "ok": { "type": "boolean" }, "tag": { "$ref": "#/components/schemas/Tag" }, "mergedCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "PresetApplyResponse": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "project": { "$ref": "#/components/schemas/Project" } }, "type": "object", "additionalProperties": true }, "PresetSyncPreviewResponse": { "properties": { "changes": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "project": { "$ref": "#/components/schemas/Project" } }, "type": "object", "additionalProperties": true }, "PresetSyncResponse": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "project": { "$ref": "#/components/schemas/Project" } }, "type": "object", "additionalProperties": true }, "ChatChannelSummary": { "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "direct", "project", "board", "group" ] }, "title": { "type": "string" }, "key": { "type": [ "string", "null" ] }, "projectId": { "type": [ "string", "null" ] }, "projectKey": { "type": [ "string", "null" ] }, "projectTitle": { "type": [ "string", "null" ] }, "channel": { "type": [ "string", "null" ] }, "lastMessageAt": { "type": [ "string", "null" ], "format": "date-time" }, "unread": { "type": "boolean" }, "autoActiveSprint": { "type": [ "boolean", "null" ] }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "memberCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": true }, "ChatBootstrapResponse": { "required": [ "users", "directInboxChannel", "projectChannels", "boardChannels", "groupChannels", "onlineUserIds" ], "properties": { "users": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "directInboxChannel": { "type": "string" }, "projectChannels": { "type": "array", "items": { "$ref": "#/components/schemas/ChatChannelSummary" } }, "boardChannels": { "type": "array", "items": { "$ref": "#/components/schemas/ChatChannelSummary" } }, "groupChannels": { "type": "array", "items": { "$ref": "#/components/schemas/ChatChannelSummary" } }, "onlineUserIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "ChatPresenceResponse": { "properties": { "onlineUserIds": { "type": "array", "items": { "type": "string" } }, "count": { "type": "integer", "minimum": 0 }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } } }, "type": "object", "additionalProperties": false }, "ChatPresenceStatsResponse": { "required": [ "counts" ], "properties": { "counts": { "type": "object", "additionalProperties": { "type": "integer" } } }, "type": "object", "additionalProperties": false }, "ChatMessagePageResponse": { "required": [ "conversation", "messages", "hasMore" ], "properties": { "conversation": { "type": "object", "additionalProperties": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } }, "hasMore": { "type": "boolean" }, "nextBefore": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object", "additionalProperties": false }, "PublicBoardResponse": { "required": [ "project", "board" ], "properties": { "project": { "$ref": "#/components/schemas/Project" }, "board": { "oneOf": [ { "$ref": "#/components/schemas/ProjectBoard" }, { "$ref": "#/components/schemas/Sprint" } ] }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } }, "issueTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IssueType" } } }, "type": "object", "additionalProperties": false }, "PublicTicket": { "allOf": [ { "$ref": "#/components/schemas/Ticket" }, { "properties": { "commentsEnabled": { "type": "boolean" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/PublicAttachment" } }, "subtickets": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSummary" } } }, "type": "object" } ] }, "PublicAttachment": { "allOf": [ { "$ref": "#/components/schemas/Attachment" }, { "properties": { "url": { "type": "string" } }, "type": "object" } ] }, "PublicComment": { "allOf": [ { "$ref": "#/components/schemas/Comment" } ] }, "ChatCallTokenResponse": { "required": [ "enabled", "serverUrl", "token", "roomName", "mode", "expiresAt", "chat" ], "properties": { "enabled": { "type": "boolean" }, "serverUrl": { "type": "string", "example": "wss://rtc.antflow.de" }, "token": { "type": "string" }, "roomName": { "type": "string" }, "mode": { "type": "string", "enum": [ "voice", "video" ] }, "priority": { "type": "string", "enum": [ "normal", "important" ] }, "activeBeforeJoin": { "type": "boolean" }, "participantCountBeforeJoin": { "type": [ "integer", "null" ] }, "inviteToken": { "type": [ "string", "null" ] }, "invited": { "type": [ "boolean", "null" ] }, "expiresAt": { "type": "string", "format": "date-time" }, "callHistoryMessage": { "oneOf": [ { "$ref": "#/components/schemas/ChatMessage" }, { "type": "null" } ] }, "chat": { "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board" ] }, "id": { "type": "string" }, "channel": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "ChatCallSignalResponse": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "event": { "type": "string", "enum": [ "left", "ended" ] }, "callHistoryMessage": { "oneOf": [ { "$ref": "#/components/schemas/ChatMessage" }, { "type": "null" } ] }, "egress": { "oneOf": [ { "$ref": "#/components/schemas/ChatCallEgress" }, { "type": "null" } ] }, "recordingMessage": { "oneOf": [ { "$ref": "#/components/schemas/ChatMessage" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "ChatCallStatusResponse": { "required": [ "enabled", "active", "roomName", "mode", "participantCount", "expiresAt", "chat" ], "properties": { "enabled": { "type": "boolean" }, "active": { "type": "boolean" }, "roomName": { "type": "string" }, "mode": { "type": "string", "enum": [ "voice", "video" ] }, "participantCount": { "type": [ "integer", "null" ] }, "expiresAt": { "type": "string", "format": "date-time" }, "chat": { "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board" ] }, "id": { "type": "string" }, "channel": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "ChatCallIngress": { "required": [ "id", "inputType", "url", "streamKey", "roomName", "participantIdentity", "participantName", "enabled", "reusable", "status", "error" ], "properties": { "id": { "type": "string" }, "inputType": { "type": "string", "enum": [ "rtmp", "whip", "unknown" ] }, "url": { "type": "string" }, "streamKey": { "type": "string" }, "roomName": { "type": "string" }, "participantIdentity": { "type": "string" }, "participantName": { "type": "string" }, "enabled": { "type": "boolean" }, "reusable": { "type": "boolean" }, "status": { "type": "integer" }, "error": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ChatCallIngressResponse": { "required": [ "enabled", "roomName", "ingress", "chat" ], "properties": { "enabled": { "type": "boolean" }, "roomName": { "type": "string" }, "ingress": { "oneOf": [ { "$ref": "#/components/schemas/ChatCallIngress" }, { "type": "null" } ] }, "chat": { "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "channel": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "ChatCallEgress": { "required": [ "id", "roomName", "status", "statusName", "outputType", "fileMode", "fileType", "streamProtocol", "streamUrl", "downloadKey", "downloadUrl", "filename", "size", "startedAt", "endedAt", "updatedAt", "error" ], "properties": { "id": { "type": "string" }, "roomName": { "type": "string" }, "status": { "type": "integer" }, "statusName": { "type": "string" }, "outputType": { "type": "string", "enum": [ "file", "stream", "unknown" ] }, "fileMode": { "type": [ "string", "null" ], "enum": [ "audio", "video", "" ] }, "fileType": { "type": [ "string", "null" ], "enum": [ "mp4", "ogg", "mp3", "" ] }, "streamProtocol": { "type": [ "string", "null" ], "enum": [ "rtmp", "srt", "" ] }, "streamUrl": { "type": [ "string", "null" ] }, "downloadKey": { "type": [ "string", "null" ] }, "downloadUrl": { "type": [ "string", "null" ] }, "filename": { "type": [ "string", "null" ] }, "size": { "type": [ "integer", "null" ] }, "startedAt": { "type": [ "string", "null" ], "format": "date-time" }, "endedAt": { "type": [ "string", "null" ], "format": "date-time" }, "updatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "error": { "type": [ "string", "null" ] } }, "type": "object", "additionalProperties": false }, "ChatCallEgressResponse": { "required": [ "enabled", "roomName", "egress", "chat" ], "properties": { "enabled": { "type": "boolean" }, "roomName": { "type": "string" }, "egress": { "oneOf": [ { "$ref": "#/components/schemas/ChatCallEgress" }, { "type": "null" } ] }, "chat": { "properties": { "type": { "type": "string", "enum": [ "direct", "group", "project", "board", "prepared" ] }, "id": { "type": "string" }, "channel": { "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "ChatCallEgressStopResponse": { "required": [ "ok", "egress", "message" ], "properties": { "ok": { "type": "boolean" }, "egress": { "$ref": "#/components/schemas/ChatCallEgress" }, "message": { "oneOf": [ { "$ref": "#/components/schemas/ChatMessage" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "DevelopmentWebhookResponse": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "created": { "type": "integer", "minimum": 0 }, "updated": { "type": "integer", "minimum": 0 }, "ignored": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": true }, "SavedTicketView": { "required": [ "id", "name", "visibility", "project", "owner", "query", "canUpdate", "canDelete", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "maxLength": 120 }, "visibility": { "type": "string", "enum": [ "private", "project" ] }, "project": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReference" }, { "type": "null" } ] }, "owner": { "$ref": "#/components/schemas/UserSummary" }, "query": { "$ref": "#/components/schemas/SavedTicketViewQuery" }, "canUpdate": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "SavedTicketViewDeleteResponse": { "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "example": true } }, "type": "object", "additionalProperties": false }, "SavedTicketViewListResponse": { "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SavedTicketView" } } }, "type": "object", "additionalProperties": false }, "SavedTicketViewQuery": { "description": "Canonical SearchTickets route query. Every stored value is a string; multi-value filters use comma-separated values.", "properties": { "q": { "type": "string", "maxLength": 1000 }, "scope": { "type": "string", "enum": [ "tickets", "attachments", "docs", "projects", "boards", "tags", "assigned", "reported", "worked" ] }, "searchMode": { "type": "string", "enum": [ "semantic", "phrase", "all", "any" ] }, "ticketSearchFields": { "description": "Single ticket content field to search.", "type": "string", "enum": [ "key", "title", "description", "comments", "tags", "attachments" ] }, "projectIds": { "description": "Comma-separated project identifiers.", "type": "string" }, "boardIds": { "description": "Comma-separated board identifiers.", "type": "string" }, "tagIds": { "description": "Comma-separated tag identifiers.", "type": "string" }, "assigneeIds": { "description": "Comma-separated assignee or assignee-group filter identifiers.", "type": "string" }, "reporterIds": { "description": "Comma-separated reporter or reporter-group filter identifiers.", "type": "string" }, "statusKeys": { "description": "Comma-separated status keys.", "type": "string" }, "priorities": { "description": "Comma-separated priorities.", "type": "string", "example": "critical,high" } }, "type": "object", "additionalProperties": false }, "Sprint": { "allOf": [ { "$ref": "#/components/schemas/ProjectBoard" }, { "properties": { "boardScope": { "type": "string", "enum": [ "sprint" ] }, "isBacklog": { "type": "boolean", "enum": [ false ] } }, "type": "object" } ] }, "SprintSummary": { "required": [ "id", "title", "sprintBoard", "status", "started", "completed", "sortOrder", "project" ], "properties": { "id": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "sprintBoard": { "type": "boolean" }, "status": { "type": "string" }, "started": { "type": "boolean" }, "completed": { "type": "boolean" }, "sortOrder": { "type": "integer" }, "swimlanesEnabled": { "type": "boolean" }, "swimlaneMode": { "type": "string", "enum": [ "none", "parent", "epic", "assignee" ] }, "showTagsOnCards": { "type": "boolean" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "sourceRelease": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReleaseSummary" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "Status": { "allOf": [ { "$ref": "#/components/schemas/StatusInfo" }, { "required": [ "id", "key", "sortOrder" ], "properties": { "id": { "type": [ "string", "null" ] }, "key": { "type": "string" }, "sortOrder": { "type": "integer" }, "transitionTargets": { "type": [ "array", "null" ], "items": { "type": "string" } }, "transitionTargetsByRole": { "type": [ "object", "null" ], "additionalProperties": true }, "project": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReference" }, { "type": "null" } ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] } }, "type": "object" } ] }, "StatusInfo": { "required": [ "name", "color", "doneStatus", "closedStatus" ], "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "doneStatus": { "type": "boolean" }, "closedStatus": { "type": "boolean" }, "creationAllowed": { "type": "boolean" }, "creationAllowedByRole": { "type": [ "object", "null" ], "additionalProperties": { "type": "boolean" } }, "timeTrackingLocked": { "type": "boolean" }, "timeTrackingLockedFallback": { "type": "boolean" }, "timeTrackingLockedByRole": { "type": [ "object", "null" ], "additionalProperties": { "type": "boolean" } }, "autoHideAfterMinutes": { "type": [ "integer", "null" ] }, "autoArchiveAfterMinutes": { "type": [ "integer", "null" ] } }, "type": "object", "additionalProperties": false }, "Tag": { "required": [ "id", "name", "canonicalKey", "color", "sortOrder", "archived" ], "properties": { "allowedRoles": { "type": "array", "items": { "type": "string" } }, "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "canonicalKey": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer" }, "archived": { "type": "boolean" }, "canAccess": { "type": "boolean" }, "canManage": { "type": "boolean" }, "canApply": { "type": "boolean" }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "usageCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TagSummary": { "required": [ "id", "name", "canonicalKey", "color", "sortOrder", "archived" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "canonicalKey": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer" }, "archived": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "Ticket": { "required": [ "id", "number", "key", "title", "status", "priority", "createdAt", "updatedAt", "revision", "archived" ], "properties": { "descriptionDocument": { "oneOf": [ { "$ref": "#/components/schemas/RichTextDocument" }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "subtickets": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSummary" } }, "epicIssues": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSummary" } }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "customFieldValues": { "type": "object", "additionalProperties": true }, "customFieldUsers": { "type": "object", "additionalProperties": true }, "customFieldGroups": { "type": "object", "additionalProperties": true }, "timeEntries": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } }, "blocking": { "type": "object", "additionalProperties": true }, "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "statusInfo": { "oneOf": [ { "$ref": "#/components/schemas/StatusInfo" }, { "type": "null" } ] }, "points": { "type": [ "integer", "null" ] }, "estimatedMinutes": { "type": [ "integer", "null" ] }, "priority": { "type": "string" }, "boardOrder": { "type": "integer" }, "project": { "oneOf": [ { "$ref": "#/components/schemas/Project" }, { "type": "null" } ] }, "issueType": { "oneOf": [ { "$ref": "#/components/schemas/IssueType" }, { "type": "null" } ] }, "assignee": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "reporter": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "sprint": { "oneOf": [ { "$ref": "#/components/schemas/Sprint" }, { "type": "null" } ] }, "release": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReleaseSummary" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "revision": { "type": "integer", "minimum": 0 }, "archived": { "type": "boolean" }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "archivedBy": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "dueDate": { "type": [ "string", "null" ], "format": "date" }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "epic": { "oneOf": [ { "$ref": "#/components/schemas/TicketSummary" }, { "type": "null" } ] }, "deleteCascadeCounts": { "$ref": "#/components/schemas/DeleteCascadeCounts" }, "watcherCount": { "type": "integer", "minimum": 0 }, "reminder": { "oneOf": [ { "$ref": "#/components/schemas/TicketReminder" }, { "type": "null" } ] }, "totalTrackedMinutes": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TicketActivity": { "required": [ "id", "type", "summary", "createdAt" ], "properties": { "id": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "summary": { "type": "string" }, "details": { "type": "object", "additionalProperties": true }, "createdAt": { "type": "string", "format": "date-time" }, "actor": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "ticket": { "$ref": "#/components/schemas/TicketActivityTicket" } }, "type": "object", "additionalProperties": false }, "TicketActivityTicket": { "required": [ "id", "number", "key", "title" ], "properties": { "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "project": { "oneOf": [ { "$ref": "#/components/schemas/Project" }, { "type": "null" } ] }, "issueType": { "oneOf": [ { "$ref": "#/components/schemas/IssueType" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "TicketListItem": { "required": [ "id", "number", "key", "title", "status", "priority", "createdAt", "updatedAt", "revision", "archived" ], "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagSummary" } }, "customFieldValues": { "type": "object", "additionalProperties": true }, "customFieldUsers": { "type": "object", "additionalProperties": true }, "customFieldGroups": { "type": "object", "additionalProperties": true }, "blocking": { "type": "object", "additionalProperties": true }, "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "status": { "type": "string" }, "statusInfo": { "oneOf": [ { "$ref": "#/components/schemas/StatusInfo" }, { "type": "null" } ] }, "points": { "type": [ "integer", "null" ] }, "estimatedMinutes": { "type": [ "integer", "null" ] }, "totalTrackedMinutes": { "type": "integer", "minimum": 0 }, "priority": { "type": "string" }, "boardOrder": { "type": "integer" }, "project": { "oneOf": [ { "$ref": "#/components/schemas/ProjectListSummary" }, { "type": "null" } ] }, "issueType": { "oneOf": [ { "$ref": "#/components/schemas/IssueTypeSummary" }, { "type": "null" } ] }, "assignee": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "reporter": { "oneOf": [ { "$ref": "#/components/schemas/UserSummary" }, { "type": "null" } ] }, "sprint": { "oneOf": [ { "$ref": "#/components/schemas/SprintSummary" }, { "type": "null" } ] }, "release": { "oneOf": [ { "$ref": "#/components/schemas/ProjectReleaseSummary" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "revision": { "type": "integer", "minimum": 0 }, "archived": { "type": "boolean" }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "dueDate": { "type": [ "string", "null" ], "format": "date" }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "epic": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "subticketCount": { "type": "integer", "minimum": 0 }, "epicIssueCount": { "type": "integer", "minimum": 0 }, "deleteCascadeCounts": { "$ref": "#/components/schemas/DeleteCascadeCounts" }, "currentUserTrackedMinutes": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TicketReference": { "required": [ "id", "number", "key", "title" ], "properties": { "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "issueType": { "oneOf": [ { "$ref": "#/components/schemas/IssueTypeSummary" }, { "type": "null" } ] }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "epic": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "TicketRelation": { "required": [ "id", "type", "displayType", "direction", "hard", "createdAt", "ticket" ], "properties": { "id": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "displayType": { "type": "string" }, "direction": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "hard": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "ticket": { "$ref": "#/components/schemas/TicketRelationTicket" } }, "type": "object", "additionalProperties": false }, "TicketRelationTicket": { "allOf": [ { "$ref": "#/components/schemas/TimerTicket" }, { "properties": { "priority": { "type": "string" }, "status": { "type": "string" }, "statusInfo": { "oneOf": [ { "$ref": "#/components/schemas/StatusInfo" }, { "type": "null" } ] }, "issueType": { "oneOf": [ { "$ref": "#/components/schemas/IssueType" }, { "type": "null" } ] }, "assignee": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] } }, "type": "object" } ] }, "TicketReminder": { "required": [ "title", "active" ], "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupSummary" } }, "customEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "title": { "type": [ "string", "null" ] }, "reminderAt": { "type": [ "string", "null" ], "format": "date-time" }, "note": { "type": [ "string", "null" ] }, "sentAt": { "type": [ "string", "null" ], "format": "date-time" }, "active": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TicketSummary": { "required": [ "id", "number", "key", "title", "status", "priority" ], "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "status": { "type": "string" }, "points": { "type": [ "integer", "null" ] }, "priority": { "type": "string" }, "issueType": { "oneOf": [ { "$ref": "#/components/schemas/IssueType" }, { "type": "null" } ] }, "assignee": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "sprint": { "oneOf": [ { "$ref": "#/components/schemas/Sprint" }, { "type": "null" } ] }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "epic": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "deleteCascadeCounts": { "oneOf": [ { "$ref": "#/components/schemas/DeleteCascadeCounts" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "TicketTemplate": { "required": [ "id", "name", "title", "descriptionDocument", "issueTypeId", "priority", "points", "estimatedMinutes", "dueBusinessDays", "tagIds", "customFieldValues", "isDefault" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "descriptionDocument": { "oneOf": [ { "$ref": "#/components/schemas/RichTextDocument" }, { "type": "null" } ] }, "issueTypeId": { "type": [ "string", "null" ] }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "critical" ] }, "points": { "type": [ "number", "null" ], "format": "float", "minimum": 0 }, "estimatedMinutes": { "type": [ "integer", "null" ], "minimum": 1 }, "dueBusinessDays": { "type": [ "integer", "null" ], "maximum": 365, "minimum": 0 }, "tagIds": { "type": "array", "items": { "type": "string" } }, "customFieldValues": { "type": "object", "additionalProperties": true }, "isDefault": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "TimeEntry": { "required": [ "id", "minutes", "loggedAt" ], "properties": { "id": { "type": [ "string", "null" ] }, "minutes": { "type": "integer", "minimum": 1 }, "comment": { "type": [ "string", "null" ] }, "loggedAt": { "type": "string", "format": "date-time" }, "user": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "billing": { "type": [ "object", "null" ] } }, "type": "object", "additionalProperties": false }, "TimeEntryReport": { "required": [ "id", "minutes", "loggedAt" ], "properties": { "id": { "type": [ "string", "null" ] }, "minutes": { "type": "integer", "minimum": 1 }, "comment": { "type": [ "string", "null" ] }, "loggedAt": { "type": "string", "format": "date-time" }, "user": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "billing": { "type": [ "object", "null" ] }, "ticket": { "oneOf": [ { "$ref": "#/components/schemas/TimeEntryTicket" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "TimeEntryTicket": { "required": [ "id", "number", "key", "title", "priority", "status" ], "properties": { "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "priority": { "type": "string" }, "status": { "type": "string" }, "statusInfo": { "oneOf": [ { "$ref": "#/components/schemas/StatusInfo" }, { "type": "null" } ] }, "project": { "oneOf": [ { "$ref": "#/components/schemas/Project" }, { "type": "null" } ] }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "epic": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "Timer": { "required": [ "id", "startedAt", "isPaused", "accumulatedSeconds", "completedSegments", "elapsedMinutes" ], "properties": { "completedSegments": { "type": "array", "items": { "$ref": "#/components/schemas/TimerSegment" } }, "id": { "type": [ "string", "null" ] }, "startedAt": { "type": "string", "format": "date-time" }, "activeSince": { "type": [ "string", "null" ], "format": "date-time" }, "pausedAt": { "type": [ "string", "null" ], "format": "date-time" }, "isPaused": { "type": "boolean" }, "accumulatedSeconds": { "type": "integer", "minimum": 0 }, "elapsedMinutes": { "type": "integer", "minimum": 0 }, "description": { "type": [ "string", "null" ] }, "user": { "oneOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "ticket": { "oneOf": [ { "$ref": "#/components/schemas/TimerTicket" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "TimerSegment": { "required": [ "startAt", "endAt", "minutes" ], "properties": { "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "minutes": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "TimerTicket": { "required": [ "id", "number", "key", "title" ], "properties": { "id": { "type": [ "string", "null" ] }, "number": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "project": { "oneOf": [ { "$ref": "#/components/schemas/Project" }, { "type": "null" } ] }, "parent": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] }, "epic": { "oneOf": [ { "$ref": "#/components/schemas/TicketReference" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "User": { "required": [ "id", "displayName", "email", "roles", "isAdmin", "isManager", "isSuperAdmin", "isReporter", "emailVerified" ], "properties": { "id": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "hasAvatar": { "type": "boolean" }, "avatarUrl": { "type": [ "string", "null" ] }, "avatarUpdatedAt": { "type": [ "string", "null" ], "format": "date-time" }, "roles": { "type": "array", "items": { "type": "string" } }, "isAdmin": { "type": "boolean" }, "isManager": { "type": "boolean" }, "isSuperAdmin": { "type": "boolean" }, "isReporter": { "type": "boolean" }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } }, "currentCompany": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "timerPreferences": { "$ref": "#/components/schemas/UserTimerPreferences" }, "worktimeMinutesByDay": { "$ref": "#/components/schemas/WorktimeMinutesByDay" }, "themePreference": { "type": [ "string", "null" ] }, "timeFormatPreference": { "type": [ "string", "null" ] }, "languagePreference": { "type": [ "string", "null" ] }, "startPagePreference": { "type": [ "string", "null" ] }, "uiPreferences": { "type": "object", "additionalProperties": true }, "notificationPreferences": { "$ref": "#/components/schemas/UserNotificationPreferences" }, "invitationPending": { "type": "boolean" }, "invitationAcceptedAt": { "type": [ "string", "null" ], "format": "date-time" }, "pendingEmail": { "type": [ "string", "null" ], "format": "email" }, "emailChangePending": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "lastSuccessfulAuthenticationDate": { "type": [ "string", "null" ], "format": "date-time" }, "failedAuthenticationCount": { "type": "integer", "minimum": 0 }, "twoFactorEnabled": { "type": "boolean" }, "twoFactorPending": { "type": "boolean" }, "twoFactorEnabledAt": { "type": [ "string", "null" ], "format": "date-time" }, "companyMember": { "type": "boolean" }, "projectAccess": { "$ref": "#/components/schemas/UserProjectAccess" }, "companyAccessExpiresAt": { "type": [ "string", "null" ], "format": "date-time" }, "companyAccessExpired": { "type": "boolean" }, "countsTowardsSeat": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "UserGroupSummary": { "required": [ "id", "type", "name", "displayName", "handle", "planningType", "memberCount", "archived" ], "properties": { "id": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "group" ] }, "name": { "type": "string" }, "displayName": { "type": "string" }, "handle": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "planningType": { "type": "string", "enum": [ "normal", "team" ] }, "memberCount": { "type": "integer", "minimum": 0 }, "archived": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "ErrorResponse": { "description": "Standard JSON error response.", "required": [ "error" ], "properties": { "error": { "description": "Human-readable error message.", "type": "string", "example": "forbidden" }, "code": { "description": "Stable machine-readable error code.", "type": [ "string", "null" ], "example": "forbidden" }, "message": { "description": "Optional client-displayable message.", "type": [ "string", "null" ], "example": "The action is not allowed." } }, "type": "object", "additionalProperties": false }, "ForbiddenResponse": { "description": "The caller is authenticated but not allowed to perform the action.", "required": [ "error" ], "properties": { "error": { "description": "Machine-readable or human-readable error message.", "type": "string", "example": "forbidden" }, "code": { "description": "Stable machine-readable error code.", "type": [ "string", "null" ], "example": "forbidden" }, "message": { "description": "Optional client-displayable message.", "type": [ "string", "null" ], "example": "The action is not allowed." } }, "type": "object", "additionalProperties": false }, "LanguageSettings": { "description": "Language configuration used by the client.", "required": [ "default", "supported" ], "properties": { "default": { "type": "string", "example": "en" }, "supported": { "type": "array", "items": { "type": "string" }, "example": [ "en", "de" ] } }, "type": "object" }, "NotFoundResponse": { "description": "The requested resource was not found.", "required": [ "error" ], "properties": { "error": { "description": "Machine-readable or human-readable error message.", "type": "string", "example": "not found" } }, "type": "object", "additionalProperties": false }, "NotificationAudioSettings": { "description": "Notification audio asset URLs.", "required": [ "mp3Url", "oggUrl" ], "properties": { "mp3Url": { "type": "string", "example": "/assets/notification.mp3" }, "oggUrl": { "type": "string", "example": "/assets/notification.ogg" } }, "type": "object" }, "RateLimitErrorResponse": { "required": [ "error", "retryAfter" ], "properties": { "error": { "type": "string", "example": "rate limit exceeded" }, "retryAfter": { "description": "Seconds until the client should retry.", "type": "integer", "example": 42, "minimum": 1 } }, "type": "object", "additionalProperties": false }, "RealtimeSettings": { "description": "Realtime connection settings exposed to the client.", "required": [ "enabled", "websocketUrl" ], "properties": { "enabled": { "type": "boolean", "example": true }, "websocketUrl": { "type": "string", "example": "ws://localhost:8001/connection/websocket" } }, "type": "object" }, "RtcSettings": { "description": "Realtime media connection settings exposed to the client.", "required": [ "enabled", "url" ], "properties": { "enabled": { "type": "boolean", "example": true }, "url": { "type": "string", "example": "wss://rtc.antflow.de" } }, "type": "object" }, "SettingsResponse": { "description": "Public settings returned during client bootstrap.", "required": [ "branding", "languages", "realtime", "rtc", "aiChat" ], "properties": { "branding": { "$ref": "#/components/schemas/BrandingSettings" }, "languages": { "$ref": "#/components/schemas/LanguageSettings" }, "realtime": { "$ref": "#/components/schemas/RealtimeSettings" }, "rtc": { "$ref": "#/components/schemas/RtcSettings" }, "aiChat": { "$ref": "#/components/schemas/AiChatSettings" } }, "type": "object" }, "UnauthorizedResponse": { "description": "Authentication is missing or no longer valid.", "required": [ "error" ], "properties": { "error": { "description": "Machine-readable or human-readable error message.", "type": "string", "example": "unauthenticated" }, "code": { "description": "Stable machine-readable error code.", "type": [ "string", "null" ], "example": "not_authenticated" }, "message": { "description": "Optional client-displayable message.", "type": [ "string", "null" ], "example": "Authentication is required." } }, "type": "object", "additionalProperties": false }, "UserGroupDeleteResponse": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "deleted": { "description": "Present when the archived group was permanently deleted.", "type": "boolean" }, "removedReferences": { "type": [ "object", "null" ], "additionalProperties": { "type": "integer" } } }, "type": "object", "additionalProperties": false }, "UserGroupListResponse": { "required": [ "items", "total", "page", "limit", "query" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResponse" } }, "total": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 1 }, "limit": { "type": "integer", "maximum": 100, "minimum": 1 }, "query": { "type": "string" } }, "type": "object", "additionalProperties": false }, "UserGroupReferenceCounts": { "required": [ "projectBoards", "sprints", "reminders", "total" ], "properties": { "projectBoards": { "type": "integer", "minimum": 0 }, "sprints": { "type": "integer", "minimum": 0 }, "reminders": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "UserGroupResponse": { "required": [ "id", "type", "name", "displayName", "handle", "planningType", "memberCount", "archived" ], "properties": { "id": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "group" ] }, "name": { "type": "string", "maxLength": 120 }, "displayName": { "type": "string" }, "handle": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "planningType": { "type": "string", "enum": [ "normal", "team" ] }, "memberCount": { "type": "integer", "minimum": 0 }, "archived": { "type": "boolean" }, "company": { "oneOf": [ { "$ref": "#/components/schemas/Company" }, { "type": "null" } ] }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/UserSummary" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "referenceCounts": { "$ref": "#/components/schemas/UserGroupReferenceCounts" }, "referenceCount": { "type": "integer", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "UserGroupWriteRequest": { "required": [ "name" ], "properties": { "name": { "type": "string", "maxLength": 120 }, "handle": { "description": "Stable group handle. Defaults to a normalized form of name.", "type": "string" }, "description": { "type": [ "string", "null" ] }, "planningType": { "description": "Planning metadata. Team groups can be used as planning timeline lanes.", "type": "string", "enum": [ "normal", "team" ] }, "memberIds": { "type": "array", "items": { "type": "string" } }, "archived": { "description": "Only used by update requests.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "UserSummary": { "required": [ "id", "displayName", "email" ], "properties": { "id": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "hasAvatar": { "type": "boolean" }, "avatarUrl": { "type": [ "string", "null" ] }, "avatarUpdatedAt": { "type": [ "string", "null" ], "format": "date-time" } }, "type": "object", "additionalProperties": false }, "ValidationErrorResponse": { "description": "The request payload or parameters failed validation.", "required": [ "error" ], "properties": { "error": { "description": "Machine-readable or human-readable validation error.", "type": "string", "example": "invalid payload" }, "code": { "description": "Stable machine-readable error code.", "type": [ "string", "null" ], "example": "company_name_required" }, "message": { "description": "Optional client-displayable message.", "type": [ "string", "null" ], "example": "A company name is required." } }, "type": "object", "additionalProperties": false } }, "responses": { "TooManyRequests": { "description": "API rate limit exceeded.", "headers": { "Retry-After": { "description": "Seconds until the client should retry.", "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Limit": { "description": "Configured request limit for the current window.", "schema": { "type": "integer", "minimum": 1 } }, "X-RateLimit-Remaining": { "description": "Remaining requests in the current window.", "schema": { "type": "integer", "minimum": 0 } }, "X-RateLimit-Reset": { "description": "Unix timestamp when the current window resets.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Dashboard", "description": "Dashboard" }, { "name": "Users", "description": "Users" }, { "name": "Projects", "description": "Projects" }, { "name": "Sprints", "description": "Sprints" }, { "name": "Statuses", "description": "Statuses" }, { "name": "Issue types", "description": "Issue types" }, { "name": "Tags", "description": "Tags" }, { "name": "Timers", "description": "Timers" }, { "name": "Time entries", "description": "Time entries" }, { "name": "Companies", "description": "Companies" }, { "name": "Comments", "description": "Comments" }, { "name": "Presets", "description": "Presets" }, { "name": "Authentication", "description": "Authentication" }, { "name": "Billing", "description": "Billing" }, { "name": "Calendars", "description": "Calendars" }, { "name": "Public", "description": "Public" }, { "name": "Chat", "description": "Chat" }, { "name": "Docs", "description": "Docs" }, { "name": "Attachments", "description": "Attachments" }, { "name": "Archive", "description": "Archive" }, { "name": "Planning", "description": "Planning" }, { "name": "Boards", "description": "Boards" }, { "name": "Webhooks", "description": "Webhooks" }, { "name": "Search", "description": "Search" }, { "name": "Settings", "description": "Settings" }, { "name": "Tickets", "description": "Tickets" }, { "name": "Ticket relations", "description": "Ticket relations" }, { "name": "Ticket templates", "description": "Ticket templates" }, { "name": "User groups", "description": "User groups" } ] }