{ "components": { "schemas": { "ADRCardLink": { "properties": { "card_id": { "title": "Card Id", "type": "string" } }, "required": [ "card_id" ], "title": "ADRCardLink", "type": "object" }, "ADRCreate": { "properties": { "alternatives_considered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alternatives Considered" }, "consequences": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consequences" }, "context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context" }, "decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision" }, "related_decisions": { "default": [], "items": { "type": "string" }, "title": "Related Decisions", "type": "array" }, "title": { "maxLength": 500, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "ADRCreate", "type": "object" }, "ADRRejectRequest": { "properties": { "comment": { "title": "Comment", "type": "string" } }, "required": [ "comment" ], "title": "ADRRejectRequest", "type": "object" }, "ADRSignatureRequest": { "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "user_ids": { "items": { "type": "string" }, "minItems": 1, "title": "User Ids", "type": "array" } }, "required": [ "user_ids" ], "title": "ADRSignatureRequest", "type": "object" }, "ADRUpdate": { "properties": { "alternatives_considered": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alternatives Considered" }, "consequences": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consequences" }, "context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context" }, "decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision" }, "related_decisions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Related Decisions" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "ADRUpdate", "type": "object" }, "AiFieldSuggestion": { "properties": { "confidence": { "default": 0.0, "maximum": 1.0, "minimum": 0.0, "title": "Confidence", "type": "number" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "title": "Value" } }, "title": "AiFieldSuggestion", "type": "object" }, "AiSettingsPayload": { "properties": { "api_key": { "default": "", "title": "Api Key", "type": "string" }, "enabled": { "default": false, "title": "Enabled", "type": "boolean" }, "enabled_types": { "default": [], "items": { "type": "string" }, "title": "Enabled Types", "type": "array" }, "model": { "default": "", "title": "Model", "type": "string" }, "portfolio_insights_enabled": { "default": false, "title": "Portfolio Insights Enabled", "type": "boolean" }, "provider_type": { "default": "ollama", "title": "Provider Type", "type": "string" }, "provider_url": { "default": "", "title": "Provider Url", "type": "string" }, "search_provider": { "default": "duckduckgo", "title": "Search Provider", "type": "string" }, "search_url": { "default": "", "title": "Search Url", "type": "string" } }, "title": "AiSettingsPayload", "type": "object" }, "AiSourceRef": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "title": "AiSourceRef", "type": "object" }, "AiSuggestRequest": { "properties": { "context": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Context" }, "name": { "maxLength": 500, "minLength": 1, "title": "Name", "type": "string" }, "subtype": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type_key": { "maxLength": 100, "minLength": 1, "title": "Type Key", "type": "string" } }, "required": [ "type_key", "name" ], "title": "AiSuggestRequest", "type": "object" }, "AiSuggestResponse": { "properties": { "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "search_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Provider" }, "sources": { "default": [], "items": { "$ref": "#/components/schemas/AiSourceRef" }, "title": "Sources", "type": "array" }, "suggestions": { "additionalProperties": { "$ref": "#/components/schemas/AiFieldSuggestion" }, "default": {}, "title": "Suggestions", "type": "object" } }, "title": "AiSuggestResponse", "type": "object" }, "AppTitlePayload": { "properties": { "app_title": { "default": "", "maxLength": 64, "title": "App Title", "type": "string" } }, "title": "AppTitlePayload", "type": "object" }, "ApplyBody": { "properties": { "response_ids": { "items": { "type": "string" }, "title": "Response Ids", "type": "array" } }, "required": [ "response_ids" ], "title": "ApplyBody", "type": "object" }, "ArchiveImpactCardRef": { "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "name", "type" ], "title": "ArchiveImpactCardRef", "type": "object" }, "ArchiveImpactChild": { "properties": { "approval_status": { "default": "DRAFT", "title": "Approval Status", "type": "string" }, "descendants_count": { "default": 0, "title": "Descendants Count", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "name", "type" ], "title": "ArchiveImpactChild", "type": "object" }, "ArchiveImpactRelatedCard": { "properties": { "direction": { "enum": [ "outgoing", "incoming" ], "title": "Direction", "type": "string" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "relation_id": { "title": "Relation Id", "type": "string" }, "relation_label": { "title": "Relation Label", "type": "string" }, "relation_type_key": { "title": "Relation Type Key", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "name", "type", "relation_id", "relation_type_key", "relation_label", "direction" ], "title": "ArchiveImpactRelatedCard", "type": "object" }, "ArchiveImpactResponse": { "properties": { "approved_descendant_count": { "title": "Approved Descendant Count", "type": "integer" }, "child_count": { "title": "Child Count", "type": "integer" }, "children": { "items": { "$ref": "#/components/schemas/ArchiveImpactChild" }, "title": "Children", "type": "array" }, "descendant_count": { "title": "Descendant Count", "type": "integer" }, "grandparent": { "anyOf": [ { "$ref": "#/components/schemas/ArchiveImpactCardRef" }, { "type": "null" } ] }, "related_cards": { "items": { "$ref": "#/components/schemas/ArchiveImpactRelatedCard" }, "title": "Related Cards", "type": "array" } }, "required": [ "child_count", "descendant_count", "approved_descendant_count", "children", "related_cards" ], "title": "ArchiveImpactResponse", "type": "object" }, "AutoMappedColumn": { "description": "One source-platform column that the parser auto-routes to a TEA slot.\n\nSourced from the adapter's ``auto_mapped_columns`` table. Surfaced\nverbatim in the admin's \"Map imported fields\" tab so the admin can\nsee at a glance which native columns are already handled and don't\nneed an entry in the per-field list.", "properties": { "source_column": { "title": "Source Column", "type": "string" }, "tea_target": { "title": "Tea Target", "type": "string" } }, "required": [ "source_column", "tea_target" ], "title": "AutoMappedColumn", "type": "object" }, "Body_import_bpmn_api_v1_bpm_processes__process_id__diagram_import_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_import_bpmn_api_v1_bpm_processes__process_id__diagram_import_post", "type": "object" }, "Body_import_documents_api_v1_documents_import_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_import_documents_api_v1_documents_import_post", "type": "object" }, "Body_upload_favicon_api_v1_settings_favicon_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_upload_favicon_api_v1_settings_favicon_post", "type": "object" }, "Body_upload_file_attachment_api_v1_cards__card_id__file_attachments_post": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_upload_file_attachment_api_v1_cards__card_id__file_attachments_post", "type": "object" }, "Body_upload_logo_api_v1_settings_logo_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } }, "required": [ "file" ], "title": "Body_upload_logo_api_v1_settings_logo_post", "type": "object" }, "Body_upload_snapshot_api_v1_migration_upload_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "include_archived": { "default": false, "title": "Include Archived", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "source_key": { "description": "Registered source adapter key (e.g. 'leanix')", "title": "Source Key", "type": "string" } }, "required": [ "source_key", "name", "file" ], "title": "Body_upload_snapshot_api_v1_migration_upload_post", "type": "object" }, "BookmarkCreate": { "properties": { "card_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type" }, "columns": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Columns" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "is_default": { "default": false, "title": "Is Default", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "odata_enabled": { "default": false, "title": "Odata Enabled", "type": "boolean" }, "shared_with": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BookmarkShareEntry" }, "type": "array" }, { "type": "null" } ], "title": "Shared With" }, "sort": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sort" }, "visibility": { "default": "private", "title": "Visibility", "type": "string" } }, "required": [ "name" ], "title": "BookmarkCreate", "type": "object" }, "BookmarkShareEntry": { "properties": { "can_edit": { "default": false, "title": "Can Edit", "type": "boolean" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "BookmarkShareEntry", "type": "object" }, "BookmarkUpdate": { "properties": { "card_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type" }, "columns": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Columns" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Default" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "odata_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Odata Enabled" }, "shared_with": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BookmarkShareEntry" }, "type": "array" }, { "type": "null" } ], "title": "Shared With" }, "sort": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sort" }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Visibility" } }, "title": "BookmarkUpdate", "type": "object" }, "BpmEnabledPayload": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "BpmEnabledPayload", "type": "object" }, "BpmRowOrderPayload": { "properties": { "row_order": { "items": { "type": "string" }, "title": "Row Order", "type": "array" } }, "required": [ "row_order" ], "title": "BpmRowOrderPayload", "type": "object" }, "CalculationCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "execution_order": { "default": 0, "title": "Execution Order", "type": "integer" }, "formula": { "maxLength": 5000, "title": "Formula", "type": "string" }, "name": { "maxLength": 300, "title": "Name", "type": "string" }, "target_field_key": { "maxLength": 200, "title": "Target Field Key", "type": "string" }, "target_type_key": { "maxLength": 100, "title": "Target Type Key", "type": "string" } }, "required": [ "name", "target_type_key", "target_field_key", "formula" ], "title": "CalculationCreate", "type": "object" }, "CalculationResponse": { "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "execution_order": { "title": "Execution Order", "type": "integer" }, "formula": { "title": "Formula", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "last_run_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run At" }, "name": { "title": "Name", "type": "string" }, "target_field_key": { "title": "Target Field Key", "type": "string" }, "target_type_key": { "title": "Target Type Key", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "name", "target_type_key", "target_field_key", "formula", "is_active", "execution_order" ], "title": "CalculationResponse", "type": "object" }, "CalculationUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "execution_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Execution Order" }, "formula": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "type": "null" } ], "title": "Formula" }, "name": { "anyOf": [ { "maxLength": 300, "type": "string" }, { "type": "null" } ], "title": "Name" }, "target_field_key": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Target Field Key" }, "target_type_key": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "title": "Target Type Key" } }, "title": "CalculationUpdate", "type": "object" }, "CardArchiveRequest": { "properties": { "cascade_all_related": { "default": false, "title": "Cascade All Related", "type": "boolean" }, "child_strategy": { "anyOf": [ { "enum": [ "cascade", "disconnect", "reparent" ], "type": "string" }, { "type": "null" } ], "title": "Child Strategy" }, "related_card_ids": { "items": { "type": "string" }, "maxItems": 200, "title": "Related Card Ids", "type": "array" } }, "title": "CardArchiveRequest", "type": "object" }, "CardArchiveResponse": { "properties": { "affected_children_ids": { "items": { "type": "string" }, "title": "Affected Children Ids", "type": "array" }, "affected_related_card_ids": { "items": { "type": "string" }, "title": "Affected Related Card Ids", "type": "array" }, "primary": { "$ref": "#/components/schemas/CardResponse" } }, "required": [ "primary", "affected_children_ids", "affected_related_card_ids" ], "title": "CardArchiveResponse", "type": "object" }, "CardBulkArchiveRequest": { "properties": { "card_ids": { "items": { "type": "string" }, "maxItems": 10000, "minItems": 1, "title": "Card Ids", "type": "array" }, "cascade_all_related": { "default": false, "title": "Cascade All Related", "type": "boolean" }, "child_strategy": { "anyOf": [ { "enum": [ "cascade", "disconnect", "reparent" ], "type": "string" }, { "type": "null" } ], "title": "Child Strategy" } }, "required": [ "card_ids" ], "title": "CardBulkArchiveRequest", "type": "object" }, "CardBulkArchiveResponse": { "properties": { "archived_card_ids": { "items": { "type": "string" }, "title": "Archived Card Ids", "type": "array" }, "cascaded_card_ids": { "items": { "type": "string" }, "title": "Cascaded Card Ids", "type": "array" }, "requested": { "title": "Requested", "type": "integer" }, "skipped": { "items": { "$ref": "#/components/schemas/CardBulkSkippedEntry" }, "title": "Skipped", "type": "array" } }, "required": [ "requested", "archived_card_ids", "cascaded_card_ids", "skipped" ], "title": "CardBulkArchiveResponse", "type": "object" }, "CardBulkCreateItem": { "description": "One row of a bulk-create request. Mirrors `CardCreate` plus an\noptional parent reference + a stable `row_index` so the caller can\npair the response back to its spreadsheet row.\n\nEither `parent_id` (UUID) or `parent_ref` may be supplied \u2014 never both.\nServer-side topological sort handles parents that are themselves rows\nin the same request (referenced by `parent_ref` and the row's own\n`(parent_path, name)` identity).", "properties": { "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias" }, "approval_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approval Status" }, "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "lifecycle": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Lifecycle" }, "name": { "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "parent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Name" }, "parent_path": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Parent Path" }, "row_index": { "title": "Row Index", "type": "integer" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type": { "title": "Type", "type": "string" } }, "required": [ "row_index", "type", "name" ], "title": "CardBulkCreateItem", "type": "object" }, "CardBulkCreateRequest": { "properties": { "cards": { "items": { "$ref": "#/components/schemas/CardBulkCreateItem" }, "maxItems": 2000, "minItems": 1, "title": "Cards", "type": "array" }, "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" } }, "required": [ "cards" ], "title": "CardBulkCreateRequest", "type": "object" }, "CardBulkCreateResponse": { "properties": { "created": { "title": "Created", "type": "integer" }, "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "failed": { "title": "Failed", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/CardBulkCreateResult" }, "title": "Results", "type": "array" } }, "required": [ "results", "created", "failed" ], "title": "CardBulkCreateResponse", "type": "object" }, "CardBulkCreateResult": { "description": "Per-row outcome. `id` is set on success, `error` on failure.", "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "row_index": { "title": "Row Index", "type": "integer" }, "status": { "enum": [ "created", "failed" ], "title": "Status", "type": "string" } }, "required": [ "row_index", "status" ], "title": "CardBulkCreateResult", "type": "object" }, "CardBulkDeleteRequest": { "properties": { "card_ids": { "items": { "type": "string" }, "maxItems": 10000, "minItems": 1, "title": "Card Ids", "type": "array" }, "cascade_all_related": { "default": false, "title": "Cascade All Related", "type": "boolean" }, "child_strategy": { "anyOf": [ { "enum": [ "cascade", "disconnect", "reparent" ], "type": "string" }, { "type": "null" } ], "title": "Child Strategy" } }, "required": [ "card_ids" ], "title": "CardBulkDeleteRequest", "type": "object" }, "CardBulkDeleteResponse": { "properties": { "cascaded_card_ids": { "items": { "type": "string" }, "title": "Cascaded Card Ids", "type": "array" }, "deleted_card_ids": { "items": { "type": "string" }, "title": "Deleted Card Ids", "type": "array" }, "requested": { "title": "Requested", "type": "integer" }, "skipped": { "items": { "$ref": "#/components/schemas/CardBulkDeleteSkippedEntry" }, "title": "Skipped", "type": "array" } }, "required": [ "requested", "deleted_card_ids", "cascaded_card_ids", "skipped" ], "title": "CardBulkDeleteResponse", "type": "object" }, "CardBulkDeleteSkippedEntry": { "properties": { "card_id": { "title": "Card Id", "type": "string" }, "reason": { "const": "not_found", "title": "Reason", "type": "string" } }, "required": [ "card_id", "reason" ], "title": "CardBulkDeleteSkippedEntry", "type": "object" }, "CardBulkRestoreRequest": { "properties": { "card_ids": { "items": { "type": "string" }, "maxItems": 10000, "minItems": 1, "title": "Card Ids", "type": "array" } }, "required": [ "card_ids" ], "title": "CardBulkRestoreRequest", "type": "object" }, "CardBulkRestoreResponse": { "properties": { "requested": { "title": "Requested", "type": "integer" }, "restored_card_ids": { "items": { "type": "string" }, "title": "Restored Card Ids", "type": "array" }, "skipped": { "items": { "$ref": "#/components/schemas/CardBulkRestoreSkippedEntry" }, "title": "Skipped", "type": "array" } }, "required": [ "requested", "restored_card_ids", "skipped" ], "title": "CardBulkRestoreResponse", "type": "object" }, "CardBulkRestoreSkippedEntry": { "properties": { "card_id": { "title": "Card Id", "type": "string" }, "reason": { "enum": [ "already_active", "not_found" ], "title": "Reason", "type": "string" } }, "required": [ "card_id", "reason" ], "title": "CardBulkRestoreSkippedEntry", "type": "object" }, "CardBulkSkippedEntry": { "properties": { "card_id": { "title": "Card Id", "type": "string" }, "reason": { "enum": [ "already_archived", "not_found" ], "title": "Reason", "type": "string" } }, "required": [ "card_id", "reason" ], "title": "CardBulkSkippedEntry", "type": "object" }, "CardBulkUpdate": { "properties": { "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "ids": { "items": { "type": "string" }, "title": "Ids", "type": "array" }, "updates": { "$ref": "#/components/schemas/CardUpdate" } }, "required": [ "ids", "updates" ], "title": "CardBulkUpdate", "type": "object" }, "CardCountsResponse": { "properties": { "by_type": { "items": { "$ref": "#/components/schemas/CardTypeCount" }, "title": "By Type", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "by_type", "total" ], "title": "CardCountsResponse", "type": "object" }, "CardCreate": { "properties": { "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias" }, "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "lifecycle": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Lifecycle" }, "name": { "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "strict_attributes": { "default": false, "title": "Strict Attributes", "type": "boolean" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "name" ], "title": "CardCreate", "type": "object" }, "CardDeleteRequest": { "properties": { "cascade_all_related": { "default": false, "title": "Cascade All Related", "type": "boolean" }, "child_strategy": { "anyOf": [ { "enum": [ "cascade", "disconnect", "reparent" ], "type": "string" }, { "type": "null" } ], "title": "Child Strategy" }, "related_card_ids": { "items": { "type": "string" }, "maxItems": 200, "title": "Related Card Ids", "type": "array" } }, "title": "CardDeleteRequest", "type": "object" }, "CardDeleteResponse": { "properties": { "affected_children_ids": { "items": { "type": "string" }, "title": "Affected Children Ids", "type": "array" }, "affected_related_card_ids": { "items": { "type": "string" }, "title": "Affected Related Card Ids", "type": "array" }, "deleted_card_ids": { "items": { "type": "string" }, "title": "Deleted Card Ids", "type": "array" } }, "required": [ "deleted_card_ids", "affected_children_ids", "affected_related_card_ids" ], "title": "CardDeleteResponse", "type": "object" }, "CardListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CardResponse" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "CardListResponse", "type": "object" }, "CardRef": { "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "type", "name" ], "title": "CardRef", "type": "object" }, "CardRefCandidate": { "properties": { "id": { "title": "Id", "type": "string" }, "path": { "title": "Path", "type": "string" } }, "required": [ "id", "path" ], "title": "CardRefCandidate", "type": "object" }, "CardRefInput": { "description": "One ref to resolve, with `row` / `column` echoed back so the caller\ncan pin the result to the originating spreadsheet cell.\n\n`ref` is the user-typed string (`\"NexaCore ERP\"` or\n`\"Sales / Customer Mgmt / CRM\"`, using the same escape rules as\n`parent_path`). `type` is the expected card type for the lookup \u2014\ninferred by the importer from the relation type's `target_type_key`\n(for relation cells) or from the row's own `type` column (for parent\nrefs).", "properties": { "column": { "title": "Column", "type": "string" }, "ref": { "title": "Ref", "type": "string" }, "row": { "title": "Row", "type": "integer" }, "type": { "title": "Type", "type": "string" } }, "required": [ "row", "column", "type", "ref" ], "title": "CardRefInput", "type": "object" }, "CardRefResolveRequest": { "properties": { "refs": { "items": { "$ref": "#/components/schemas/CardRefInput" }, "maxItems": 5000, "title": "Refs", "type": "array" } }, "required": [ "refs" ], "title": "CardRefResolveRequest", "type": "object" }, "CardRefResolveResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/CardRefResolveResult" }, "title": "Results", "type": "array" } }, "required": [ "results" ], "title": "CardRefResolveResponse", "type": "object" }, "CardRefResolveResult": { "properties": { "candidates": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CardRefCandidate" }, "type": "array" }, { "type": "null" } ], "title": "Candidates" }, "column": { "title": "Column", "type": "string" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "row": { "title": "Row", "type": "integer" }, "status": { "enum": [ "resolved", "ambiguous", "missing" ], "title": "Status", "type": "string" } }, "required": [ "row", "column", "status" ], "title": "CardRefResolveResult", "type": "object" }, "CardRelationSummaryEntry": { "description": "One row of the relation-summary endpoint \u2014 counts neighbours per\nrelation-type / direction so the diagram editor can render LeanIX-style\nShow Dependency / Drill-Down / Roll-Up submenus with live counts.", "properties": { "count": { "title": "Count", "type": "integer" }, "direction": { "title": "Direction", "type": "string" }, "label": { "title": "Label", "type": "string" }, "peer_type_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Peer Type Key" }, "relation_type_key": { "title": "Relation Type Key", "type": "string" } }, "required": [ "relation_type_key", "label", "direction", "count" ], "title": "CardRelationSummaryEntry", "type": "object" }, "CardRelationSummaryHierarchy": { "description": "Hierarchy snapshot returned alongside relation counts so the diagram\neditor can enable/disable the Drill-Down + Roll-Up menu sections without\na second fetch.", "properties": { "children_count": { "title": "Children Count", "type": "integer" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "parent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Name" }, "parent_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Type" } }, "required": [ "children_count" ], "title": "CardRelationSummaryHierarchy", "type": "object" }, "CardRelationSummaryResponse": { "properties": { "by_type": { "items": { "$ref": "#/components/schemas/CardRelationSummaryEntry" }, "title": "By Type", "type": "array" }, "hierarchy": { "$ref": "#/components/schemas/CardRelationSummaryHierarchy" } }, "required": [ "by_type", "hierarchy" ], "title": "CardRelationSummaryResponse", "type": "object" }, "CardResponse": { "properties": { "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias" }, "approval_status": { "title": "Approval Status", "type": "string" }, "archived_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Archived At" }, "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "data_quality": { "title": "Data Quality", "type": "number" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "id": { "title": "Id", "type": "string" }, "lifecycle": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Lifecycle" }, "name": { "title": "Name", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "stakeholders": { "default": [], "items": { "$ref": "#/components/schemas/StakeholderRef" }, "title": "Stakeholders", "type": "array" }, "status": { "title": "Status", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "tags": { "default": [], "items": { "$ref": "#/components/schemas/TagRef" }, "title": "Tags", "type": "array" }, "type": { "title": "Type", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" } }, "required": [ "id", "type", "name", "status", "approval_status", "data_quality" ], "title": "CardResponse", "type": "object" }, "CardRestoreRequest": { "properties": { "also_restore_card_ids": { "items": { "type": "string" }, "maxItems": 200, "title": "Also Restore Card Ids", "type": "array" } }, "title": "CardRestoreRequest", "type": "object" }, "CardRestoreResponse": { "properties": { "primary": { "$ref": "#/components/schemas/CardResponse" }, "restored_passenger_ids": { "items": { "type": "string" }, "title": "Restored Passenger Ids", "type": "array" } }, "required": [ "primary", "restored_passenger_ids" ], "title": "CardRestoreResponse", "type": "object" }, "CardTypeCount": { "properties": { "count": { "title": "Count", "type": "integer" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "count" ], "title": "CardTypeCount", "type": "object" }, "CardUpdate": { "properties": { "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias" }, "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "lifecycle": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Lifecycle" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "strict_attributes": { "default": false, "title": "Strict Attributes", "type": "boolean" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" } }, "title": "CardUpdate", "type": "object" }, "CommentCreate": { "properties": { "content": { "maxLength": 10000, "minLength": 1, "title": "Content", "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, "required": [ "content" ], "title": "CommentCreate", "type": "object" }, "CommentUpdate": { "properties": { "content": { "maxLength": 10000, "minLength": 1, "title": "Content", "type": "string" } }, "required": [ "content" ], "title": "CommentUpdate", "type": "object" }, "ComplianceBundleOut": { "properties": { "findings": { "items": { "$ref": "#/components/schemas/ComplianceFindingOut" }, "title": "Findings", "type": "array" }, "is_enabled": { "default": true, "title": "Is Enabled", "type": "boolean" }, "is_known": { "default": true, "title": "Is Known", "type": "boolean" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "regulation": { "title": "Regulation", "type": "string" }, "score": { "default": 0, "title": "Score", "type": "integer" } }, "required": [ "regulation" ], "title": "ComplianceBundleOut", "type": "object" }, "ComplianceFindingAiVerdict": { "description": "Body for ``POST /security/compliance-findings/{id}/ai-verdict``.\n\nCaptures the user's verdict on the scanner's AI-detection claim and\npersists it on the impacted card's ``hasAiFeatures`` attribute.", "properties": { "verdict": { "title": "Verdict", "type": "string" } }, "required": [ "verdict" ], "title": "ComplianceFindingAiVerdict", "type": "object" }, "ComplianceFindingBulkDecisionUpdate": { "description": "Body for ``PATCH /security/compliance-findings/bulk``.\n\nBulk transition of multiple findings to a single new ``decision``.\nPer-row lifecycle validation still runs; rows where the transition\nisn't allowed (or that are tracked by an active Risk) are reported\nin the response's ``skipped`` list with a reason \u2014 the rest succeed.", "properties": { "decision": { "title": "Decision", "type": "string" }, "ids": { "items": { "type": "string" }, "title": "Ids", "type": "array" }, "review_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Note" } }, "required": [ "ids", "decision" ], "title": "ComplianceFindingBulkDecisionUpdate", "type": "object" }, "ComplianceFindingBulkDelete": { "description": "Body for ``DELETE /security/compliance-findings/bulk``.\n\nAccepts a list of finding ids; rows the caller can't see (or that\ndon't exist) are reported in the response's ``skipped`` list.", "properties": { "ids": { "items": { "type": "string" }, "title": "Ids", "type": "array" } }, "required": [ "ids" ], "title": "ComplianceFindingBulkDelete", "type": "object" }, "ComplianceFindingBulkResult": { "description": "Outcome of a bulk delete or bulk decision update.\n\n``updated`` is the count of rows the call actually changed.\n``skipped`` lists rows that were left untouched, each with a\n``reason`` (\"not_found\", \"illegal_transition\", \"risk_tracked\", \u2026).", "properties": { "skipped": { "default": [], "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "title": "Skipped", "type": "array" }, "updated": { "title": "Updated", "type": "integer" } }, "required": [ "updated" ], "title": "ComplianceFindingBulkResult", "type": "object" }, "ComplianceFindingCreate": { "description": "Body for ``POST /security/compliance-findings`` \u2014 manual finding entry.\n\nUsed by auditors / GRC analysts who want to record a finding the\nscanner didn't pick up. The endpoint creates a synthetic \"manual\"\n:class:`TurboLensAnalysisRun` to satisfy the FK and persists a row\nwith ``decision='new'`` so the lifecycle starts at the same place\nas scanner-emitted findings.", "properties": { "card_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Id" }, "category": { "default": "", "title": "Category", "type": "string" }, "evidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence" }, "gap_description": { "default": "", "title": "Gap Description", "type": "string" }, "regulation": { "title": "Regulation", "type": "string" }, "regulation_article": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulation Article" }, "remediation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remediation" }, "requirement": { "title": "Requirement", "type": "string" }, "severity": { "title": "Severity", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "regulation", "requirement", "status", "severity" ], "title": "ComplianceFindingCreate", "type": "object" }, "ComplianceFindingDecisionUpdate": { "description": "Body for ``PATCH /security/compliance-findings/{id}``.\n\nUsers transition the decision through the compliance lifecycle\nstates ``new``, ``in_review``, ``mitigated``, ``verified``,\n``accepted`` and ``not_applicable``. Allowed transitions are\nenforced server-side by ``compliance_lifecycle_allowed``.\n``risk_tracked`` is set automatically when a finding is promoted to\na Risk (``POST /risks/promote/compliance/{id}``); ``auto_resolved``\nis set by the scanner when a re-scan no longer reports the finding.\nNeither is user-settable.", "properties": { "decision": { "title": "Decision", "type": "string" }, "review_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Note" } }, "required": [ "decision" ], "title": "ComplianceFindingDecisionUpdate", "type": "object" }, "ComplianceFindingOut": { "properties": { "ai_detected": { "default": false, "title": "Ai Detected", "type": "boolean" }, "auto_resolved": { "default": false, "title": "Auto Resolved", "type": "boolean" }, "card_has_ai_features": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Card Has Ai Features" }, "card_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Id" }, "card_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Name" }, "card_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type" }, "category": { "default": "", "title": "Category", "type": "string" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "decision": { "default": "new", "title": "Decision", "type": "string" }, "evidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence" }, "gap_description": { "default": "", "title": "Gap Description", "type": "string" }, "id": { "title": "Id", "type": "string" }, "last_seen_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen Run Id" }, "regulation": { "title": "Regulation", "type": "string" }, "regulation_article": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulation Article" }, "remediation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remediation" }, "requirement": { "default": "", "title": "Requirement", "type": "string" }, "review_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Note" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewed By" }, "reviewer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewer Name" }, "risk_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Risk Id" }, "risk_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Risk Reference" }, "run_id": { "title": "Run Id", "type": "string" }, "scope_type": { "default": "landscape", "title": "Scope Type", "type": "string" }, "severity": { "default": "info", "title": "Severity", "type": "string" }, "status": { "default": "review_needed", "title": "Status", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "run_id", "regulation" ], "title": "ComplianceFindingOut", "type": "object" }, "ComplianceRegulationCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_enabled": { "default": true, "title": "Is Enabled", "type": "boolean" }, "key": { "maxLength": 100, "minLength": 1, "title": "Key", "type": "string" }, "label": { "maxLength": 300, "minLength": 1, "title": "Label", "type": "string" }, "sort_order": { "default": 0, "title": "Sort Order", "type": "integer" }, "translations": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Translations" } }, "required": [ "key", "label" ], "title": "ComplianceRegulationCreate", "type": "object" }, "ComplianceRegulationUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Enabled" }, "label": { "anyOf": [ { "maxLength": 300, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Label" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "translations": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Translations" } }, "title": "ComplianceRegulationUpdate", "type": "object" }, "ConnectionCreate": { "properties": { "auth_type": { "default": "basic", "pattern": "^(basic|oauth2)$", "title": "Auth Type", "type": "string" }, "client_id": { "default": "", "title": "Client Id", "type": "string" }, "client_secret": { "default": "", "title": "Client Secret", "type": "string" }, "instance_url": { "maxLength": 500, "minLength": 1, "title": "Instance Url", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "password": { "default": "", "title": "Password", "type": "string" }, "username": { "default": "", "title": "Username", "type": "string" } }, "required": [ "name", "instance_url" ], "title": "ConnectionCreate", "type": "object" }, "ConnectionOut": { "properties": { "auth_type": { "title": "Auth Type", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "id": { "title": "Id", "type": "string" }, "instance_url": { "title": "Instance Url", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "last_tested_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Tested At" }, "mapping_count": { "default": 0, "title": "Mapping Count", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "test_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Test Status" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "name", "instance_url", "auth_type", "is_active" ], "title": "ConnectionOut", "type": "object" }, "ConnectionUpdate": { "properties": { "auth_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Type" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "instance_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instance Url" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "title": "ConnectionUpdate", "type": "object" }, "CurrencyPayload": { "properties": { "currency": { "default": "USD", "title": "Currency", "type": "string" } }, "title": "CurrencyPayload", "type": "object" }, "DateFormatPayload": { "properties": { "date_format": { "default": "DD MMM YYYY", "title": "Date Format", "type": "string" } }, "title": "DateFormatPayload", "type": "object" }, "DiagramCreate": { "properties": { "card_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Card Ids" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "title": "Name", "type": "string" }, "type": { "default": "free_draw", "title": "Type", "type": "string" } }, "required": [ "name" ], "title": "DiagramCreate", "type": "object" }, "DiagramSave": { "properties": { "bpmn_xml": { "title": "Bpmn Xml", "type": "string" }, "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "svg_thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Svg Thumbnail" } }, "required": [ "bpmn_xml" ], "title": "DiagramSave", "type": "object" }, "DiagramUpdate": { "properties": { "card_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Card Ids" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "title": "DiagramUpdate", "type": "object" }, "DocumentCreate": { "properties": { "name": { "title": "Name", "type": "string" }, "type": { "default": "link", "title": "Type", "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "required": [ "name" ], "title": "DocumentCreate", "type": "object" }, "DuplicateClusterOut": { "properties": { "analysed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Analysed At" }, "card_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Card Ids" }, "card_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Card Names" }, "card_type": { "title": "Card Type", "type": "string" }, "cluster_name": { "title": "Cluster Name", "type": "string" }, "evidence": { "default": "", "title": "Evidence", "type": "string" }, "functional_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Functional Domain" }, "id": { "title": "Id", "type": "string" }, "recommendation": { "default": "", "title": "Recommendation", "type": "string" }, "status": { "default": "pending", "title": "Status", "type": "string" } }, "required": [ "id", "cluster_name", "card_type" ], "title": "DuplicateClusterOut", "type": "object" }, "ElementUpdate": { "description": "Update EA cross-references on an extracted BPMN element.", "properties": { "application_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Id" }, "custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Fields" }, "data_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Object Id" }, "it_component_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "It Component Id" } }, "title": "ElementUpdate", "type": "object" }, "EmailSettingsPayload": { "properties": { "app_base_url": { "default": "", "title": "App Base Url", "type": "string" }, "smtp_from": { "default": "noreply@turboea.local", "title": "Smtp From", "type": "string" }, "smtp_host": { "default": "", "title": "Smtp Host", "type": "string" }, "smtp_password": { "default": "", "title": "Smtp Password", "type": "string" }, "smtp_port": { "default": 587, "title": "Smtp Port", "type": "integer" }, "smtp_tls": { "default": true, "title": "Smtp Tls", "type": "boolean" }, "smtp_user": { "default": "", "title": "Smtp User", "type": "string" } }, "title": "EmailSettingsPayload", "type": "object" }, "EnabledLocalesPayload": { "properties": { "locales": { "items": { "type": "string" }, "title": "Locales", "type": "array" } }, "required": [ "locales" ], "title": "EnabledLocalesPayload", "type": "object" }, "EolCycle": { "description": "A single release cycle for a product.", "properties": { "codename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Codename" }, "cycle": { "title": "Cycle", "type": "string" }, "discontinued": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "null" } ], "title": "Discontinued" }, "eol": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "null" } ], "title": "Eol" }, "latest": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest" }, "latestReleaseDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latestreleasedate" }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Link" }, "lts": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "null" } ], "title": "Lts" }, "releaseDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Releasedate" }, "support": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "null" } ], "title": "Support" } }, "required": [ "cycle" ], "title": "EolCycle", "type": "object" }, "EolProduct": { "description": "A product identifier returned from the product list.", "properties": { "name": { "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "EolProduct", "type": "object" }, "EolProductMatch": { "description": "A product with a fuzzy match score.", "properties": { "name": { "title": "Name", "type": "string" }, "score": { "title": "Score", "type": "number" } }, "required": [ "name", "score" ], "title": "EolProductMatch", "type": "object" }, "FieldMappingIn": { "properties": { "direction": { "default": "snow_leads", "pattern": "^(snow_leads|turbo_leads)$", "title": "Direction", "type": "string" }, "is_identity": { "default": false, "title": "Is Identity", "type": "boolean" }, "snow_field": { "title": "Snow Field", "type": "string" }, "transform_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Transform Config" }, "transform_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transform Type" }, "turbo_field": { "title": "Turbo Field", "type": "string" } }, "required": [ "turbo_field", "snow_field" ], "title": "FieldMappingIn", "type": "object" }, "FieldMappingOptions": { "description": "Payload for the field-mapping admin UI.\n\nOne block per ``(native_type, target_tea_type)`` pair surfacing the\nsource fields the parser discovered alongside the list of TEA\ntarget fields the admin can map them onto.", "properties": { "auto_mapped_columns": { "default": [], "items": { "$ref": "#/components/schemas/AutoMappedColumn" }, "title": "Auto Mapped Columns", "type": "array" }, "blocks": { "items": { "$ref": "#/components/schemas/FieldMappingTypeBlock" }, "title": "Blocks", "type": "array" } }, "required": [ "blocks" ], "title": "FieldMappingOptions", "type": "object" }, "FieldMappingOut": { "properties": { "direction": { "title": "Direction", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_identity": { "title": "Is Identity", "type": "boolean" }, "snow_field": { "title": "Snow Field", "type": "string" }, "transform_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Transform Config" }, "transform_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transform Type" }, "turbo_field": { "title": "Turbo Field", "type": "string" } }, "required": [ "id", "turbo_field", "snow_field", "direction", "is_identity" ], "title": "FieldMappingOut", "type": "object" }, "FieldMappingTypeBlock": { "properties": { "available_targets": { "items": { "$ref": "#/components/schemas/TargetFieldOption" }, "title": "Available Targets", "type": "array" }, "native_type": { "title": "Native Type", "type": "string" }, "source_fields": { "items": { "$ref": "#/components/schemas/SourceFieldRow" }, "title": "Source Fields", "type": "array" }, "target_tea_type": { "title": "Target Tea Type", "type": "string" }, "target_type_label": { "title": "Target Type Label", "type": "string" } }, "required": [ "native_type", "target_tea_type", "target_type_label", "source_fields", "available_targets" ], "title": "FieldMappingTypeBlock", "type": "object" }, "FieldMappingUpdate": { "properties": { "field_mappings": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "title": "Field Mappings", "type": "object" } }, "required": [ "field_mappings" ], "title": "FieldMappingUpdate", "type": "object" }, "FiscalYearStartPayload": { "properties": { "month": { "title": "Month", "type": "integer" } }, "required": [ "month" ], "title": "FiscalYearStartPayload", "type": "object" }, "ForgotPasswordRequest": { "properties": { "email": { "title": "Email", "type": "string" } }, "required": [ "email" ], "title": "ForgotPasswordRequest", "type": "object" }, "GrcEnabledPayload": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "GrcEnabledPayload", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "ImportPrinciplesRequest": { "properties": { "catalogue_ids": { "items": { "type": "string" }, "maxItems": 200, "minItems": 1, "title": "Catalogue Ids", "type": "array" } }, "required": [ "catalogue_ids" ], "title": "ImportPrinciplesRequest", "type": "object" }, "ImportRequest": { "properties": { "catalogue_ids": { "items": { "type": "string" }, "maxItems": 2000, "minItems": 1, "title": "Catalogue Ids", "type": "array" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" } }, "required": [ "catalogue_ids" ], "title": "ImportRequest", "type": "object" }, "LoginBrandingPayload": { "properties": { "login_help_link": { "default": "", "maxLength": 300, "title": "Login Help Link", "type": "string" }, "login_help_text": { "default": "", "maxLength": 500, "title": "Login Help Text", "type": "string" }, "login_tagline": { "default": "", "maxLength": 200, "title": "Login Tagline", "type": "string" }, "login_tagline_hidden": { "default": false, "title": "Login Tagline Hidden", "type": "boolean" } }, "title": "LoginBrandingPayload", "type": "object" }, "LoginRequest": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" }, "password": { "title": "Password", "type": "string" } }, "required": [ "email", "password" ], "title": "LoginRequest", "type": "object" }, "MappingCreate": { "properties": { "card_type_key": { "title": "Card Type Key", "type": "string" }, "connection_id": { "title": "Connection Id", "type": "string" }, "field_mappings": { "default": [], "items": { "$ref": "#/components/schemas/FieldMappingIn" }, "title": "Field Mappings", "type": "array" }, "filter_query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Query" }, "max_deletion_ratio": { "default": 0.5, "maximum": 1.0, "minimum": 0.0, "title": "Max Deletion Ratio", "type": "number" }, "skip_staging": { "default": false, "title": "Skip Staging", "type": "boolean" }, "snow_table": { "title": "Snow Table", "type": "string" }, "sync_direction": { "default": "snow_to_turbo", "pattern": "^(snow_to_turbo|turbo_to_snow|bidirectional)$", "title": "Sync Direction", "type": "string" }, "sync_mode": { "default": "conservative", "pattern": "^(additive|conservative|strict)$", "title": "Sync Mode", "type": "string" } }, "required": [ "connection_id", "card_type_key", "snow_table" ], "title": "MappingCreate", "type": "object" }, "MappingOut": { "properties": { "card_type_key": { "title": "Card Type Key", "type": "string" }, "connection_id": { "title": "Connection Id", "type": "string" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "field_mappings": { "default": [], "items": { "$ref": "#/components/schemas/FieldMappingOut" }, "title": "Field Mappings", "type": "array" }, "filter_query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Query" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "max_deletion_ratio": { "title": "Max Deletion Ratio", "type": "number" }, "skip_staging": { "default": false, "title": "Skip Staging", "type": "boolean" }, "snow_table": { "title": "Snow Table", "type": "string" }, "sync_direction": { "title": "Sync Direction", "type": "string" }, "sync_mode": { "title": "Sync Mode", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "connection_id", "card_type_key", "snow_table", "sync_direction", "sync_mode", "max_deletion_ratio", "is_active" ], "title": "MappingOut", "type": "object" }, "MappingUpdate": { "properties": { "card_type_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type Key" }, "field_mappings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FieldMappingIn" }, "type": "array" }, { "type": "null" } ], "title": "Field Mappings" }, "filter_query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Query" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "max_deletion_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Deletion Ratio" }, "skip_staging": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Skip Staging" }, "snow_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snow Table" }, "sync_direction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sync Direction" }, "sync_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sync Mode" } }, "title": "MappingUpdate", "type": "object" }, "MassEolCandidate": { "description": "A candidate EOL match for a card.", "properties": { "card_id": { "title": "Card Id", "type": "string" }, "card_name": { "title": "Card Name", "type": "string" }, "card_type": { "title": "Card Type", "type": "string" }, "eol_product": { "title": "Eol Product", "type": "string" }, "score": { "title": "Score", "type": "number" } }, "required": [ "card_id", "card_name", "card_type", "eol_product", "score" ], "title": "MassEolCandidate", "type": "object" }, "MassEolResult": { "description": "Result of mass EOL search for a single card.", "properties": { "candidates": { "items": { "$ref": "#/components/schemas/MassEolCandidate" }, "title": "Candidates", "type": "array" }, "card_id": { "title": "Card Id", "type": "string" }, "card_name": { "title": "Card Name", "type": "string" }, "card_type": { "title": "Card Type", "type": "string" }, "current_eol_cycle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Eol Cycle" }, "current_eol_product": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Eol Product" } }, "required": [ "card_id", "card_name", "card_type", "candidates" ], "title": "MassEolResult", "type": "object" }, "McpSettingsPayload": { "properties": { "enabled": { "default": false, "title": "Enabled", "type": "boolean" } }, "title": "McpSettingsPayload", "type": "object" }, "MigrationOut": { "properties": { "applied_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Applied At" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "field_mappings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Field Mappings" }, "file_hash": { "title": "File Hash", "type": "string" }, "file_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size" }, "id": { "title": "Id", "type": "string" }, "metamodel_diff": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metamodel Diff" }, "name": { "title": "Name", "type": "string" }, "parsed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parsed At" }, "snapshot_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snapshot Version" }, "source_type": { "title": "Source Type", "type": "string" }, "stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stats" }, "status": { "title": "Status", "type": "string" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "name", "source_type", "status", "file_hash", "file_size", "snapshot_version", "stats", "metamodel_diff", "field_mappings", "error_message", "parsed_at", "applied_at", "created_at", "updated_at" ], "title": "MigrationOut", "type": "object" }, "MitigationTaskCreate": { "description": "Payload for ``POST /risks/{risk_id}/mitigation-tasks``.\n\n``lead_time_days`` is optional on create \u2014 when omitted the service\nlayer picks a smart default per ``recurrence_unit`` (1 / 2 / 7 / 14\nfor daily / weekly / monthly / yearly, capped at half the cycle so\nthe lead window never overlaps the previous occurrence). One-shot\ntasks default to 0 because there is no roll-forward to gate.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "lead_time_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Lead Time Days" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "recurrence_interval": { "default": 1, "maximum": 365.0, "minimum": 1.0, "title": "Recurrence Interval", "type": "integer" }, "recurrence_unit": { "default": "none", "enum": [ "none", "days", "weeks", "months", "years" ], "title": "Recurrence Unit", "type": "string" }, "title": { "maxLength": 500, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "MitigationTaskCreate", "type": "object" }, "MitigationTaskOccurrenceOut": { "properties": { "activated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Activated At" }, "assigned_owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned Owner Id" }, "assigned_owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned Owner Name" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "completed_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed By" }, "completed_by_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed By Name" }, "completion_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completion Notes" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "id": { "title": "Id", "type": "string" }, "owner_at_completion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner At Completion" }, "owner_at_completion_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner At Completion Name" }, "sequence": { "title": "Sequence", "type": "integer" }, "status": { "enum": [ "scheduled", "open", "done", "skipped" ], "title": "Status", "type": "string" }, "task_id": { "title": "Task Id", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "task_id", "sequence", "status" ], "title": "MitigationTaskOccurrenceOut", "type": "object" }, "MitigationTaskOut": { "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "lead_time_days": { "title": "Lead Time Days", "type": "integer" }, "occurrences": { "items": { "$ref": "#/components/schemas/MitigationTaskOccurrenceOut" }, "title": "Occurrences", "type": "array" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name" }, "recurrence_interval": { "title": "Recurrence Interval", "type": "integer" }, "recurrence_unit": { "enum": [ "none", "days", "weeks", "months", "years" ], "title": "Recurrence Unit", "type": "string" }, "reference": { "title": "Reference", "type": "string" }, "risk_id": { "title": "Risk Id", "type": "string" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "reference", "risk_id", "title", "recurrence_unit", "recurrence_interval", "lead_time_days", "is_active" ], "title": "MitigationTaskOut", "type": "object" }, "MitigationTaskUpdate": { "description": "Partial update for ``PATCH /mitigation-tasks/{task_id}``.\n\n``owner_id`` changes propagate to the **current open occurrence** (its\n``assigned_owner_id``) so the Todo + notification flow reflects the\nnew assignee immediately. Past completed occurrences keep their\nhistorical owner snapshots and are not modified.\n\nRecurrence changes apply to **future** occurrences only \u2014 the current\nopen occurrence keeps its scheduled ``due_date``. Lead-time changes\ntake effect on future cycles too, but the API re-evaluates any\ncurrently-scheduled cycle against the new window so shortening the\nlead time can promote a cycle immediately instead of waiting for the\nnext daily promotion run.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "lead_time_days": { "anyOf": [ { "maximum": 3650.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Lead Time Days" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "recurrence_interval": { "anyOf": [ { "maximum": 365.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Recurrence Interval" }, "recurrence_unit": { "anyOf": [ { "enum": [ "none", "days", "weeks", "months", "years" ], "type": "string" }, { "type": "null" } ], "title": "Recurrence Unit" }, "title": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "MitigationTaskUpdate", "type": "object" }, "ModernizationOut": { "properties": { "analysed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Analysed At" }, "card_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Id" }, "card_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Name" }, "cluster_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cluster Id" }, "current_tech": { "default": "", "title": "Current Tech", "type": "string" }, "effort": { "default": "medium", "title": "Effort", "type": "string" }, "id": { "title": "Id", "type": "string" }, "modernization_type": { "default": "", "title": "Modernization Type", "type": "string" }, "priority": { "default": "medium", "title": "Priority", "type": "string" }, "recommendation": { "default": "", "title": "Recommendation", "type": "string" }, "status": { "default": "pending", "title": "Status", "type": "string" }, "target_type": { "title": "Target Type", "type": "string" } }, "required": [ "id", "target_type" ], "title": "ModernizationOut", "type": "object" }, "MutationBatchCommit": { "description": "Close a batch after the wrapper's underlying writes complete.", "properties": { "confirm_token": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Confirm Token" }, "summary": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Summary" } }, "title": "MutationBatchCommit", "type": "object" }, "MutationBatchEvent": { "properties": { "card_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Card Id" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "event_type": { "title": "Event Type", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "user_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Display Name" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "event_type", "data", "card_id", "user_id", "created_at" ], "title": "MutationBatchEvent", "type": "object" }, "MutationBatchHistory": { "description": "Response for ``GET /mutation-batches/{id}/events`` \u2014 the batch\nmetadata plus every event emitted under it, in chronological order.", "properties": { "batch": { "$ref": "#/components/schemas/MutationBatchOut" }, "events": { "items": { "$ref": "#/components/schemas/MutationBatchEvent" }, "title": "Events", "type": "array" } }, "required": [ "batch", "events" ], "title": "MutationBatchHistory", "type": "object" }, "MutationBatchListPage": { "description": "Paginated response for ``GET /mutation-batches``. Mirrors the\n``{items, total, page, page_size}`` envelope used by ``GET /cards``\nand the rest of the paginated read endpoints.", "properties": { "items": { "items": { "$ref": "#/components/schemas/MutationBatchOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "MutationBatchListPage", "type": "object" }, "MutationBatchOpen": { "description": "Open a batch before a mutating tool wrapper performs writes.", "properties": { "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "tool_name": { "maxLength": 100, "minLength": 1, "title": "Tool Name", "type": "string" } }, "required": [ "tool_name" ], "title": "MutationBatchOpen", "type": "object" }, "MutationBatchOut": { "properties": { "actor_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Actor Display Name" }, "actor_user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Actor User Id" }, "committed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Committed At" }, "confirm_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Confirm Token" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "dry_run": { "title": "Dry Run", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "origin": { "title": "Origin", "type": "string" }, "summary": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Summary" }, "tool_name": { "title": "Tool Name", "type": "string" } }, "required": [ "id", "tool_name", "actor_user_id", "origin", "dry_run", "created_at", "committed_at" ], "title": "MutationBatchOut", "type": "object" }, "NotificationPreferencesUpdate": { "properties": { "email": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Email" }, "in_app": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "In App" } }, "title": "NotificationPreferencesUpdate", "type": "object" }, "OccurrenceCompleteRequest": { "description": "Optional notes when marking an occurrence done or skipped.", "properties": { "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "title": "OccurrenceCompleteRequest", "type": "object" }, "PortfolioInsightsRequest": { "description": "Summary data for AI portfolio analysis.", "properties": { "active_filters": { "description": "Human-readable descriptions of active filters", "items": { "type": "string" }, "title": "Active Filters", "type": "array" }, "attribute_summary": { "additionalProperties": true, "description": "Aggregated attribute distributions (e.g. hostingType counts)", "title": "Attribute Summary", "type": "object" }, "color_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color By" }, "group_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group By" }, "groups": { "description": "List of {name, count, breakdown} dicts summarising each group", "items": { "additionalProperties": true, "type": "object" }, "title": "Groups", "type": "array" }, "lifecycle_summary": { "additionalProperties": true, "description": "Counts by lifecycle phase", "title": "Lifecycle Summary", "type": "object" }, "total_apps": { "default": 0, "minimum": 0.0, "title": "Total Apps", "type": "integer" } }, "title": "PortfolioInsightsRequest", "type": "object" }, "PortfolioInsightsResponse": { "properties": { "insights": { "description": "List of structured insight objects or plain strings", "items": { "anyOf": [ { "$ref": "#/components/schemas/StructuredInsight" }, { "type": "string" }, {} ] }, "title": "Insights", "type": "array" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" } }, "title": "PortfolioInsightsResponse", "type": "object" }, "PpmBudgetLineCreate": { "properties": { "amount": { "default": 0, "title": "Amount", "type": "number" }, "category": { "enum": [ "capex", "opex" ], "title": "Category", "type": "string" }, "fiscal_year": { "title": "Fiscal Year", "type": "integer" } }, "required": [ "fiscal_year", "category" ], "title": "PpmBudgetLineCreate", "type": "object" }, "PpmBudgetLineOut": { "properties": { "amount": { "title": "Amount", "type": "number" }, "category": { "title": "Category", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "fiscal_year": { "title": "Fiscal Year", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "initiative_id", "fiscal_year", "category", "amount", "created_at", "updated_at" ], "title": "PpmBudgetLineOut", "type": "object" }, "PpmBudgetLineUpdate": { "properties": { "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amount" }, "category": { "anyOf": [ { "enum": [ "capex", "opex" ], "type": "string" }, { "type": "null" } ], "title": "Category" }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year" } }, "title": "PpmBudgetLineUpdate", "type": "object" }, "PpmCostLineCreate": { "properties": { "actual": { "default": 0, "title": "Actual", "type": "number" }, "category": { "enum": [ "capex", "opex" ], "title": "Category", "type": "string" }, "date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Date" }, "description": { "title": "Description", "type": "string" }, "planned": { "default": 0, "title": "Planned", "type": "number" } }, "required": [ "description", "category" ], "title": "PpmCostLineCreate", "type": "object" }, "PpmCostLineOut": { "properties": { "actual": { "title": "Actual", "type": "number" }, "category": { "title": "Category", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Date" }, "description": { "title": "Description", "type": "string" }, "id": { "title": "Id", "type": "string" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "planned": { "title": "Planned", "type": "number" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "initiative_id", "description", "category", "planned", "actual", "created_at", "updated_at" ], "title": "PpmCostLineOut", "type": "object" }, "PpmCostLineUpdate": { "properties": { "actual": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Actual" }, "category": { "anyOf": [ { "enum": [ "capex", "opex" ], "type": "string" }, { "type": "null" } ], "title": "Category" }, "date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Date" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "planned": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Planned" } }, "title": "PpmCostLineUpdate", "type": "object" }, "PpmDependencyCreate": { "properties": { "kind": { "const": "FS", "default": "FS", "title": "Kind", "type": "string" }, "pred_id": { "title": "Pred Id", "type": "string" }, "pred_kind": { "enum": [ "task", "wbs" ], "title": "Pred Kind", "type": "string" }, "succ_id": { "title": "Succ Id", "type": "string" }, "succ_kind": { "enum": [ "task", "wbs" ], "title": "Succ Kind", "type": "string" } }, "required": [ "pred_kind", "pred_id", "succ_kind", "succ_id" ], "title": "PpmDependencyCreate", "type": "object" }, "PpmDependencyOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "pred_id": { "title": "Pred Id", "type": "string" }, "pred_kind": { "enum": [ "task", "wbs" ], "title": "Pred Kind", "type": "string" }, "succ_id": { "title": "Succ Id", "type": "string" }, "succ_kind": { "enum": [ "task", "wbs" ], "title": "Succ Kind", "type": "string" } }, "required": [ "id", "initiative_id", "pred_kind", "pred_id", "succ_kind", "succ_id", "kind", "created_at" ], "title": "PpmDependencyOut", "type": "object" }, "PpmEnabledPayload": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "PpmEnabledPayload", "type": "object" }, "PpmGanttItem": { "properties": { "capex_actual": { "default": 0, "title": "Capex Actual", "type": "number" }, "capex_planned": { "default": 0, "title": "Capex Planned", "type": "number" }, "cost_actual": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Actual" }, "cost_budget": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Budget" }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Date" }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id" }, "group_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Name" }, "id": { "title": "Id", "type": "string" }, "latest_report": { "anyOf": [ { "$ref": "#/components/schemas/PpmStatusReportOut" }, { "type": "null" } ] }, "latest_report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Report Id" }, "name": { "title": "Name", "type": "string" }, "opex_actual": { "default": 0, "title": "Opex Actual", "type": "number" }, "opex_planned": { "default": 0, "title": "Opex Planned", "type": "number" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "stakeholders": { "default": [], "items": { "$ref": "#/components/schemas/PpmGanttStakeholder" }, "title": "Stakeholders", "type": "array" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" } }, "required": [ "id", "name", "subtype", "status", "parent_id", "start_date", "end_date", "cost_budget", "cost_actual" ], "title": "PpmGanttItem", "type": "object" }, "PpmGanttStakeholder": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "role_key": { "title": "Role Key", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "user_id", "display_name", "role_key" ], "title": "PpmGanttStakeholder", "type": "object" }, "PpmGroupOption": { "properties": { "type_key": { "title": "Type Key", "type": "string" }, "type_label": { "title": "Type Label", "type": "string" } }, "required": [ "type_key", "type_label" ], "title": "PpmGroupOption", "type": "object" }, "PpmRiskCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "impact": { "default": 3, "maximum": 5.0, "minimum": 1.0, "title": "Impact", "type": "integer" }, "mitigation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mitigation" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "probability": { "default": 3, "maximum": 5.0, "minimum": 1.0, "title": "Probability", "type": "integer" }, "status": { "default": "open", "enum": [ "open", "mitigating", "mitigated", "closed", "accepted" ], "title": "Status", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "PpmRiskCreate", "type": "object" }, "PpmRiskOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "impact": { "title": "Impact", "type": "integer" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "mitigation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mitigation" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name" }, "probability": { "title": "Probability", "type": "integer" }, "risk_score": { "title": "Risk Score", "type": "integer" }, "status": { "title": "Status", "type": "string" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "initiative_id", "title", "description", "probability", "impact", "risk_score", "mitigation", "owner_id", "status", "created_at", "updated_at" ], "title": "PpmRiskOut", "type": "object" }, "PpmRiskUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "impact": { "anyOf": [ { "maximum": 5.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Impact" }, "mitigation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mitigation" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "probability": { "anyOf": [ { "maximum": 5.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Probability" }, "status": { "anyOf": [ { "enum": [ "open", "mitigating", "mitigated", "closed", "accepted" ], "type": "string" }, { "type": "null" } ], "title": "Status" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "PpmRiskUpdate", "type": "object" }, "PpmStatusReportCreate": { "properties": { "accomplishments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accomplishments" }, "cost_health": { "default": "onTrack", "enum": [ "onTrack", "atRisk", "offTrack" ], "title": "Cost Health", "type": "string" }, "next_steps": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Steps" }, "report_date": { "format": "date", "title": "Report Date", "type": "string" }, "schedule_health": { "default": "onTrack", "enum": [ "onTrack", "atRisk", "offTrack" ], "title": "Schedule Health", "type": "string" }, "scope_health": { "default": "onTrack", "enum": [ "onTrack", "atRisk", "offTrack" ], "title": "Scope Health", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" } }, "required": [ "report_date" ], "title": "PpmStatusReportCreate", "type": "object" }, "PpmStatusReportOut": { "properties": { "accomplishments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accomplishments" }, "cost_health": { "title": "Cost Health", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "next_steps": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Steps" }, "report_date": { "format": "date", "title": "Report Date", "type": "string" }, "reporter": { "anyOf": [ { "$ref": "#/components/schemas/ReporterOut" }, { "type": "null" } ] }, "reporter_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reporter Id" }, "schedule_health": { "title": "Schedule Health", "type": "string" }, "scope_health": { "title": "Scope Health", "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "initiative_id", "report_date", "schedule_health", "cost_health", "scope_health", "summary", "accomplishments", "next_steps", "created_at", "updated_at" ], "title": "PpmStatusReportOut", "type": "object" }, "PpmStatusReportUpdate": { "properties": { "accomplishments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accomplishments" }, "cost_health": { "anyOf": [ { "enum": [ "onTrack", "atRisk", "offTrack" ], "type": "string" }, { "type": "null" } ], "title": "Cost Health" }, "next_steps": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Steps" }, "report_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Report Date" }, "schedule_health": { "anyOf": [ { "enum": [ "onTrack", "atRisk", "offTrack" ], "type": "string" }, { "type": "null" } ], "title": "Schedule Health" }, "scope_health": { "anyOf": [ { "enum": [ "onTrack", "atRisk", "offTrack" ], "type": "string" }, { "type": "null" } ], "title": "Scope Health" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" } }, "title": "PpmStatusReportUpdate", "type": "object" }, "PpmTaskCommentCreate": { "properties": { "content": { "maxLength": 10000, "minLength": 1, "title": "Content", "type": "string" } }, "required": [ "content" ], "title": "PpmTaskCommentCreate", "type": "object" }, "PpmTaskCommentOut": { "properties": { "content": { "title": "Content", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "task_id": { "title": "Task Id", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "user_display_name": { "title": "User Display Name", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "id", "task_id", "user_id", "user_display_name", "content", "created_at", "updated_at" ], "title": "PpmTaskCommentOut", "type": "object" }, "PpmTaskCommentUpdate": { "properties": { "content": { "maxLength": 10000, "minLength": 1, "title": "Content", "type": "string" } }, "required": [ "content" ], "title": "PpmTaskCommentUpdate", "type": "object" }, "PpmTaskCreate": { "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "priority": { "default": "medium", "enum": [ "critical", "high", "medium", "low" ], "title": "Priority", "type": "string" }, "sort_order": { "default": 0, "title": "Sort Order", "type": "integer" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "status": { "default": "todo", "enum": [ "todo", "in_progress", "done", "blocked" ], "title": "Status", "type": "string" }, "tags": { "default": [], "items": { "type": "string" }, "title": "Tags", "type": "array" }, "title": { "title": "Title", "type": "string" }, "wbs_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wbs Id" } }, "required": [ "title" ], "title": "PpmTaskCreate", "type": "object" }, "PpmTaskOut": { "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "assignee_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Name" }, "comment_count": { "default": 0, "title": "Comment Count", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "id": { "title": "Id", "type": "string" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "priority": { "title": "Priority", "type": "string" }, "sort_order": { "title": "Sort Order", "type": "integer" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "status": { "title": "Status", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "wbs_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wbs Id" } }, "required": [ "id", "initiative_id", "title", "description", "status", "priority", "assignee_id", "due_date", "sort_order", "tags", "created_at", "updated_at" ], "title": "PpmTaskOut", "type": "object" }, "PpmTaskUpdate": { "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "due_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "priority": { "anyOf": [ { "enum": [ "critical", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Priority" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "status": { "anyOf": [ { "enum": [ "todo", "in_progress", "done", "blocked" ], "type": "string" }, { "type": "null" } ], "title": "Status" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "wbs_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wbs Id" } }, "title": "PpmTaskUpdate", "type": "object" }, "PpmWbsCreate": { "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "completion": { "default": 0, "maximum": 100.0, "minimum": 0.0, "title": "Completion", "type": "number" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "End Date" }, "is_milestone": { "default": false, "title": "Is Milestone", "type": "boolean" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "sort_order": { "default": 0, "title": "Sort Order", "type": "integer" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "title": { "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "PpmWbsCreate", "type": "object" }, "PpmWbsOut": { "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "assignee_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Name" }, "completion": { "default": 0, "title": "Completion", "type": "number" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "End Date" }, "id": { "title": "Id", "type": "string" }, "initiative_id": { "title": "Initiative Id", "type": "string" }, "is_milestone": { "default": false, "title": "Is Milestone", "type": "boolean" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "progress": { "default": 0, "title": "Progress", "type": "number" }, "sort_order": { "title": "Sort Order", "type": "integer" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "task_count": { "default": 0, "title": "Task Count", "type": "integer" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "initiative_id", "parent_id", "title", "description", "start_date", "end_date", "sort_order", "created_at", "updated_at" ], "title": "PpmWbsOut", "type": "object" }, "PpmWbsUpdate": { "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assignee Id" }, "completion": { "anyOf": [ { "maximum": 100.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "title": "Completion" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "End Date" }, "is_milestone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Milestone" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Start Date" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "PpmWbsUpdate", "type": "object" }, "PreviewPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/app__api__v1__migration__StagedRecordOut" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "offset", "limit" ], "title": "PreviewPage", "type": "object" }, "PrincipleCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "implications": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Implications" }, "is_active": { "default": true, "title": "Is Active", "type": "boolean" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rationale" }, "sort_order": { "default": 0, "title": "Sort Order", "type": "integer" }, "title": { "maxLength": 300, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "PrincipleCreate", "type": "object" }, "PrincipleUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "implications": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Implications" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rationale" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "PrincipleUpdate", "type": "object" }, "ProcessAssessmentCreate": { "properties": { "action_items": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Action Items" }, "assessment_date": { "format": "date", "title": "Assessment Date", "type": "string" }, "automation": { "title": "Automation", "type": "integer" }, "compliance": { "title": "Compliance", "type": "integer" }, "effectiveness": { "title": "Effectiveness", "type": "integer" }, "efficiency": { "title": "Efficiency", "type": "integer" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "overall_score": { "title": "Overall Score", "type": "integer" } }, "required": [ "assessment_date", "overall_score", "efficiency", "effectiveness", "compliance", "automation" ], "title": "ProcessAssessmentCreate", "type": "object" }, "ProcessAssessmentUpdate": { "properties": { "action_items": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Action Items" }, "automation": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Automation" }, "compliance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Compliance" }, "effectiveness": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effectiveness" }, "efficiency": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Efficiency" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "overall_score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Overall Score" } }, "title": "ProcessAssessmentUpdate", "type": "object" }, "ProcessFlowVersionCreate": { "description": "Create a new draft process flow.", "properties": { "based_on_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Based On Id" }, "bpmn_xml": { "title": "Bpmn Xml", "type": "string" }, "svg_thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Svg Thumbnail" } }, "required": [ "bpmn_xml" ], "title": "ProcessFlowVersionCreate", "type": "object" }, "ProcessFlowVersionUpdate": { "description": "Update an existing draft process flow.", "properties": { "bpmn_xml": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bpmn Xml" }, "svg_thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Svg Thumbnail" } }, "title": "ProcessFlowVersionUpdate", "type": "object" }, "RegisterRequest": { "properties": { "display_name": { "maxLength": 200, "minLength": 1, "title": "Display Name", "type": "string" }, "email": { "format": "email", "title": "Email", "type": "string" }, "password": { "title": "Password", "type": "string" } }, "required": [ "email", "display_name", "password" ], "title": "RegisterRequest", "type": "object" }, "RegistrationPayload": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "RegistrationPayload", "type": "object" }, "RejectRequest": { "properties": { "comment": { "title": "Comment", "type": "string" } }, "required": [ "comment" ], "title": "RejectRequest", "type": "object" }, "RelationBulkOperation": { "description": "One row of a bulk-relation request.", "properties": { "action": { "default": "upsert", "enum": [ "upsert", "delete" ], "title": "Action", "type": "string" }, "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "row_index": { "title": "Row Index", "type": "integer" }, "source": { "$ref": "#/components/schemas/RelationRefInput" }, "target": { "$ref": "#/components/schemas/RelationRefInput" }, "type": { "title": "Type", "type": "string" } }, "required": [ "row_index", "type", "source", "target" ], "title": "RelationBulkOperation", "type": "object" }, "RelationBulkRequest": { "properties": { "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "operations": { "items": { "$ref": "#/components/schemas/RelationBulkOperation" }, "maxItems": 5000, "minItems": 1, "title": "Operations", "type": "array" } }, "required": [ "operations" ], "title": "RelationBulkRequest", "type": "object" }, "RelationBulkResponse": { "properties": { "deleted": { "title": "Deleted", "type": "integer" }, "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "failed": { "title": "Failed", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/RelationBulkResult" }, "title": "Results", "type": "array" }, "upserted": { "title": "Upserted", "type": "integer" } }, "required": [ "results", "upserted", "deleted", "failed" ], "title": "RelationBulkResponse", "type": "object" }, "RelationBulkResult": { "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "relation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relation Id" }, "row_index": { "title": "Row Index", "type": "integer" }, "status": { "enum": [ "upserted", "deleted", "noop", "failed" ], "title": "Status", "type": "string" } }, "required": [ "row_index", "status" ], "title": "RelationBulkResult", "type": "object" }, "RelationCreate": { "properties": { "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "source_id": { "title": "Source Id", "type": "string" }, "target_id": { "title": "Target Id", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "type", "source_id", "target_id" ], "title": "RelationCreate", "type": "object" }, "RelationRefInput": { "description": "Either a resolved UUID or a name+path tuple. Exactly one of `id` or\n(`type` + `name`) must be supplied.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "parent_path": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Parent Path" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, "title": "RelationRefInput", "type": "object" }, "RelationResponse": { "properties": { "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/CardRef" }, { "type": "null" } ] }, "source_id": { "title": "Source Id", "type": "string" }, "target": { "anyOf": [ { "$ref": "#/components/schemas/CardRef" }, { "type": "null" } ] }, "target_id": { "title": "Target Id", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "type", "source_id", "target_id" ], "title": "RelationResponse", "type": "object" }, "RelationUpdate": { "properties": { "attributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "title": "RelationUpdate", "type": "object" }, "ReporterOut": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "display_name" ], "title": "ReporterOut", "type": "object" }, "ResetPasswordRequest": { "properties": { "password": { "title": "Password", "type": "string" }, "token": { "title": "Token", "type": "string" } }, "required": [ "token", "password" ], "title": "ResetPasswordRequest", "type": "object" }, "RestoreImpactPassenger": { "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "role": { "enum": [ "child", "related" ], "title": "Role", "type": "string" }, "subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtype" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "name", "type", "role" ], "title": "RestoreImpactPassenger", "type": "object" }, "RestoreImpactResponse": { "properties": { "passengers": { "items": { "$ref": "#/components/schemas/RestoreImpactPassenger" }, "title": "Passengers", "type": "array" } }, "required": [ "passengers" ], "title": "RestoreImpactResponse", "type": "object" }, "RiskCardLinkOut": { "properties": { "card_id": { "title": "Card Id", "type": "string" }, "card_name": { "title": "Card Name", "type": "string" }, "card_type": { "title": "Card Type", "type": "string" }, "role": { "enum": [ "affected", "contributing", "owner_of_control" ], "title": "Role", "type": "string" } }, "required": [ "card_id", "card_name", "card_type", "role" ], "title": "RiskCardLinkOut", "type": "object" }, "RiskCardLinkRequest": { "properties": { "card_ids": { "items": { "type": "string" }, "title": "Card Ids", "type": "array" }, "role": { "default": "affected", "enum": [ "affected", "contributing", "owner_of_control" ], "title": "Role", "type": "string" } }, "required": [ "card_ids" ], "title": "RiskCardLinkRequest", "type": "object" }, "RiskCreate": { "description": "Manual risk creation payload.", "properties": { "card_ids": { "items": { "type": "string" }, "title": "Card Ids", "type": "array" }, "category": { "default": "operational", "enum": [ "security", "compliance", "operational", "technology", "financial", "reputational", "strategic" ], "title": "Category", "type": "string" }, "description": { "default": "", "title": "Description", "type": "string" }, "initial_impact": { "default": "medium", "enum": [ "critical", "high", "medium", "low" ], "title": "Initial Impact", "type": "string" }, "initial_probability": { "default": "medium", "enum": [ "very_high", "high", "medium", "low" ], "title": "Initial Probability", "type": "string" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "target_resolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Target Resolution Date" }, "title": { "maxLength": 500, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "title" ], "title": "RiskCreate", "type": "object" }, "RiskListPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RiskOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "RiskListPage", "type": "object" }, "RiskMetricsOut": { "properties": { "by_category": { "additionalProperties": { "type": "integer" }, "title": "By Category", "type": "object" }, "by_level": { "additionalProperties": { "type": "integer" }, "title": "By Level", "type": "object" }, "by_status": { "additionalProperties": { "type": "integer" }, "title": "By Status", "type": "object" }, "created_this_month": { "default": 0, "title": "Created This Month", "type": "integer" }, "initial_matrix": { "items": { "items": { "type": "integer" }, "type": "array" }, "title": "Initial Matrix", "type": "array" }, "overdue": { "default": 0, "title": "Overdue", "type": "integer" }, "residual_matrix": { "items": { "items": { "type": "integer" }, "type": "array" }, "title": "Residual Matrix", "type": "array" }, "total": { "default": 0, "title": "Total", "type": "integer" } }, "title": "RiskMetricsOut", "type": "object" }, "RiskOut": { "properties": { "acceptance_rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acceptance Rationale" }, "accepted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Accepted At" }, "accepted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accepted By" }, "cards": { "items": { "$ref": "#/components/schemas/RiskCardLinkOut" }, "title": "Cards", "type": "array" }, "category": { "enum": [ "security", "compliance", "operational", "technology", "financial", "reputational", "strategic" ], "title": "Category", "type": "string" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "description": { "title": "Description", "type": "string" }, "id": { "title": "Id", "type": "string" }, "initial_impact": { "enum": [ "critical", "high", "medium", "low" ], "title": "Initial Impact", "type": "string" }, "initial_level": { "enum": [ "critical", "high", "medium", "low" ], "title": "Initial Level", "type": "string" }, "initial_probability": { "enum": [ "very_high", "high", "medium", "low" ], "title": "Initial Probability", "type": "string" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name" }, "reference": { "title": "Reference", "type": "string" }, "residual_impact": { "anyOf": [ { "enum": [ "critical", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Residual Impact" }, "residual_level": { "anyOf": [ { "enum": [ "critical", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Residual Level" }, "residual_probability": { "anyOf": [ { "enum": [ "very_high", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Residual Probability" }, "source_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Ref" }, "source_type": { "enum": [ "manual", "compliance" ], "title": "Source Type", "type": "string" }, "status": { "enum": [ "identified", "analysed", "mitigation_planned", "in_progress", "mitigated", "monitoring", "accepted", "closed" ], "title": "Status", "type": "string" }, "target_resolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Target Resolution Date" }, "title": { "title": "Title", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "required": [ "id", "reference", "title", "description", "category", "source_type", "source_ref", "initial_probability", "initial_impact", "initial_level", "status" ], "title": "RiskOut", "type": "object" }, "RiskPromoteRequest": { "description": "Overrides for the promote-from-finding endpoints. All optional.", "properties": { "category": { "anyOf": [ { "enum": [ "security", "compliance", "operational", "technology", "financial", "reputational", "strategic" ], "type": "string" }, { "type": "null" } ], "title": "Category" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "initial_impact": { "anyOf": [ { "enum": [ "critical", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Initial Impact" }, "initial_probability": { "anyOf": [ { "enum": [ "very_high", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Initial Probability" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "target_resolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Target Resolution Date" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "RiskPromoteRequest", "type": "object" }, "RiskUpdate": { "description": "Partial risk update. Derived ``initial_level`` / ``residual_level``\nare re-computed server-side and ignored here.", "properties": { "acceptance_rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acceptance Rationale" }, "category": { "anyOf": [ { "enum": [ "security", "compliance", "operational", "technology", "financial", "reputational", "strategic" ], "type": "string" }, { "type": "null" } ], "title": "Category" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "initial_impact": { "anyOf": [ { "enum": [ "critical", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Initial Impact" }, "initial_probability": { "anyOf": [ { "enum": [ "very_high", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Initial Probability" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "residual_impact": { "anyOf": [ { "enum": [ "critical", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Residual Impact" }, "residual_probability": { "anyOf": [ { "enum": [ "very_high", "high", "medium", "low" ], "type": "string" }, { "type": "null" } ], "title": "Residual Probability" }, "status": { "anyOf": [ { "enum": [ "identified", "analysed", "mitigation_planned", "in_progress", "mitigated", "monitoring", "accepted", "closed" ], "type": "string" }, { "type": "null" } ], "title": "Status" }, "target_resolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Target Resolution Date" }, "title": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "RiskUpdate", "type": "object" }, "RoleCreate": { "properties": { "color": { "default": "#757575", "title": "Color", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_default": { "default": false, "title": "Is Default", "type": "boolean" }, "key": { "maxLength": 50, "minLength": 3, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "minLength": 1, "title": "Label", "type": "string" }, "permissions": { "additionalProperties": { "type": "boolean" }, "default": {}, "title": "Permissions", "type": "object" } }, "required": [ "key", "label" ], "title": "RoleCreate", "type": "object" }, "RoleUpdate": { "properties": { "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Default" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "permissions": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Permissions" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" } }, "title": "RoleUpdate", "type": "object" }, "RollbackBody": { "properties": { "dry_run": { "default": true, "title": "Dry Run", "type": "boolean" }, "force": { "default": false, "title": "Force", "type": "boolean" } }, "title": "RollbackBody", "type": "object" }, "SavedReportCreate": { "properties": { "config": { "additionalProperties": true, "title": "Config", "type": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "title": "Name", "type": "string" }, "report_type": { "title": "Report Type", "type": "string" }, "shared_with": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Shared With" }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail" }, "visibility": { "default": "private", "title": "Visibility", "type": "string" } }, "required": [ "name", "report_type", "config" ], "title": "SavedReportCreate", "type": "object" }, "SavedReportUpdate": { "properties": { "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "shared_with": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Shared With" }, "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail" }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Visibility" } }, "title": "SavedReportUpdate", "type": "object" }, "SecurityOverviewOut": { "properties": { "compliance_by_status": { "additionalProperties": { "additionalProperties": { "type": "integer" }, "type": "object" }, "title": "Compliance By Status", "type": "object" }, "compliance_run": { "$ref": "#/components/schemas/SecurityScanRunOut" }, "compliance_scores": { "additionalProperties": { "type": "integer" }, "title": "Compliance Scores", "type": "object" } }, "title": "SecurityOverviewOut", "type": "object" }, "SecurityScanRequest": { "description": "Options for an on-demand compliance scan.", "properties": { "regulations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Regulations" } }, "title": "SecurityScanRequest", "type": "object" }, "SecurityScanRunOut": { "description": "Summary of the latest compliance scan run.", "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "progress": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Progress" }, "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "summary": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Summary" } }, "title": "SecurityScanRunOut", "type": "object" }, "SetPasswordRequest": { "properties": { "password": { "title": "Password", "type": "string" }, "token": { "title": "Token", "type": "string" } }, "required": [ "token", "password" ], "title": "SetPasswordRequest", "type": "object" }, "SignatureRequest": { "properties": { "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "user_ids": { "items": { "type": "string" }, "title": "User Ids", "type": "array" } }, "required": [ "user_ids" ], "title": "SignatureRequest", "type": "object" }, "SoAWCreate": { "properties": { "document_info": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Document Info" }, "initiative_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initiative Id" }, "name": { "title": "Name", "type": "string" }, "sections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sections" }, "status": { "default": "draft", "title": "Status", "type": "string" }, "version_history": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Version History" } }, "required": [ "name" ], "title": "SoAWCreate", "type": "object" }, "SoAWUpdate": { "properties": { "document_info": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Document Info" }, "initiative_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initiative Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "sections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sections" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "version_history": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Version History" } }, "title": "SoAWUpdate", "type": "object" }, "SourceFieldRow": { "description": "One source-platform custom field discovered in the snapshot.", "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "mapped_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mapped To" }, "native_data_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Native Data Type" }, "source_field_key": { "title": "Source Field Key", "type": "string" }, "target_tea_type": { "title": "Target Tea Type", "type": "string" }, "tea_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tea Type" } }, "required": [ "source_field_key", "label", "native_data_type", "tea_type", "target_tea_type", "mapped_to" ], "title": "SourceFieldRow", "type": "object" }, "SourceOut": { "properties": { "accepted_extensions": { "items": { "type": "string" }, "title": "Accepted Extensions", "type": "array" }, "key": { "title": "Key", "type": "string" }, "label": { "title": "Label", "type": "string" } }, "required": [ "key", "label", "accepted_extensions" ], "title": "SourceOut", "type": "object" }, "SsoCallbackRequest": { "properties": { "code": { "title": "Code", "type": "string" }, "redirect_uri": { "title": "Redirect Uri", "type": "string" } }, "required": [ "code", "redirect_uri" ], "title": "SsoCallbackRequest", "type": "object" }, "SsoSettingsPayload": { "properties": { "authorization_endpoint": { "default": "", "title": "Authorization Endpoint", "type": "string" }, "client_id": { "default": "", "title": "Client Id", "type": "string" }, "client_secret": { "default": "", "title": "Client Secret", "type": "string" }, "domain": { "default": "", "title": "Domain", "type": "string" }, "enabled": { "default": false, "title": "Enabled", "type": "boolean" }, "issuer_url": { "default": "", "title": "Issuer Url", "type": "string" }, "jwks_uri": { "default": "", "title": "Jwks Uri", "type": "string" }, "provider": { "default": "microsoft", "title": "Provider", "type": "string" }, "tenant_id": { "default": "organizations", "title": "Tenant Id", "type": "string" }, "token_endpoint": { "default": "", "title": "Token Endpoint", "type": "string" } }, "title": "SsoSettingsPayload", "type": "object" }, "StakeholderCreate": { "properties": { "role": { "title": "Role", "type": "string" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "user_id", "role" ], "title": "StakeholderCreate", "type": "object" }, "StakeholderRef": { "properties": { "id": { "title": "Id", "type": "string" }, "role": { "title": "Role", "type": "string" }, "user_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Display Name" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "title": "User Id", "type": "string" } }, "required": [ "id", "user_id", "role" ], "title": "StakeholderRef", "type": "object" }, "StakeholderRoleCreate": { "properties": { "color": { "default": "#757575", "title": "Color", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "key": { "maxLength": 50, "minLength": 3, "title": "Key", "type": "string" }, "label": { "maxLength": 200, "minLength": 1, "title": "Label", "type": "string" }, "permissions": { "additionalProperties": { "type": "boolean" }, "default": {}, "title": "Permissions", "type": "object" }, "translations": { "additionalProperties": true, "default": {}, "title": "Translations", "type": "object" } }, "required": [ "key", "label" ], "title": "StakeholderRoleCreate", "type": "object" }, "StakeholderRoleUpdate": { "properties": { "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "permissions": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Permissions" }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order" }, "translations": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Translations" } }, "title": "StakeholderRoleUpdate", "type": "object" }, "StructuredInsight": { "properties": { "observation": { "default": "", "title": "Observation", "type": "string" }, "recommendation": { "default": "", "title": "Recommendation", "type": "string" }, "title": { "default": "", "title": "Title", "type": "string" } }, "title": "StructuredInsight", "type": "object" }, "SubmitResponse": { "properties": { "responses": { "additionalProperties": true, "title": "Responses", "type": "object" } }, "required": [ "responses" ], "title": "SubmitResponse", "type": "object" }, "SurveyCreate": { "properties": { "description": { "default": "", "title": "Description", "type": "string" }, "fields": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "message": { "default": "", "title": "Message", "type": "string" }, "name": { "title": "Name", "type": "string" }, "target_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Target Filters" }, "target_roles": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Target Roles" }, "target_type_key": { "title": "Target Type Key", "type": "string" } }, "required": [ "name", "target_type_key" ], "title": "SurveyCreate", "type": "object" }, "SurveyUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "fields": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Fields" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "target_filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Target Filters" }, "target_roles": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Target Roles" }, "target_type_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Type Key" } }, "title": "SurveyUpdate", "type": "object" }, "SyncRunOut": { "properties": { "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "connection_id": { "title": "Connection Id", "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "direction": { "title": "Direction", "type": "string" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "id": { "title": "Id", "type": "string" }, "mapping_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mapping Id" }, "started_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Started At" }, "stats": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Stats" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "connection_id", "status", "direction" ], "title": "SyncRunOut", "type": "object" }, "TagCreate": { "properties": { "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "TagCreate", "type": "object" }, "TagGroupCreate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "mandatory": { "default": false, "title": "Mandatory", "type": "boolean" }, "mode": { "default": "multi", "title": "Mode", "type": "string" }, "name": { "title": "Name", "type": "string" }, "restrict_to_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Restrict To Types" } }, "required": [ "name" ], "title": "TagGroupCreate", "type": "object" }, "TagGroupUpdate": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "mandatory": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mandatory" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "restrict_to_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Restrict To Types" } }, "title": "TagGroupUpdate", "type": "object" }, "TagRef": { "properties": { "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "group_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Name" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "TagRef", "type": "object" }, "TagUpdate": { "properties": { "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "title": "TagUpdate", "type": "object" }, "TargetFieldOption": { "description": "One Turbo EA field that an admin can map a source field onto.", "properties": { "key": { "title": "Key", "type": "string" }, "label": { "title": "Label", "type": "string" }, "section": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section" }, "type": { "title": "Type", "type": "string" } }, "required": [ "key", "label", "type" ], "title": "TargetFieldOption", "type": "object" }, "TestRequest": { "properties": { "card_id": { "title": "Card Id", "type": "string" } }, "required": [ "card_id" ], "title": "TestRequest", "type": "object" }, "TodoCreate": { "properties": { "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned To" }, "description": { "title": "Description", "type": "string" }, "due_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Due Date" } }, "required": [ "description" ], "title": "TodoCreate", "type": "object" }, "TodoUpdate": { "properties": { "assigned_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assigned To" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "due_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Due Date" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "title": "TodoUpdate", "type": "object" }, "TokenResponse": { "properties": { "access_token": { "title": "Access Token", "type": "string" }, "token_type": { "default": "bearer", "title": "Token Type", "type": "string" } }, "required": [ "access_token" ], "title": "TokenResponse", "type": "object" }, "TurboLensAnalysisRunOut": { "properties": { "analysis_type": { "title": "Analysis Type", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "id": { "title": "Id", "type": "string" }, "results": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Results" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "analysis_type", "status" ], "title": "TurboLensAnalysisRunOut", "type": "object" }, "TurboLensArchitectRequest": { "properties": { "allQA": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Allqa" }, "objectiveIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Objectiveids" }, "phase": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Phase" }, "phase1QA": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Phase1Qa" }, "requirement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requirement" }, "selectedCapabilities": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Selectedcapabilities" }, "selectedOption": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Selectedoption" }, "selectedProducts": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Selectedproducts" }, "selectedRecommendations": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Selectedrecommendations" } }, "title": "TurboLensArchitectRequest", "type": "object" }, "TurboLensAssessmentCreate": { "description": "Save an architecture assessment session.", "properties": { "requirement": { "title": "Requirement", "type": "string" }, "sessionData": { "additionalProperties": true, "title": "Sessiondata", "type": "object" }, "title": { "title": "Title", "type": "string" } }, "required": [ "title", "requirement", "sessionData" ], "title": "TurboLensAssessmentCreate", "type": "object" }, "TurboLensAssessmentUpdate": { "description": "Update an existing architecture assessment session.", "properties": { "requirement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requirement" }, "sessionData": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Sessiondata" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "TurboLensAssessmentUpdate", "type": "object" }, "TurboLensCommitRequest": { "description": "Commit an assessment: create initiative, cards, relations, ADR.", "properties": { "assessmentId": { "title": "Assessmentid", "type": "string" }, "endDate": { "title": "Enddate", "type": "string" }, "initiativeName": { "title": "Initiativename", "type": "string" }, "objectiveIds": { "items": { "type": "string" }, "title": "Objectiveids", "type": "array" }, "renamedCards": { "additionalProperties": { "type": "string" }, "description": "Map of card ID \u2192 new name for cards renamed by the user", "title": "Renamedcards", "type": "object" }, "selectedCardIds": { "items": { "type": "string" }, "title": "Selectedcardids", "type": "array" }, "selectedRelationIndices": { "items": { "type": "integer" }, "title": "Selectedrelationindices", "type": "array" }, "startDate": { "title": "Startdate", "type": "string" } }, "required": [ "assessmentId", "initiativeName", "startDate", "endDate", "selectedCardIds", "selectedRelationIndices" ], "title": "TurboLensCommitRequest", "type": "object" }, "TurboLensDuplicateStatusUpdate": { "properties": { "status": { "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "TurboLensDuplicateStatusUpdate", "type": "object" }, "TurboLensEnabledPayload": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "TurboLensEnabledPayload", "type": "object" }, "TurboLensModernizeRequest": { "properties": { "modernization_type": { "default": "general", "title": "Modernization Type", "type": "string" }, "target_type": { "default": "Application", "title": "Target Type", "type": "string" } }, "title": "TurboLensModernizeRequest", "type": "object" }, "TurboLensOverviewOut": { "properties": { "cards_by_type": { "additionalProperties": { "type": "integer" }, "default": {}, "title": "Cards By Type", "type": "object" }, "duplicate_clusters": { "default": 0, "title": "Duplicate Clusters", "type": "integer" }, "modernization_count": { "default": 0, "title": "Modernization Count", "type": "integer" }, "quality_avg": { "default": 0, "title": "Quality Avg", "type": "number" }, "quality_bronze": { "default": 0, "title": "Quality Bronze", "type": "integer" }, "quality_gold": { "default": 0, "title": "Quality Gold", "type": "integer" }, "quality_silver": { "default": 0, "title": "Quality Silver", "type": "integer" }, "top_issues": { "default": [], "items": { "additionalProperties": true, "type": "object" }, "title": "Top Issues", "type": "array" }, "total_cards": { "default": 0, "title": "Total Cards", "type": "integer" }, "total_cost": { "default": 0, "title": "Total Cost", "type": "number" }, "vendor_count": { "default": 0, "title": "Vendor Count", "type": "integer" } }, "title": "TurboLensOverviewOut", "type": "object" }, "TurboLensStatusOut": { "properties": { "ai_configured": { "title": "Ai Configured", "type": "boolean" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "ready": { "title": "Ready", "type": "boolean" } }, "required": [ "ai_configured", "ready" ], "title": "TurboLensStatusOut", "type": "object" }, "UiPreferencesUpdate": { "properties": { "dashboard_default_tab": { "anyOf": [ { "enum": [ "overview", "workspace", "admin" ], "type": "string" }, { "type": "null" } ], "title": "Dashboard Default Tab" } }, "title": "UiPreferencesUpdate", "type": "object" }, "UserBulkDelete": { "properties": { "ids": { "items": { "type": "string" }, "title": "Ids", "type": "array" } }, "required": [ "ids" ], "title": "UserBulkDelete", "type": "object" }, "UserBulkUpdate": { "properties": { "ids": { "items": { "type": "string" }, "title": "Ids", "type": "array" }, "updates": { "$ref": "#/components/schemas/UserBulkUpdateFields" } }, "required": [ "ids", "updates" ], "title": "UserBulkUpdate", "type": "object" }, "UserBulkUpdateFields": { "properties": { "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, "title": "UserBulkUpdateFields", "type": "object" }, "UserCreate": { "properties": { "auth_provider": { "anyOf": [ { "enum": [ "local", "sso" ], "type": "string" }, { "type": "null" } ], "title": "Auth Provider" }, "display_name": { "title": "Display Name", "type": "string" }, "email": { "format": "email", "title": "Email", "type": "string" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "role": { "default": "member", "title": "Role", "type": "string" }, "send_email": { "default": false, "title": "Send Email", "type": "boolean" } }, "required": [ "email", "display_name" ], "title": "UserCreate", "type": "object" }, "UserResponse": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "email": { "title": "Email", "type": "string" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "locale": { "default": "en", "title": "Locale", "type": "string" }, "permissions": { "anyOf": [ { "additionalProperties": { "type": "boolean" }, "type": "object" }, { "type": "null" } ], "title": "Permissions" }, "role": { "title": "Role", "type": "string" }, "role_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Color" }, "role_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Label" }, "ui_preferences": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ui Preferences" } }, "required": [ "id", "email", "display_name", "role", "is_active" ], "title": "UserResponse", "type": "object" }, "UserUpdate": { "properties": { "auth_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Auth Provider" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "title": "Email" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" } }, "title": "UserUpdate", "type": "object" }, "ValidateRequest": { "properties": { "formula": { "maxLength": 5000, "title": "Formula", "type": "string" }, "target_type_key": { "title": "Target Type Key", "type": "string" } }, "required": [ "formula", "target_type_key" ], "title": "ValidateRequest", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "VendorAnalysisOut": { "properties": { "analysed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Analysed At" }, "app_count": { "default": 0, "title": "App Count", "type": "integer" }, "app_list": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "App List" }, "category": { "title": "Category", "type": "string" }, "id": { "title": "Id", "type": "string" }, "reasoning": { "default": "", "title": "Reasoning", "type": "string" }, "sub_category": { "default": "", "title": "Sub Category", "type": "string" }, "total_cost": { "default": 0, "title": "Total Cost", "type": "number" }, "vendor_name": { "title": "Vendor Name", "type": "string" } }, "required": [ "id", "vendor_name", "category" ], "title": "VendorAnalysisOut", "type": "object" }, "VendorHierarchyOut": { "properties": { "aliases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Aliases" }, "analysed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Analysed At" }, "app_count": { "default": 0, "title": "App Count", "type": "integer" }, "canonical_name": { "title": "Canonical Name", "type": "string" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence" }, "id": { "title": "Id", "type": "string" }, "itc_count": { "default": 0, "title": "Itc Count", "type": "integer" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" }, "sub_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Category" }, "total_cost": { "default": 0, "title": "Total Cost", "type": "number" }, "vendor_type": { "default": "vendor", "title": "Vendor Type", "type": "string" } }, "required": [ "id", "canonical_name" ], "title": "VendorHierarchyOut", "type": "object" }, "WebPortalCreate": { "properties": { "card_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Card Config" }, "card_type": { "title": "Card Type", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_fields": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Display Fields" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "is_published": { "default": false, "title": "Is Published", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "name", "slug", "card_type" ], "title": "WebPortalCreate", "type": "object" }, "WebPortalUpdate": { "properties": { "card_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Card Config" }, "card_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_fields": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Display Fields" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "is_published": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Published" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" } }, "title": "WebPortalUpdate", "type": "object" }, "app__api__v1__migration__StagedRecordOut": { "properties": { "action": { "title": "Action", "type": "string" }, "card_type_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type Key" }, "diff": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Diff" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "entity_kind": { "title": "Entity Kind", "type": "string" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "id": { "title": "Id", "type": "string" }, "source_id": { "title": "Source Id", "type": "string" }, "source_type": { "title": "Source Type", "type": "string" }, "status": { "title": "Status", "type": "string" }, "target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Id" } }, "required": [ "id", "entity_kind", "source_id", "source_type", "card_type_key", "action", "status", "diff", "error_message", "target_id" ], "title": "StagedRecordOut", "type": "object" }, "app__api__v1__servicenow__StagedRecordOut": { "properties": { "action": { "title": "Action", "type": "string" }, "card_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "diff": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Diff" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "id": { "title": "Id", "type": "string" }, "snow_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Snow Data" }, "snow_sys_id": { "title": "Snow Sys Id", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "snow_sys_id", "action", "status" ], "title": "StagedRecordOut", "type": "object" } } }, "info": { "title": "Turbo EA", "version": "latest" }, "openapi": "3.1.0", "paths": { "/api/health": { "get": { "operationId": "health_api_health_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Health" } }, "/api/v1/adr": { "get": { "operationId": "list_adrs_api_v1_adr_get", "parameters": [ { "in": "query", "name": "initiative_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initiative Id" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "search", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "in": "query", "name": "card_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Id" } }, { "in": "query", "name": "card_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type" } }, { "in": "query", "name": "date_from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date From" } }, { "in": "query", "name": "date_to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date To" } }, { "in": "query", "name": "modified_from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modified From" } }, { "in": "query", "name": "modified_to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Modified To" } }, { "in": "query", "name": "signed_from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signed From" } }, { "in": "query", "name": "signed_to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signed To" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Adrs", "tags": [ "adr" ] }, "post": { "operationId": "create_adr_api_v1_adr_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Adr", "tags": [ "adr" ] } }, "/api/v1/adr/by-card/{card_id}": { "get": { "description": "Get all ADRs linked to a specific card.", "operationId": "list_adrs_for_card_api_v1_adr_by_card__card_id__get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Adrs For Card", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}": { "delete": { "operationId": "delete_adr_api_v1_adr__adr_id__delete", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Adr", "tags": [ "adr" ] }, "get": { "operationId": "get_adr_api_v1_adr__adr_id__get", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Adr", "tags": [ "adr" ] }, "patch": { "operationId": "update_adr_api_v1_adr__adr_id__patch", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Adr", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/cards": { "post": { "description": "Link an ADR to a card.", "operationId": "link_card_api_v1_adr__adr_id__cards_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRCardLink" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Link Card", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/cards/{card_id}": { "delete": { "description": "Unlink an ADR from a card.", "operationId": "unlink_card_api_v1_adr__adr_id__cards__card_id__delete", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } }, { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Unlink Card", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/duplicate": { "post": { "description": "Duplicate an ADR as a new draft with a new reference number.", "operationId": "duplicate_adr_api_v1_adr__adr_id__duplicate_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Duplicate Adr", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/recall-signatures": { "post": { "description": "Recall all pending signature requests. Resets status to draft and\nclears signatories.", "operationId": "recall_adr_signatures_api_v1_adr__adr_id__recall_signatures_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recall Adr Signatures", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/reject": { "post": { "description": "Reject the ADR as a signatory. Resets to draft, increments revision\nnumber, clears all signatories, and notifies the creator.", "operationId": "reject_adr_api_v1_adr__adr_id__reject_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRRejectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Reject Adr", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/request-signatures": { "post": { "description": "Request signatures from specified users.", "operationId": "request_signatures_api_v1_adr__adr_id__request_signatures_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRSignatureRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Request Signatures", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/revise": { "post": { "description": "Create a new revision of a signed ADR.", "operationId": "revise_adr_api_v1_adr__adr_id__revise_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Revise Adr", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/revisions": { "get": { "description": "List all revisions in the chain for this ADR.", "operationId": "list_revisions_api_v1_adr__adr_id__revisions_get", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Revisions", "tags": [ "adr" ] } }, "/api/v1/adr/{adr_id}/sign": { "post": { "description": "Sign the ADR as the current user.", "operationId": "sign_adr_api_v1_adr__adr_id__sign_post", "parameters": [ { "in": "path", "name": "adr_id", "required": true, "schema": { "title": "Adr Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sign Adr", "tags": [ "adr" ] } }, "/api/v1/ai/portfolio-insights": { "post": { "description": "Generate AI-driven insights for the application portfolio report.", "operationId": "portfolio_insights_api_v1_ai_portfolio_insights_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioInsightsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioInsightsResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Portfolio Insights", "tags": [ "AI Suggestions" ] } }, "/api/v1/ai/status": { "get": { "description": "Check whether AI suggestions are enabled and configured.\n\nReturns the status without exposing secrets.", "operationId": "ai_status_api_v1_ai_status_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Ai Status", "tags": [ "AI Suggestions" ] } }, "/api/v1/ai/suggest": { "post": { "description": "Generate AI-powered metadata suggestions for a card.\n\nUses a two-step pipeline: web search \u2192 local LLM extraction.", "operationId": "suggest_api_v1_ai_suggest_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSuggestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSuggestResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Suggest", "tags": [ "AI Suggestions" ] } }, "/api/v1/auth/forgot-password": { "post": { "description": "Initiate a password reset for a local account.\n\nAnti-enumeration: always returns `{\"ok\": True}` regardless of whether the\nemail matches a user. An email is only sent when ALL of the following hold:\n\n- A user exists with the given email.\n- The user has a local password (not SSO-only).\n- The user is active.\n- SMTP is configured.\n\nTokens live for one hour and are stored on the user row directly.", "operationId": "forgot_password_api_v1_auth_forgot_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Forgot Password", "tags": [ "auth" ] } }, "/api/v1/auth/login": { "post": { "operationId": "login_api_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Login", "tags": [ "auth" ] } }, "/api/v1/auth/logout": { "post": { "description": "Clear the auth cookie.", "operationId": "logout_api_v1_auth_logout_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Logout", "tags": [ "auth" ] } }, "/api/v1/auth/me": { "get": { "operationId": "me_api_v1_auth_me_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } }, "description": "Successful Response" } }, "summary": "Me", "tags": [ "auth" ] } }, "/api/v1/auth/refresh": { "post": { "description": "Issue a new short-lived access token. Re-reads role and active status from DB.", "operationId": "refresh_token_api_v1_auth_refresh_post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" } }, "summary": "Refresh Token", "tags": [ "auth" ] } }, "/api/v1/auth/register": { "post": { "operationId": "register_api_v1_auth_register_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Register", "tags": [ "auth" ] } }, "/api/v1/auth/reset-password": { "post": { "description": "Consume a reset token and set a new password. Does NOT auto-log-in.", "operationId": "reset_password_api_v1_auth_reset_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Reset Password", "tags": [ "auth" ] } }, "/api/v1/auth/set-password": { "post": { "description": "Set a password for an invited user using a one-time setup token.", "operationId": "set_password_api_v1_auth_set_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Set Password", "tags": [ "auth" ] } }, "/api/v1/auth/sso/callback": { "post": { "description": "Exchange an authorization code from an SSO provider for a Turbo EA JWT.", "operationId": "sso_callback_api_v1_auth_sso_callback_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoCallbackRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Sso Callback", "tags": [ "auth" ] } }, "/api/v1/auth/sso/config": { "get": { "description": "Public endpoint \u2014 returns SSO configuration needed by the frontend to\nbuild the authorization URL. No secrets are exposed.\nAlso includes registration_enabled so the login page knows whether to\nshow the Register tab.", "operationId": "sso_config_endpoint_api_v1_auth_sso_config_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Sso Config Endpoint", "tags": [ "auth" ] } }, "/api/v1/auth/validate-reset-token": { "get": { "description": "Check whether a password-reset token is valid and unexpired.", "operationId": "validate_reset_token_api_v1_auth_validate_reset_token_get", "parameters": [ { "in": "query", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Validate Reset Token", "tags": [ "auth" ] } }, "/api/v1/auth/validate-setup-token": { "get": { "description": "Check if a password-setup token is valid. Returns the user's email.", "operationId": "validate_setup_token_api_v1_auth_validate_setup_token_get", "parameters": [ { "in": "query", "name": "token", "required": true, "schema": { "title": "Token", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Validate Setup Token", "tags": [ "auth" ] } }, "/api/v1/bookmarks": { "get": { "operationId": "list_bookmarks_api_v1_bookmarks_get", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "default": "all", "pattern": "^(all|my|shared|public)$", "title": "Filter", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Bookmarks", "tags": [ "bookmarks" ] }, "post": { "operationId": "create_bookmark_api_v1_bookmarks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookmarkCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Bookmark", "tags": [ "bookmarks" ] } }, "/api/v1/bookmarks/{bm_id}": { "delete": { "operationId": "delete_bookmark_api_v1_bookmarks__bm_id__delete", "parameters": [ { "in": "path", "name": "bm_id", "required": true, "schema": { "title": "Bm Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Bookmark", "tags": [ "bookmarks" ] }, "patch": { "operationId": "update_bookmark_api_v1_bookmarks__bm_id__patch", "parameters": [ { "in": "path", "name": "bm_id", "required": true, "schema": { "title": "Bm Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookmarkUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Bookmark", "tags": [ "bookmarks" ] } }, "/api/v1/bookmarks/{bm_id}/odata": { "get": { "description": "OData-style JSON feed for a bookmark's filtered cards.\nRequires authentication. Returns data matching the bookmark's saved filters.", "operationId": "bookmark_odata_feed_api_v1_bookmarks__bm_id__odata_get", "parameters": [ { "in": "path", "name": "bm_id", "required": true, "schema": { "title": "Bm Id", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 1000, "maximum": 10000, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Bookmark Odata Feed", "tags": [ "bookmarks" ] } }, "/api/v1/bpm/processes/{process_id}/assessments": { "get": { "operationId": "list_assessments_api_v1_bpm_processes__process_id__assessments_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Assessments", "tags": [ "bpm" ] }, "post": { "operationId": "create_assessment_api_v1_bpm_processes__process_id__assessments_post", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessAssessmentCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Assessment", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/assessments/{assessment_id}": { "delete": { "operationId": "delete_assessment_api_v1_bpm_processes__process_id__assessments__assessment_id__delete", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "assessment_id", "required": true, "schema": { "title": "Assessment Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Assessment", "tags": [ "bpm" ] }, "put": { "operationId": "update_assessment_api_v1_bpm_processes__process_id__assessments__assessment_id__put", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "assessment_id", "required": true, "schema": { "title": "Assessment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessAssessmentUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Assessment", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/diagram": { "delete": { "description": "Delete all diagram versions and extracted elements for a process.", "operationId": "delete_diagram_api_v1_bpm_processes__process_id__diagram_delete", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Diagram", "tags": [ "bpm" ] }, "get": { "operationId": "get_diagram_api_v1_bpm_processes__process_id__diagram_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Diagram", "tags": [ "bpm" ] }, "put": { "operationId": "save_diagram_api_v1_bpm_processes__process_id__diagram_put", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Save Diagram", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/diagram/export/bpmn": { "get": { "operationId": "export_bpmn_api_v1_bpm_processes__process_id__diagram_export_bpmn_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Export Bpmn", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/diagram/export/svg": { "get": { "operationId": "export_svg_api_v1_bpm_processes__process_id__diagram_export_svg_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Export Svg", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/diagram/import": { "post": { "operationId": "import_bpmn_api_v1_bpm_processes__process_id__diagram_import_post", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_bpmn_api_v1_bpm_processes__process_id__diagram_import_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Bpmn", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/diagram/versions": { "get": { "operationId": "list_diagram_versions_api_v1_bpm_processes__process_id__diagram_versions_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Diagram Versions", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/elements": { "get": { "operationId": "list_elements_api_v1_bpm_processes__process_id__elements_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Elements", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/elements/{element_id}": { "put": { "operationId": "update_element_api_v1_bpm_processes__process_id__elements__element_id__put", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "element_id", "required": true, "schema": { "title": "Element Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Element", "tags": [ "bpm" ] } }, "/api/v1/bpm/processes/{process_id}/flow/archived": { "get": { "description": "List archived process flow versions (most recent first).", "operationId": "list_archived_api_v1_bpm_processes__process_id__flow_archived_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Archived", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/drafts": { "get": { "description": "List draft (and pending) flow versions for a process.", "operationId": "list_drafts_api_v1_bpm_processes__process_id__flow_drafts_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Drafts", "tags": [ "bpm-workflow" ] }, "post": { "description": "Create a new draft process flow, optionally cloned from an existing version.", "operationId": "create_draft_api_v1_bpm_processes__process_id__flow_drafts_post", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFlowVersionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Draft", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/permissions": { "get": { "description": "Return the current user's permissions on the process flow.", "operationId": "get_flow_permissions_api_v1_bpm_processes__process_id__flow_permissions_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Flow Permissions", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/published": { "get": { "description": "Get the currently published process flow (visible to all authenticated users).", "operationId": "get_published_flow_api_v1_bpm_processes__process_id__flow_published_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Published Flow", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/versions/{version_id}": { "delete": { "description": "Delete a draft process flow. Only drafts can be deleted.", "operationId": "delete_draft_api_v1_bpm_processes__process_id__flow_versions__version_id__delete", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Draft", "tags": [ "bpm-workflow" ] }, "get": { "description": "Get a specific process flow version by ID.", "operationId": "get_version_api_v1_bpm_processes__process_id__flow_versions__version_id__get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Version", "tags": [ "bpm-workflow" ] }, "patch": { "description": "Update a draft process flow. Only drafts can be edited.", "operationId": "update_draft_api_v1_bpm_processes__process_id__flow_versions__version_id__patch", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFlowVersionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Draft", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/versions/{version_id}/approve": { "post": { "description": "Approve a pending process flow. The approved version becomes published;\nthe previous published version becomes archived.", "operationId": "approve_version_api_v1_bpm_processes__process_id__flow_versions__version_id__approve_post", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Approve Version", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/versions/{version_id}/draft-elements": { "get": { "description": "Parse BPMN XML from a draft/pending version and return extracted elements\nmerged with any saved draft_element_links (pre-linked EA references).", "operationId": "get_draft_elements_api_v1_bpm_processes__process_id__flow_versions__version_id__draft_elements_get", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Draft Elements", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/versions/{version_id}/draft-elements/{bpmn_element_id}": { "put": { "description": "Update a single draft element link (pre-link EA references before publishing).", "operationId": "update_draft_element_link_api_v1_bpm_processes__process_id__flow_versions__version_id__draft_elements__bpmn_element_id__put", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } }, { "in": "path", "name": "bpmn_element_id", "required": true, "schema": { "title": "Bpmn Element Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Draft Element Link", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/versions/{version_id}/reject": { "post": { "description": "Reject a pending process flow, returning it to draft status.", "operationId": "reject_version_api_v1_bpm_processes__process_id__flow_versions__version_id__reject_post", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Reject Version", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/processes/{process_id}/flow/versions/{version_id}/submit": { "post": { "description": "Submit a draft for approval by the business process owner.", "operationId": "submit_for_approval_api_v1_bpm_processes__process_id__flow_versions__version_id__submit_post", "parameters": [ { "in": "path", "name": "process_id", "required": true, "schema": { "title": "Process Id", "type": "string" } }, { "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Submit For Approval", "tags": [ "bpm-workflow" ] } }, "/api/v1/bpm/templates": { "get": { "operationId": "list_templates_api_v1_bpm_templates_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "List Templates", "tags": [ "bpm" ] } }, "/api/v1/bpm/templates/{template_key}": { "get": { "operationId": "get_template_api_v1_bpm_templates__template_key__get", "parameters": [ { "in": "path", "name": "template_key", "required": true, "schema": { "title": "Template Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Template", "tags": [ "bpm" ] } }, "/api/v1/calculations": { "get": { "operationId": "list_calculations_api_v1_calculations_get", "parameters": [ { "in": "query", "name": "type_key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type Key" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CalculationResponse" }, "title": "Response List Calculations Api V1 Calculations Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Calculations", "tags": [ "calculations" ] }, "post": { "operationId": "create_calculation_api_v1_calculations_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Calculation", "tags": [ "calculations" ] } }, "/api/v1/calculations/calculated-fields": { "get": { "description": "Return a map of type_key -> list of field keys that are targeted by active calculations.", "operationId": "get_calculated_fields_api_v1_calculations_calculated_fields_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Get Calculated Fields", "tags": [ "calculations" ] } }, "/api/v1/calculations/recalculate/{type_key}": { "post": { "description": "Bulk recalculate all cards of a type.", "operationId": "recalculate_type_api_v1_calculations_recalculate__type_key__post", "parameters": [ { "in": "path", "name": "type_key", "required": true, "schema": { "title": "Type Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recalculate Type", "tags": [ "calculations" ] } }, "/api/v1/calculations/validate": { "post": { "operationId": "validate_formula_endpoint_api_v1_calculations_validate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Validate Formula Endpoint", "tags": [ "calculations" ] } }, "/api/v1/calculations/{calc_id}": { "delete": { "operationId": "delete_calculation_api_v1_calculations__calc_id__delete", "parameters": [ { "in": "path", "name": "calc_id", "required": true, "schema": { "title": "Calc Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Calculation", "tags": [ "calculations" ] }, "get": { "operationId": "get_calculation_api_v1_calculations__calc_id__get", "parameters": [ { "in": "path", "name": "calc_id", "required": true, "schema": { "title": "Calc Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Calculation", "tags": [ "calculations" ] }, "patch": { "operationId": "update_calculation_api_v1_calculations__calc_id__patch", "parameters": [ { "in": "path", "name": "calc_id", "required": true, "schema": { "title": "Calc Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Calculation", "tags": [ "calculations" ] } }, "/api/v1/calculations/{calc_id}/activate": { "post": { "operationId": "activate_calculation_api_v1_calculations__calc_id__activate_post", "parameters": [ { "in": "path", "name": "calc_id", "required": true, "schema": { "title": "Calc Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Activate Calculation", "tags": [ "calculations" ] } }, "/api/v1/calculations/{calc_id}/deactivate": { "post": { "operationId": "deactivate_calculation_api_v1_calculations__calc_id__deactivate_post", "parameters": [ { "in": "path", "name": "calc_id", "required": true, "schema": { "title": "Calc Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deactivate Calculation", "tags": [ "calculations" ] } }, "/api/v1/calculations/{calc_id}/test": { "post": { "description": "Test a calculation with a specific card (dry run, no save).", "operationId": "test_calculation_api_v1_calculations__calc_id__test_post", "parameters": [ { "in": "path", "name": "calc_id", "required": true, "schema": { "title": "Calc Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Test Calculation", "tags": [ "calculations" ] } }, "/api/v1/capability-catalogue": { "get": { "description": "Return the full active catalogue with `existing_card_id` annotations.\n\nThe optional `locale` query param overrides the user's saved locale \u2014\nused by the frontend to follow live UI language switches without waiting\nfor the `user.locale` PATCH to land. Falls back to `user.locale`, then\nEnglish. Translations themselves come from the bundled package; missing\nper-field translations degrade silently to English.", "operationId": "get_catalogue_api_v1_capability_catalogue_get", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Catalogue", "tags": [ "capability-catalogue" ] } }, "/api/v1/capability-catalogue/import": { "post": { "description": "Create BusinessCapability cards for the selected catalogue entries.\n\nIdempotent: catalogue entries whose name already exists as a non-archived\nBusinessCapability are skipped (and reported in the `skipped` list).\nHierarchy is preserved automatically when both parent and child are\nselected, or when the parent already exists.\n\nThe optional `locale` in the request body controls which language the\nnew cards are written in (`name`, `description`, `aliases`); falls back\nto the user's saved locale, then English. Existing-card matching is\nalways English-anchored so a localized import never duplicates a card.", "operationId": "import_capabilities_api_v1_capability_catalogue_import_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Import Capabilities", "tags": [ "capability-catalogue" ] } }, "/api/v1/capability-catalogue/update-fetch": { "post": { "description": "Download the latest catalogue from the public site and cache it.", "operationId": "update_fetch_api_v1_capability_catalogue_update_fetch_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Update Fetch", "tags": [ "capability-catalogue" ] } }, "/api/v1/capability-catalogue/update-status": { "get": { "description": "Compare the bundled/cached catalogue against the public site.", "operationId": "update_status_api_v1_capability_catalogue_update_status_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Update Status", "tags": [ "capability-catalogue" ] } }, "/api/v1/cards": { "get": { "operationId": "list_cards_api_v1_cards_get", "parameters": [ { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "search", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "in": "query", "name": "parent_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, { "in": "query", "name": "approval_status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approval Status" } }, { "description": "Scope the result to cards related to the current user. `stakeholder` keeps only cards on which the user holds at least one stakeholder role.", "in": "query", "name": "mine", "required": false, "schema": { "anyOf": [ { "pattern": "^(stakeholder)$", "type": "string" }, { "type": "null" } ], "description": "Scope the result to cards related to the current user. `stakeholder` keeps only cards on which the user holds at least one stakeholder role.", "title": "Mine" } }, { "description": "Comma-separated UUIDs to fetch in one round trip. Used by the diagram editor's view perspectives to recolor cells.", "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated UUIDs to fetch in one round trip. Used by the diagram editor's view perspectives to recolor cells.", "title": "Ids" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 10000, "maximum": 10000, "minimum": 1, "title": "Page Size", "type": "integer" } }, { "in": "query", "name": "sort_by", "required": false, "schema": { "default": "name", "title": "Sort By", "type": "string" } }, { "in": "query", "name": "sort_dir", "required": false, "schema": { "default": "asc", "title": "Sort Dir", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardListResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Cards", "tags": [ "cards" ] }, "post": { "operationId": "create_card_api_v1_cards_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Card", "tags": [ "cards" ] } }, "/api/v1/cards/bulk": { "patch": { "operationId": "bulk_update_api_v1_cards_bulk_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Bulk Update", "tags": [ "cards" ] } }, "/api/v1/cards/bulk-archive": { "post": { "description": "Archive many cards in a single transaction.\n\nSolves a class of problems that the per-card endpoint cannot:\n - browser parallelism: 1 round-trip instead of N (no socket-pool exhaustion);\n - cascade race: archiving a parent that cascades to a descendant which is\n also in the input list is a single coherent operation, not a fight\n between sibling workers seeing the descendant in different states;\n - reporting: one aggregated response with `archived`, `cascaded`, `skipped`\n instead of N independent failures the caller has to stitch together.\n\nCards already at status=ARCHIVED, or whose IDs don't resolve, are returned\nin `skipped` rather than failing the batch \u2014 the user's intent (everything\nin the input ends up archived) is satisfied either way.", "operationId": "bulk_archive_cards_api_v1_cards_bulk_archive_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkArchiveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkArchiveResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Bulk Archive Cards", "tags": [ "cards" ] } }, "/api/v1/cards/bulk-create": { "post": { "description": "Batched card creation for the spreadsheet importer.\n\nEach row carries its own `row_index` so the caller can pair the\nresponse back to its spreadsheet row. Parents may be referenced by\nUUID (`parent_id`) or by `(parent_path, parent_name)` \u2014 the server\nresolves names server-side against the existing inventory and against\nother rows in the same request (which may not exist yet).\n\nRows are processed in topological order: parents come before children\nso FK constraints never fire. If a row's parent cannot be resolved\neven after every other row has been placed, it fails with a clear\n`parent_not_resolved` error instead of producing an orphan card.\n\nSingle transaction per request \u2014 partial failures still roll back\nsucceeded rows in the same batch. Permission: `inventory.create`.", "operationId": "bulk_create_cards_api_v1_cards_bulk_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkCreateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkCreateResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Bulk Create Cards", "tags": [ "cards" ] } }, "/api/v1/cards/bulk-delete": { "post": { "description": "Permanently delete many cards in a single transaction.\n\nMirrors `bulk_archive_cards`. Unlike archive, delete works on cards in any\nstatus (ACTIVE or ARCHIVED), so the only `skipped` reason is `not_found`\n(the card was already deleted by a sibling primary's cascade in the same\nbatch, or never existed).\n\nDescendants are deleted leaves-first to satisfy the self-FK on `parent_id`.", "operationId": "bulk_delete_cards_api_v1_cards_bulk_delete_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkDeleteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkDeleteResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Bulk Delete Cards", "tags": [ "cards" ] } }, "/api/v1/cards/bulk-restore": { "post": { "description": "Restore many archived cards back to ACTIVE status in a single transaction.\n\nMirrors `bulk_archive_cards` for the inverse operation. Cards already at\nACTIVE, or whose IDs don't resolve, come back in `skipped` rather than\nfailing the batch \u2014 restoring is idempotent in spirit (the desired end\nstate is \"this card is active\", and that's already true).\n\nNo cascade: restore is a flat per-card status flip. The single-card\nendpoint takes `also_restore_card_ids` to lift passengers from the\noriginal archive batch; for bulk we expect the caller (the inventory\nselection UI) to have already gathered the full list of cards to restore.", "operationId": "bulk_restore_cards_api_v1_cards_bulk_restore_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkRestoreRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardBulkRestoreResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Bulk Restore Cards", "tags": [ "cards" ] } }, "/api/v1/cards/counts": { "get": { "description": "Per-card-type counts of ACTIVE cards. Powers the type chips with\ncounts in the diagram editor's Insert Cards dialog (LeanIX-style).\nHidden types are excluded so the dialog never offers them.\n\nDeclared above /{card_id} so the literal `counts` segment isn't shadowed\nby the UUID-typed catch-all and parsed as a (broken) UUID.", "operationId": "cards_counts_api_v1_cards_counts_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCountsResponse" } } }, "description": "Successful Response" } }, "summary": "Cards Counts", "tags": [ "cards" ] } }, "/api/v1/cards/export/csv": { "get": { "operationId": "export_csv_api_v1_cards_export_csv_get", "parameters": [ { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Export Csv", "tags": [ "cards" ] } }, "/api/v1/cards/export/json": { "get": { "description": "Bulk export cards as JSON for integration consumers (e.g. TurboLens MCP).\n\nReturns all active cards of the given types with optional pre-joined\nprovider relation names and stakeholder owner info.", "operationId": "export_json_api_v1_cards_export_json_get", "parameters": [ { "description": "Comma-separated type keys", "in": "query", "name": "types", "required": true, "schema": { "description": "Comma-separated type keys", "title": "Types", "type": "string" } }, { "in": "query", "name": "include_relations", "required": false, "schema": { "default": false, "title": "Include Relations", "type": "boolean" } }, { "in": "query", "name": "include_stakeholders", "required": false, "schema": { "default": false, "title": "Include Stakeholders", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Export Json", "tags": [ "cards" ] } }, "/api/v1/cards/fix-hierarchy-names": { "post": { "operationId": "fix_hierarchy_names_api_v1_cards_fix_hierarchy_names_post", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Fix Hierarchy Names", "tags": [ "cards" ] } }, "/api/v1/cards/my-created": { "get": { "description": "Cards the current user originally created (via ``Card.created_by``).\n\nSupports simple offset/limit pagination so the Dashboard \u2192 My\nWorkspace \u2192 Cards I Created section can offer a \"Show more\" button\non long lists.", "operationId": "list_my_created_cards_api_v1_cards_my_created_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List My Created Cards", "tags": [ "cards" ] } }, "/api/v1/cards/my-stakeholder": { "get": { "description": "Cards on which the target user holds at least one stakeholder role.\n\nDefaults to the **current user** so the legacy\n``GET /cards/my-stakeholder`` (no query params) keeps powering the\nWorkspace \u2192 \"My roles\" dashboard section without changes.\n\nPass ``?user_id=`` to look up another user's stakeholder\nportfolio \u2014 the Workspace section reuses this to offer a \"view as\nanother user\" picker. Cross-user lookups require ``stakeholders.view``.\n\nReturns cards plus a ``roles_by_card_id`` map keyed by card id, where\neach entry is a list of role descriptors ``{key, label, color,\ntranslations}`` resolved from the matching ``StakeholderRoleDefinition``\nfor the card's type. The frontend uses ``label`` + ``translations`` to\nrender a localised role chip per role.", "operationId": "list_my_stakeholder_cards_api_v1_cards_my_stakeholder_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Look up another user's stakeholder cards instead of your own. When omitted (or equal to the caller's id) returns the current user \u2014 same as the no-arg behaviour. When set to another user's id, requires the `stakeholders.view` permission.", "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Look up another user's stakeholder cards instead of your own. When omitted (or equal to the caller's id) returns the current user \u2014 same as the no-arg behaviour. When set to another user's id, requires the `stakeholders.view` permission.", "title": "User Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List My Stakeholder Cards", "tags": [ "cards" ] } }, "/api/v1/cards/resolve-refs": { "post": { "description": "Resolve a batch of human-readable card references (`name` or\n`parent_path/name`) to UUIDs in one round-trip.\n\nUsed by the spreadsheet importer's validation pass to surface\nambiguous or missing references **before** anything is written. Each\nref carries the originating `row` + `column` so the importer can\npin the result to the cell that produced it.\n\nReturns one result per ref with status `resolved`, `ambiguous`, or\n`missing`. Ambiguous results include up to a handful of candidate\npaths so the UI can render a useful disambiguation hint.", "operationId": "resolve_card_refs_api_v1_cards_resolve_refs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardRefResolveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardRefResolveResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Resolve Card Refs", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}": { "delete": { "description": "Permanently delete a card plus optional descendants and related peer cards.\n\nMirrors `archive_card`'s body shape and rules. The primary is always deleted;\ndescendants are deleted leaves-first to satisfy the self-FK on `parent_id`.\nRelated cards are processed single-hop only.\n\nReturns 409 if the primary has direct children and `child_strategy` is None.", "operationId": "delete_card_api_v1_cards__card_id__delete", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDeleteRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDeleteResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Card", "tags": [ "cards" ] }, "get": { "operationId": "get_card_api_v1_cards__card_id__get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Card", "tags": [ "cards" ] }, "patch": { "operationId": "update_card_api_v1_cards__card_id__patch", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Card", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/approval-status": { "post": { "operationId": "update_approval_status_api_v1_cards__card_id__approval_status_post", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } }, { "in": "query", "name": "action", "required": true, "schema": { "pattern": "^(approve|reject|reset)$", "title": "Action", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Approval Status", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/archive": { "post": { "description": "Archive a card (soft delete) plus optional descendants and related peer cards.\n\nBody shape:\n - `child_strategy`: `cascade` | `disconnect` | `reparent` (required if the\n primary card has direct children \u2014 otherwise 409).\n - `related_card_ids`: peer cards (capped at 200) to also archive in the\n same operation. Single-hop only \u2014 the related cards' own peer relations\n are NOT recursed.\n - `cascade_all_related`: bulk-mode shortcut that resolves all direct\n relations of the primary on the server side.\n\nPermission check runs against every affected card; first denial aborts.", "operationId": "archive_card_api_v1_cards__card_id__archive_post", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardArchiveRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardArchiveResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Archive Card", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/archive-impact": { "get": { "description": "Pre-flight payload for the archive/delete dialog.\n\nReturns the direct children, the grandparent (if any), and every peer card\nlinked via a `relations` row. Hidden card-types are filtered out, mirroring\nthe relations list endpoint at `/api/v1/relations`.", "operationId": "get_archive_impact_api_v1_cards__card_id__archive_impact_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveImpactResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Archive Impact", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/comments": { "get": { "operationId": "list_comments_api_v1_cards__card_id__comments_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Comments", "tags": [ "comments" ] }, "post": { "operationId": "create_comment_api_v1_cards__card_id__comments_post", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Comment", "tags": [ "comments" ] } }, "/api/v1/cards/{card_id}/compliance-findings": { "get": { "description": "All compliance findings scoped to a single card.\n\nOrdered by severity then regulation/article. Used by the Compliance\ntab on the Card Detail page (mirrors ``GET /cards/{id}/risks``).", "operationId": "list_card_compliance_findings_api_v1_cards__card_id__compliance_findings_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } }, { "in": "query", "name": "include_auto_resolved", "required": false, "schema": { "default": false, "title": "Include Auto Resolved", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ComplianceFindingOut" }, "title": "Response List Card Compliance Findings Api V1 Cards Card Id Compliance Findings Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Card Compliance Findings", "tags": [ "TurboLens" ] } }, "/api/v1/cards/{card_id}/documents": { "get": { "operationId": "list_documents_api_v1_cards__card_id__documents_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Documents", "tags": [ "documents" ] }, "post": { "operationId": "create_document_api_v1_cards__card_id__documents_post", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Document", "tags": [ "documents" ] } }, "/api/v1/cards/{card_id}/file-attachments": { "get": { "operationId": "list_file_attachments_api_v1_cards__card_id__file_attachments_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List File Attachments", "tags": [ "file-attachments" ] }, "post": { "operationId": "upload_file_attachment_api_v1_cards__card_id__file_attachments_post", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_attachment_api_v1_cards__card_id__file_attachments_post" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Upload File Attachment", "tags": [ "file-attachments" ] } }, "/api/v1/cards/{card_id}/hierarchy": { "get": { "description": "Return ancestors (root\u2192parent), children, and computed level.", "operationId": "get_hierarchy_api_v1_cards__card_id__hierarchy_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Hierarchy", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/history": { "get": { "operationId": "get_history_api_v1_cards__card_id__history_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get History", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/me/observe": { "delete": { "description": "One-click removal of self-assigned Observer role.\n\nIdempotent: returns 204 even when no row existed. Does not require the\nObserver role to still be active on the card type \u2014 stale subscriptions\nmust always be removable.", "operationId": "remove_me_as_observer_api_v1_cards__card_id__me_observe_delete", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Remove Me As Observer", "tags": [ "stakeholders" ] }, "get": { "description": "Return whether the current user is observing this card and whether the\nObserver role is available for the card type. Used by the one-click\n\"Observe this card\" toggle on the card detail page.", "operationId": "get_my_observe_status_api_v1_cards__card_id__me_observe_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get My Observe Status", "tags": [ "stakeholders" ] }, "post": { "description": "One-click self-assignment as Observer.\n\nCarve-out from the regular create-stakeholder flow: any user with view\naccess on the card can add themselves as Observer, even without the\n`stakeholders.manage` permission. The route hardcodes `role=\"observer\"`\nand `user_id=self`, so it cannot be used to promote anyone else or to\nassign any other role.\n\nIdempotent: a second call returns the existing row.", "operationId": "add_me_as_observer_api_v1_cards__card_id__me_observe_post", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Add Me As Observer", "tags": [ "stakeholders" ] } }, "/api/v1/cards/{card_id}/my-permissions": { "get": { "description": "Return the current user's effective permissions on a specific card.", "operationId": "my_permissions_api_v1_cards__card_id__my_permissions_get", "parameters": [ { "in": "path", "name": "card_id", "required": true, "schema": { "title": "Card Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "My Permissions", "tags": [ "cards" ] } }, "/api/v1/cards/{card_id}/relation-summary": { "get": { "description": "Per-relation-type / per-direction neighbour counts for one card.\n\nThe diagram editor renders this as LeanIX-style Show Dependency /\nDrill-Down / Roll-Up submenus where each entry shows\n\"