{ "openapi": "3.1.0", "info": { "title": "Tech Doc API", "summary": "Multi-tennant application managing CRUD operations on our Products", "version": "0.1.0" }, "paths": { "/products/": { "get": { "tags": [ "product" ], "summary": "Get latest revisions of all products", "description": "Returns a collection of the latest (or latest approved) revision for each product, fully resolved with knowledge units, knowledge topics, and product families. For a faster list-view response use **GET /slim** instead.", "operationId": "list_latest_products_revisions_for_all_products_products__get", "responses": { "200": { "description": "Retrieve the latest revision for all products", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCollection" } } } }, "404": { "description": "Not found" } }, "x-public": true } }, "/products/{product_history_id}": { "get": { "tags": [ "product" ], "summary": "Get product revision by history ID and version", "description": "Returns a specific product revision or the latest one if no version is specified.", "operationId": "get_specific_product_revision_by_history_id_and_version_products__product_history_id__get", "parameters": [ { "name": "product_history_id", "in": "path", "required": true, "schema": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593", "title": "Product History Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "type": "string", "description": "Specific version to retrieve (e.g., '1.2'). If not provided, returns latest revision.", "title": "Version" }, "description": "Specific version to retrieve (e.g., '1.2'). If not provided, returns latest revision." }, { "name": "combine_related_product_families_kus", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to include knowledge units from related product families", "default": false, "title": "Combine Related Product Families Kus" }, "description": "Whether to include knowledge units from related product families" }, { "name": "latest_approved", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return the latest approved revision of the product (if available), otherwise returns the latest revision.", "default": false, "title": "Latest Approved" }, "description": "Whether to return the latest approved revision of the product (if available), otherwise returns the latest revision." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullProductView" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true } }, "/ku/": { "get": { "tags": [ "knowledge units" ], "summary": "Get All Knowledge Unit Histories", "operationId": "get_all_knowledge_units_histories_ku__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/KnowledgeUnitHistoryGroup" }, "type": "array", "title": "Response Get All Knowledge Units Histories Ku Get" } } } }, "404": { "description": "Not found" } }, "x-public": true }, "post": { "tags": [ "knowledge units" ], "summary": "Create Knowledge Unit", "description": "Insert a new knowledge unit.\nA unique `id` will be created and provided in the response.\nWe always require a product history id to add a new knowledge unit", "operationId": "create_knowledge_unit_ku__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_create_knowledge_unit_ku__post" } } }, "required": true }, "responses": { "201": { "description": "Add new knowledge unit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullKnowledgeUnitView" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true } }, "/ku/{knowledge_unit_history_id}": { "get": { "tags": [ "knowledge units" ], "summary": "Get Ku With Topics By Version Or Latest", "description": "Get a knowledge unit with topics by history ID.\n\n- **knowledge_unit_history_id**: The knowledge unit history ID\n- **version**: Optional version string in format 'major.minor' (e.g., '1.2'). If not provided, returns the latest revision.", "operationId": "get_ku_with_topics_by_version_or_latest_ku__knowledge_unit_history_id__get", "parameters": [ { "name": "knowledge_unit_history_id", "in": "path", "required": true, "schema": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593", "title": "Knowledge Unit History Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "type": "string", "description": "Specific version to retrieve (e.g., '1.2'). If not provided, returns latest revision.", "title": "Version" }, "description": "Specific version to retrieve (e.g., '1.2'). If not provided, returns latest revision." }, { "name": "latest_approved", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return the latest revision of the knowledge unit", "default": false, "title": "Latest Approved" }, "description": "Whether to return the latest revision of the knowledge unit" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullKnowledgeUnitView" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true }, "patch": { "tags": [ "knowledge units" ], "summary": "Update Knowledge Unit Enpoint", "description": "Update individual values of an existing knowledge unit record.\n\nOnly the provided fields will be updated.\nAny missing or `null` fields will be ignored.", "operationId": "update_knowledge_unit_enpoint_ku__knowledge_unit_history_id__patch", "parameters": [ { "name": "knowledge_unit_history_id", "in": "path", "required": true, "schema": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593", "title": "Knowledge Unit History Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeUnitUpdate" } } } }, "responses": { "200": { "description": "Update a Knowledge Unit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullKnowledgeUnitView" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true } }, "/kt/": { "post": { "tags": [ "knowledge topics" ], "summary": "Create New Knowledge Topic", "description": "Insert a new knowledge topic.\nA unique `id` will be created and provided in the response.\nWe always require a knowledge unit history id to add a new knowledge topic.", "operationId": "create_new_knowledge_topic_kt__post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_create_new_knowledge_topic_kt__post" } } } }, "responses": { "201": { "description": "Add new knowledge topic", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeTopic" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true }, "get": { "tags": [ "knowledge topics" ], "summary": "Get Kts", "description": "Retrieve knowledge topics of the latest revision of a product.\nAlternatively, provide both knowledge_unit_history_id and knowledge_unit_version\nto retrieve knowledge topics for a specific knowledge unit revision.\nWarning: Retrieving all knowledge topics is possible but not recommended. Takes 1 minute for 3500 knowledge topics as a reference.\nUse the /all endpoint instead.", "operationId": "get_kts_kt__get", "parameters": [ { "name": "product_history_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by related product ID", "example": "5eb7cf5a86d9755df3a6c593", "title": "Product History Id" }, "description": "Filter by related product ID" }, { "name": "knowledge_unit_history_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Knowledge unit history ID; must be provided with knowledge_unit_version", "example": "5eb7cf5a86d9755df3a6c593", "title": "Knowledge Unit History Id" }, "description": "Knowledge unit history ID; must be provided with knowledge_unit_version" }, { "name": "knowledge_unit_version", "in": "query", "required": false, "schema": { "type": "string", "description": "Knowledge unit version string, e.g. \"1.0\"; must be provided with knowledge_unit_history_id", "title": "Knowledge Unit Version" }, "description": "Knowledge unit version string, e.g. \"1.0\"; must be provided with knowledge_unit_history_id" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeTopic" }, "title": "Response Get Kts Kt Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true } }, "/kt/use-cases/topic-names": { "get": { "tags": [ "knowledge topics" ], "summary": "Get Use Case Topic Names", "description": "Every topic name that belongs to any use case.\n\nServes the off-KU-screen `isTopicPartOfUseCase` check on the Frontend, where\nthere is no KU payload to read served use-case columns from.", "operationId": "get_use_case_topic_names_kt_use_cases_topic_names_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Response Get Use Case Topic Names Kt Use Cases Topic Names Get" } } } }, "404": { "description": "Not found" } }, "x-public": true } }, "/kt/multiple/traces": { "post": { "tags": [ "knowledge topics" ], "summary": "Get Multiple Knowledge Topics With Traces", "description": "Retrieve multiple knowledge topics by IDs, enriched with Tracer trace links.", "operationId": "get_multiple_knowledge_topics_with_traces_kt_multiple_traces_post", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Knowledge Topic Ids", "description": "List of knowledge topic IDs" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/KnowledgeTopicWithTraces" }, "type": "array", "title": "Response Get Multiple Knowledge Topics With Traces Kt Multiple Traces Post" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true } }, "/kt/{knowledge_topic_id}": { "get": { "tags": [ "knowledge topics" ], "summary": "Get Kt", "operationId": "get_kt_kt__knowledge_topic_id__get", "parameters": [ { "name": "knowledge_topic_id", "in": "path", "required": true, "schema": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593", "title": "Knowledge Topic Id" } }, { "name": "include_use_case_config", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When true, compute and attach use_case_config (columns + completeness banner) for a multi-record use-case topic (runs a product-wide topics aggregation). Off by default so generic resolvers (e.g. Tracer) skip the cost.", "default": false, "title": "Include Use Case Config" }, "description": "When true, compute and attach use_case_config (columns + completeness banner) for a multi-record use-case topic (runs a product-wide topics aggregation). Off by default so generic resolvers (e.g. Tracer) skip the cost." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeTopicDetailResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true }, "patch": { "tags": [ "knowledge topics" ], "summary": "Update Knowledge Topic", "description": "Update individual values of an existing knowledge topic.\n\nOnly the provided fields will be updated.\nAny missing or `null` fields will be ignored.", "operationId": "update_knowledge_topic_kt__knowledge_topic_id__patch", "parameters": [ { "name": "knowledge_topic_id", "in": "path", "required": true, "schema": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593", "title": "Knowledge Topic Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeTopicUpdate" } } } }, "responses": { "200": { "description": "Update a KnowledgeTopic", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeTopic" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-public": true } } }, "components": { "schemas": { "AnalyticsRequestModel": { "properties": { "product_history_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Product History Ids" }, "kt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Kt Ids" }, "product_family_history_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Product Family History Ids" } }, "type": "object", "title": "AnalyticsRequestModel" }, "AnalyticsResponseModel": { "properties": { "products": { "items": { "$ref": "#/components/schemas/ProductAnalytics" }, "type": "array", "title": "Products" }, "kts": { "items": { "$ref": "#/components/schemas/KTAnalytics" }, "type": "array", "title": "Kts" }, "product_families": { "items": { "$ref": "#/components/schemas/ProductFamilyAnalytics" }, "type": "array", "title": "Product Families", "default": [] } }, "type": "object", "required": [ "products", "kts" ], "title": "AnalyticsResponseModel" }, "ApplyUnderlyingSchemaResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "message": { "type": "string", "title": "Message" }, "applied_ku_schema_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Applied Ku Schema History Id" }, "applied_ku_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Applied Ku Schema Id" }, "applied_ku_schema_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Applied Ku Schema Version" }, "kt_results": { "items": { "$ref": "#/components/schemas/KtSyncResult" }, "type": "array", "title": "Kt Results" } }, "type": "object", "required": [ "success", "message" ], "title": "ApplyUnderlyingSchemaResponse", "description": "Response for the 'Apply Underlying Schema' action on a Product KU.\n\nPulls the LATEST APPROVED revision of the Schema Library schema this\nProduct KU is \"auto based on\" down onto the Product KU: existing\nKnowledge Topics that still match a schema topic get their\nname/form updated in place (their data is never touched), and schema\ntopics with no existing match get created as brand new Knowledge\nTopics. Product Knowledge Topics that no longer have any counterpart in\nthe schema's latest approved revision are left untouched - this action\nnever removes content from the Product KU. A draft (unapproved) schema\nrevision is never eligible, no matter how new.\n\napplied_ku_schema_history_id/applied_ku_schema_id/applied_ku_schema_version\nidentify the approved schema revision that was applied." }, "AuditInfo": { "properties": { "user_id_created": { "type": "string", "title": "User Id Created" }, "timestamp_created": { "type": "string", "format": "date-time", "title": "Timestamp Created" }, "user_id_last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id Last Updated" }, "timestamp_last_updated": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Timestamp Last Updated" }, "last_action": { "$ref": "#/components/schemas/LastActionType" }, "direct_approval_published_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Direct Approval Published At" }, "direct_approval_published_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direct Approval Published By" } }, "type": "object", "required": [ "user_id_created", "timestamp_created", "last_action" ], "title": "AuditInfo" }, "BaseLibraryResponse": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "id", "name", "metadata", "audit_info" ], "title": "BaseLibraryResponse" }, "Body_create_knowledge_unit_ku__post": { "properties": { "knowledge_unit": { "$ref": "#/components/schemas/CreateKnowledgeBase" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" } }, "type": "object", "required": [ "knowledge_unit", "product_history_id" ], "title": "Body_create_knowledge_unit_ku__post" }, "Body_create_new_knowledge_topic_kt__post": { "properties": { "knowledge_topic": { "$ref": "#/components/schemas/CreateKnowledgeTopic" }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" } }, "type": "object", "required": [ "knowledge_topic", "knowledge_unit_history_id" ], "title": "Body_create_new_knowledge_topic_kt__post" }, "BulkKnowledgeTopicFetchRequest": { "properties": { "knowledge_topic_ids": { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array", "title": "Knowledge Topic Ids" }, "include_use_case_config": { "type": "boolean", "title": "Include Use Case Config", "default": false } }, "type": "object", "title": "BulkKnowledgeTopicFetchRequest" }, "BulkKnowledgeTopicFetchResult": { "properties": { "requested_id": { "type": "string", "title": "Requested Id", "example": "5eb7cf5a86d9755df3a6c593" }, "success": { "type": "boolean", "title": "Success" }, "knowledge_topic": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeTopicDetailResponse" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "requested_id", "success" ], "title": "BulkKnowledgeTopicFetchResult", "description": "Per-item result, returned in request order. One failure does not fail the batch." }, "BulkKnowledgeUnitFetchItem": { "properties": { "history_id": { "type": "string", "title": "History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "latest_approved": { "type": "boolean", "title": "Latest Approved", "default": false } }, "type": "object", "required": [ "history_id" ], "title": "BulkKnowledgeUnitFetchItem", "description": "A single knowledge unit to resolve in a bulk fetch request." }, "BulkKnowledgeUnitFetchRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BulkKnowledgeUnitFetchItem" }, "type": "array", "maxItems": 500, "title": "Items" } }, "type": "object", "title": "BulkKnowledgeUnitFetchRequest" }, "BulkKnowledgeUnitFetchResult": { "properties": { "history_id": { "type": "string", "title": "History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "success": { "type": "boolean", "title": "Success" }, "revision": { "anyOf": [ { "$ref": "#/components/schemas/FullKnowledgeUnitView" }, { "type": "null" } ] }, "history": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitHistoryGroup" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "history_id", "success" ], "title": "BulkKnowledgeUnitFetchResult", "description": "Per-item result, returned in request order. One failure does not fail the batch." }, "BulkProductFamilyFetchItem": { "properties": { "history_id": { "type": "string", "title": "History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "latest_approved": { "type": "boolean", "title": "Latest Approved", "default": false } }, "type": "object", "required": [ "history_id" ], "title": "BulkProductFamilyFetchItem", "description": "A single product family to resolve in a bulk fetch request." }, "BulkProductFamilyFetchRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BulkProductFamilyFetchItem" }, "type": "array", "maxItems": 500, "title": "Items" } }, "type": "object", "title": "BulkProductFamilyFetchRequest" }, "BulkProductFamilyFetchResult": { "properties": { "history_id": { "type": "string", "title": "History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "success": { "type": "boolean", "title": "Success" }, "revision": { "anyOf": [ { "$ref": "#/components/schemas/FullProductFamilyView" }, { "type": "null" } ] }, "history": { "anyOf": [ { "$ref": "#/components/schemas/ProductFamilyHistoryGroup" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "history_id", "success" ], "title": "BulkProductFamilyFetchResult", "description": "Per-item result, returned in request order. One failure does not fail the batch." }, "BulkProductFetchItem": { "properties": { "history_id": { "type": "string", "title": "History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "latest_approved": { "type": "boolean", "title": "Latest Approved", "default": false }, "combine_related_product_families_kus": { "type": "boolean", "title": "Combine Related Product Families Kus", "default": false } }, "type": "object", "required": [ "history_id" ], "title": "BulkProductFetchItem", "description": "A single product to resolve in a bulk fetch request." }, "BulkProductFetchRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BulkProductFetchItem" }, "type": "array", "maxItems": 500, "title": "Items" } }, "type": "object", "title": "BulkProductFetchRequest" }, "BulkProductFetchResult": { "properties": { "history_id": { "type": "string", "title": "History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "success": { "type": "boolean", "title": "Success" }, "revision": { "anyOf": [ { "$ref": "#/components/schemas/FullProductView" }, { "type": "null" } ] }, "history": { "anyOf": [ { "$ref": "#/components/schemas/ProductHistoryGroup" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "history_id", "success" ], "title": "BulkProductFetchResult", "description": "Per-item result, returned in request order. One failure does not fail the batch." }, "CommitKnowledgeUnitResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "commit_message": { "type": "string", "title": "Commit Message" }, "knowledge_unit": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnit" }, { "type": "null" } ] } }, "type": "object", "required": [ "success", "commit_message" ], "title": "CommitKnowledgeUnitResponse", "description": "Response for knowledge unit commit operation" }, "CommitKnowledgeUnitRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "CommitKnowledgeUnitRevisionRequest", "description": "Request to commit a revision (create next minor version)" }, "CommitKnowledgeUnitSchemaResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "commit_message": { "type": "string", "title": "Commit Message" }, "knowledge_unit_schema": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitSchema" }, { "type": "null" } ] } }, "type": "object", "required": [ "success", "commit_message" ], "title": "CommitKnowledgeUnitSchemaResponse", "description": "Response for knowledge unit schema commit operation" }, "CommitKnowledgeUnitSchemaRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "CommitKnowledgeUnitSchemaRevisionRequest", "description": "Request to commit a revision (create next minor version)" }, "CommitProductFamilyRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "CommitProductFamilyRevisionRequest", "description": "Request to commit a revision (create next minor version)" }, "CommitProductRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "CommitProductRevisionRequest", "description": "Request to commit a revision (create next minor version)" }, "ConditionalField": { "properties": { "key": { "type": "string", "title": "Key" }, "input_type": { "$ref": "#/components/schemas/InputType" }, "status": { "$ref": "#/components/schemas/ConditionalFieldStatus" }, "hide_expression": { "type": "string", "title": "Hide Expression" } }, "type": "object", "required": [ "key", "input_type", "status", "hide_expression" ], "title": "ConditionalField" }, "ConditionalFieldStatus": { "type": "string", "enum": [ "present", "missing", "hidden" ], "title": "ConditionalFieldStatus" }, "CreateKUSchemaLibraryBase": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "knowledge_unit_schema_ids": { "anyOf": [ { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Unit Schema Ids", "default": [] } }, "type": "object", "required": [ "name" ], "title": "CreateKUSchemaLibraryBase" }, "CreateKnowledgeBase": { "properties": { "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" } }, "type": "object", "required": [ "knowledge_unit_name", "parent_entity" ], "title": "CreateKnowledgeBase" }, "CreateKnowledgeTopic": { "properties": { "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "knowledge_topic_schema": { "additionalProperties": true, "type": "object", "title": "Knowledge Topic Schema" }, "related_form_id": { "type": "string", "title": "Related Form Id" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "external_source": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/NoExternalSource" }, { "$ref": "#/components/schemas/ExternalSourceInfo" } ], "discriminator": { "propertyName": "is_external", "mapping": { "false": "#/components/schemas/NoExternalSource", "true": "#/components/schemas/ExternalSourceInfo" } } }, { "type": "null" } ], "title": "External Source" }, "from_existing": { "anyOf": [ { "$ref": "#/components/schemas/CreateKnowledgeTopicFromExisting" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_topic_name", "knowledge_topic_schema", "related_form_id", "type" ], "title": "CreateKnowledgeTopic" }, "CreateKnowledgeTopicFromExisting": { "properties": { "kt_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Schema Id", "description": "ID of existing knowledge topic schema to copy from" }, "kt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Id", "description": "ID of knowledge topic to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false } }, "type": "object", "title": "CreateKnowledgeTopicFromExisting", "description": "Model for creating a KT from existing KT schema or KT" }, "CreateKnowledgeTopicSchema": { "properties": { "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "component_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Component Schema" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "from_existing": { "anyOf": [ { "$ref": "#/components/schemas/CreateKnowledgeTopicSchemaFromExisting" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_topic_name", "type", "knowledge_unit_schema_history_id" ], "title": "CreateKnowledgeTopicSchema", "description": "Model for creating a new knowledge topic schema" }, "CreateKnowledgeTopicSchemaFromExisting": { "properties": { "kt_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Schema Id", "description": "ID of existing knowledge topic schema to copy from" }, "kt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Id", "description": "ID of knowledge topic to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false } }, "type": "object", "title": "CreateKnowledgeTopicSchemaFromExisting", "description": "Model for creating a schema from existing KT schema or KT" }, "CreateKnowledgeTopicSchemasFromExisting": { "properties": { "kt_schema_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Kt Schema Ids", "description": "ID of existing knowledge topic schema to copy from" }, "kt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Kt Ids", "description": "ID of knowledge topic to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "description": "knowledge unit id to add the knowledge topics", "default": "" } }, "type": "object", "title": "CreateKnowledgeTopicSchemasFromExisting", "description": "Model for creating a KT from existing KT schema or KT" }, "CreateKnowledgeTopicSchemasResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/KnowledgeTopicSchema" }, "type": "array", "title": "Data", "description": "Array of successfully created schemas" }, "skipped_knowledge_topics": { "items": { "$ref": "#/components/schemas/SkippedKnowledgeTopic" }, "type": "array", "title": "Skipped Knowledge Topics", "description": "Array of skipped knowledge topics with their reasons" } }, "type": "object", "required": [ "data" ], "title": "CreateKnowledgeTopicSchemasResponse", "description": "Response model for creating multiple knowledge topic schemas" }, "CreateKnowledgeTopicsFromExisting": { "properties": { "kt_schema_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Kt Schema Ids", "description": "ID of existing knowledge topic schema to copy from" }, "kt_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Kt Ids", "description": "ID of knowledge topic to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false }, "include_traces": { "type": "boolean", "title": "Include Traces", "description": "Whether to include traces in the copy", "default": true }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "description": "knowledge unit history id to add the knowledge topics", "default": "" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" } }, "type": "object", "required": [ "parent_entity" ], "title": "CreateKnowledgeTopicsFromExisting", "description": "Model for creating a KT from existing KT schema or KT" }, "CreateKnowledgeUnitSchemaBase": { "properties": { "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Description" }, "knowledge_topic_schemas": { "anyOf": [ { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Topic Schemas", "default": [] }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "library_ids": { "anyOf": [ { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array" }, { "type": "null" } ], "title": "Library Ids", "default": [] } }, "type": "object", "required": [ "knowledge_unit_name" ], "title": "CreateKnowledgeUnitSchemaBase", "description": "Base model for creating a knowledge unit schema" }, "CreateKnowledgeUnitSchemaFromExisting": { "properties": { "ku_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ku Schema Id", "description": "ID of existing knowledge unit schema to copy from" }, "ku_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ku Id", "description": "ID of knowledge unit to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false } }, "type": "object", "title": "CreateKnowledgeUnitSchemaFromExisting", "description": "Model for creating a schema from existing KU schema or KU" }, "CreateKnowledgeUnitSchemasFromExisting": { "properties": { "ku_schema_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ku Schema Ids" }, "ku_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ku Ids" }, "include_content": { "type": "boolean", "title": "Include Content", "default": false }, "library_ids": { "anyOf": [ { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array" }, { "type": "null" } ], "title": "Library Ids" } }, "type": "object", "title": "CreateKnowledgeUnitSchemasFromExisting", "description": "Model for creating a KU from existing KU schema or KU" }, "CreateKnowledgeUnitSchemasResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/KnowledgeUnitSchema" }, "type": "array", "title": "Data", "description": "Array of successfully created schemas" }, "skipped_knowledge_topics": { "items": { "$ref": "#/components/schemas/SkippedKnowledgeTopic" }, "type": "array", "title": "Skipped Knowledge Topics", "description": "Array of skipped knowledge topics with their reasons" } }, "type": "object", "required": [ "data" ], "title": "CreateKnowledgeUnitSchemasResponse", "description": "Response model for creating multiple knowledge unit schemas" }, "CreateKnowledgeUnitsFromExisting": { "properties": { "ku_schema_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ku Schema Ids", "description": "ID of existing knowledge unit schema to copy from" }, "ku_history_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ku History Ids", "description": "History ID of knowledge unit to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false }, "include_traces": { "type": "boolean", "title": "Include Traces", "description": "Whether to include traces in the copy", "default": true }, "ignore_knowledge_topics": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ignore Knowledge Topics", "description": "Whether to ignore knowledge topics in the copy" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" }, "product_history_id": { "type": "string", "title": "Product History Id", "description": "Target product history id to add the knowledge units", "default": "" }, "create_from_unapproved_schemas": { "type": "boolean", "title": "Create From Unapproved Schemas", "description": "Whether to create from unapproved schemas", "default": false } }, "type": "object", "required": [ "parent_entity" ], "title": "CreateKnowledgeUnitsFromExisting", "description": "Model for creating a KU from existing KU schema or KU" }, "CreateProduct": { "properties": { "name": { "type": "string", "title": "Name" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "udi_di": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi Di", "default": "N/A" }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Product Families" }, "product_context": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProductContextQuestion" }, "type": "array" }, { "type": "null" } ], "title": "Product Context" }, "product_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Website" } }, "type": "object", "required": [ "name", "product_properties" ], "title": "CreateProduct" }, "CreateProductFamily": { "properties": { "name": { "type": "string", "title": "Name" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" } }, "type": "object", "required": [ "name", "product_properties" ], "title": "CreateProductFamily" }, "DeleteLibraryMode": { "type": "string", "enum": [ "unlink_schemas", "delete_all" ], "title": "DeleteLibraryMode" }, "DuplicateKnowledgeTopic": { "properties": { "kt_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Schema Id", "description": "ID of existing knowledge topic schema to copy from" }, "kt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Id", "description": "ID of knowledge topic to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false } }, "type": "object", "title": "DuplicateKnowledgeTopic" }, "DuplicateKnowledgeTopicSchema": { "properties": { "kt_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Schema Id", "description": "ID of existing knowledge topic schema to copy from" }, "kt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kt Id", "description": "ID of knowledge topic to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false } }, "type": "object", "title": "DuplicateKnowledgeTopicSchema" }, "DuplicateKnowledgeUnit": { "properties": { "ku_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ku Schema Id", "description": "ID of existing knowledge unit schema to copy from" }, "ku_history_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ku History Id", "description": "ID of knowledge unit to create schema from" }, "include_content": { "type": "boolean", "title": "Include Content", "description": "Whether to include content in the copy", "default": false }, "product_history_id": { "type": "string", "title": "Product History Id" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" } }, "type": "object", "required": [ "product_history_id", "parent_entity" ], "title": "DuplicateKnowledgeUnit" }, "DuplicateKnowledgeUnitResponse": { "properties": { "data": { "$ref": "#/components/schemas/FullKnowledgeUnitView", "description": "The duplicated knowledge unit" }, "skipped_knowledge_topics": { "items": { "$ref": "#/components/schemas/SkippedKnowledgeTopic" }, "type": "array", "title": "Skipped Knowledge Topics", "description": "Array of skipped knowledge topics with their reasons" } }, "type": "object", "required": [ "data" ], "title": "DuplicateKnowledgeUnitResponse", "description": "Response model for duplicating a knowledge unit" }, "DuplicateProduct": { "properties": { "product_history_id": { "type": "string", "title": "Product History Id" }, "include_content": { "type": "boolean", "title": "Include Content" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, "type": "object", "required": [ "product_history_id", "include_content" ], "title": "DuplicateProduct" }, "ExportUnitsRequest": { "properties": { "unit_history_ids": { "items": { "type": "string" }, "type": "array", "title": "Unit History Ids", "description": "List of unit/schema IDs to export" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "Version string (e.g. '2.1') to export only that specific revision" } }, "type": "object", "required": [ "unit_history_ids" ], "title": "ExportUnitsRequest", "description": "Request model for exporting knowledge units or schemas" }, "ExternalSourceInfo": { "properties": { "is_external": { "type": "string", "const": "true", "title": "Is External" }, "external_source_type": { "type": "string", "title": "External Source Type" }, "external_source_id": { "type": "string", "title": "External Source Id" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "is_external", "external_source_type", "external_source_id" ], "title": "ExternalSourceInfo" }, "FullKnowledgeUnitView": { "properties": { "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "type": "string", "title": "Knowledge Unit Description", "default": "" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_version": { "type": "string", "title": "Product Version", "default": "0.1" }, "source_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Source Schema Id" }, "knowledge_topics": { "items": { "$ref": "#/components/schemas/KnowledgeTopic" }, "type": "array", "title": "Knowledge Topics", "default": [] }, "ordered_knowledge_topics": { "items": { "$ref": "#/components/schemas/OrderedKnowledgeTopic" }, "type": "array", "title": "Ordered Knowledge Topics" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] }, "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" } }, "type": "object", "required": [ "knowledge_unit_name", "parent_entity", "product_history_id", "knowledge_unit_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata", "id" ], "title": "FullKnowledgeUnitView" }, "FullLibraryResponse": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" }, "knowledge_unit_schemas": { "items": { "$ref": "#/components/schemas/SchemaWithLibraries" }, "type": "array", "title": "Knowledge Unit Schemas", "default": [] } }, "type": "object", "required": [ "id", "name", "metadata", "audit_info" ], "title": "FullLibraryResponse" }, "FullProductFamilyView": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "name": { "type": "string", "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" }, "knowledge_units": { "items": { "$ref": "#/components/schemas/FullKnowledgeUnitView" }, "type": "array", "title": "Knowledge Units", "default": [] }, "product_family_history_id": { "type": "string", "title": "Product Family History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "name", "product_properties", "product_family_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata", "audit_info" ], "title": "FullProductFamilyView" }, "FullProductView": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "name": { "type": "string", "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "udi_di": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi Di", "default": "N/A" }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_context": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProductContextQuestion" }, "type": "array" }, { "type": "null" } ], "title": "Product Context" }, "product_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Website" }, "product_families": { "items": { "$ref": "#/components/schemas/FullProductFamilyView" }, "type": "array", "title": "Product Families", "default": [] }, "knowledge_units": { "items": { "$ref": "#/components/schemas/FullKnowledgeUnitView" }, "type": "array", "title": "Knowledge Units", "default": [] }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "name", "product_properties", "product_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata", "audit_info" ], "title": "FullProductView" }, "GetKnowledgeUnitSchemaHistoryGroupsRequest": { "properties": { "knowledge_unit_schema_revision_ids": { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array", "title": "Knowledge Unit Schema Revision Ids", "description": "List of knowledge unit schema revision IDs" } }, "type": "object", "required": [ "knowledge_unit_schema_revision_ids" ], "title": "GetKnowledgeUnitSchemaHistoryGroupsRequest", "description": "Request model for getting knowledge unit schema history groups by revision IDs" }, "GuidancePhaseResponse": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "title": { "type": "string", "title": "Title" }, "goal": { "type": "string", "title": "Goal" }, "tasks": { "items": { "$ref": "#/components/schemas/GuidanceTaskResponse" }, "type": "array", "title": "Tasks" } }, "type": "object", "required": [ "id", "title", "goal", "tasks" ], "title": "GuidancePhaseResponse" }, "GuidanceTaskResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" } }, "type": "object", "required": [ "id", "label" ], "title": "GuidanceTaskResponse" }, "GuidanceTaskState": { "type": "string", "enum": [ "open", "done", "na" ], "title": "GuidanceTaskState" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImportRequest": { "properties": { "files": { "items": { "type": "string" }, "type": "array", "title": "Files", "description": "JSON files in string format to import" }, "library_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Library Ids", "description": "Library IDs to associate with imported schemas" } }, "type": "object", "required": [ "files" ], "title": "ImportRequest", "description": "Request model for importing units or schemas" }, "ImportRequestWithProductAndFamily": { "properties": { "files": { "items": { "type": "string" }, "type": "array", "title": "Files", "description": "JSON files in string format to import" }, "product_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product History Id", "description": "ID of product history to associate with imported schemas" }, "family_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Family Id", "description": "ID of product family to associate with imported schemas" } }, "type": "object", "required": [ "files" ], "title": "ImportRequestWithProductAndFamily", "description": "Request model for importing units or schemas with product and family" }, "ImportResponse": { "properties": { "successful_imports": { "type": "integer", "title": "Successful Imports", "description": "Number of successfully imported units", "default": 0 }, "failed_imports": { "type": "integer", "title": "Failed Imports", "description": "Number of failed imports", "default": 0 }, "error_details": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Error Details", "description": "Details of any failed imports" } }, "type": "object", "title": "ImportResponse", "description": "Response model for import operations" }, "InputType": { "type": "string", "enum": [ "textfield", "textarea", "number", "select", "checkbox", "checklist", "radio", "date", "datetime", "time", "taglist" ], "title": "InputType" }, "IssuingEntityTypeEnum": { "type": "string", "enum": [ "EUDAMED", "GS1", "IFA", "HIBCC", "ICCBBA" ], "title": "IssuingEntityTypeEnum", "description": "Issuing entities of the UDI Codes.\n\nThe issuing Entities of the UDI Codes will be established by the\nEuropean Commission through implementing acts" }, "JiraTokenRequest": { "properties": { "code": { "type": "string", "title": "Code" }, "code_verifier": { "type": "string", "title": "Code Verifier" } }, "type": "object", "required": [ "code", "code_verifier" ], "title": "JiraTokenRequest" }, "JiraTokenResponse": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "expires_in": { "type": "integer", "title": "Expires In" } }, "type": "object", "required": [ "access_token", "expires_in" ], "title": "JiraTokenResponse" }, "KTAnalytics": { "properties": { "knowledge_topic_id": { "type": "string", "title": "Knowledge Topic Id" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "records_summary": { "$ref": "#/components/schemas/RecordsSummary" }, "related_product_id": { "type": "string", "title": "Related Product Id" }, "related_knowledge_unit_id": { "type": "string", "title": "Related Knowledge Unit Id" } }, "type": "object", "required": [ "knowledge_topic_id", "knowledge_topic_name", "type", "records_summary", "related_product_id", "related_knowledge_unit_id" ], "title": "KTAnalytics" }, "KUStatistics": { "properties": { "ku_name": { "type": "string", "title": "Ku Name" }, "ku_history_id": { "type": "string", "title": "Ku History Id" }, "ku_current_version": { "type": "string", "title": "Ku Current Version" }, "ku_has_approved": { "type": "boolean", "title": "Ku Has Approved" }, "ku_is_latest_approved": { "type": "boolean", "title": "Ku Is Latest Approved" }, "ku_latest_approved_version": { "type": "string", "title": "Ku Latest Approved Version" } }, "type": "object", "required": [ "ku_name", "ku_history_id", "ku_current_version", "ku_has_approved", "ku_is_latest_approved", "ku_latest_approved_version" ], "title": "KUStatistics" }, "KnowledgeTopic": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_history_id": { "type": "string", "title": "Knowledge Topic History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_version": { "type": "string", "title": "Product Version", "default": "0.1" }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_version": { "type": "string", "title": "Knowledge Unit Version" }, "knowledge_topic_schema": { "additionalProperties": true, "type": "object", "title": "Knowledge Topic Schema" }, "source_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Source Schema Id" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "external_source": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/NoExternalSource" }, { "$ref": "#/components/schemas/ExternalSourceInfo" } ], "discriminator": { "propertyName": "is_external", "mapping": { "false": "#/components/schemas/NoExternalSource", "true": "#/components/schemas/ExternalSourceInfo" } } }, { "type": "null" } ], "title": "External Source" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_topic_name", "type", "product_history_id", "knowledge_unit_history_id", "knowledge_unit_version", "knowledge_topic_schema", "metadata" ], "title": "KnowledgeTopic" }, "KnowledgeTopicDetailResponse": { "properties": { "_id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_history_id": { "type": "string", "title": "Knowledge Topic History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_version": { "type": "string", "title": "Product Version" }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_version": { "type": "string", "title": "Knowledge Unit Version" }, "knowledge_topic_schema": { "additionalProperties": true, "type": "object", "title": "Knowledge Topic Schema" }, "source_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Source Schema Id" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] }, "latest_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Latest Revision Id" }, "latest_or_latest_approved_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Latest Or Latest Approved Revision Id" }, "use_case_config": { "anyOf": [ { "$ref": "#/components/schemas/UseCaseConfigView" }, { "type": "null" } ] } }, "type": "object", "required": [ "_id", "knowledge_topic_name", "type", "knowledge_topic_history_id", "product_history_id", "product_version", "knowledge_unit_history_id", "knowledge_unit_version", "knowledge_topic_schema", "metadata" ], "title": "KnowledgeTopicDetailResponse" }, "KnowledgeTopicOrderUpdate": { "properties": { "topic_ids": { "items": { "type": "string" }, "type": "array", "title": "Topic Ids" }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id" } }, "type": "object", "required": [ "topic_ids", "knowledge_unit_history_id" ], "title": "KnowledgeTopicOrderUpdate" }, "KnowledgeTopicOverviewResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_history_id": { "type": "string", "title": "Knowledge Topic History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "knowledge_topic_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Knowledge Topic Schema" }, "knowledge_unit_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Knowledge Unit Revision Id" }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_version": { "type": "string", "title": "Knowledge Unit Version" }, "product_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Revision Id" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Version" }, "product_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Name" }, "from_family": { "type": "boolean", "title": "From Family" }, "latest_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Latest Revision Id" }, "latest_or_latest_approved_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Latest Or Latest Approved Revision Id" }, "traces": { "items": { "$ref": "#/components/schemas/TraceInfo" }, "type": "array", "title": "Traces", "default": [] } }, "type": "object", "required": [ "id", "type", "knowledge_topic_history_id", "knowledge_unit_name", "knowledge_topic_name", "knowledge_unit_history_id", "knowledge_unit_version", "product_history_id", "from_family" ], "title": "KnowledgeTopicOverviewResponse" }, "KnowledgeTopicSchema": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "component_schema": { "additionalProperties": true, "type": "object", "title": "Component Schema", "default": {} }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_schema_history_id": { "type": "string", "title": "Knowledge Topic Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_schema_name": { "type": "string", "title": "Knowledge Unit Schema Name" }, "knowledge_unit_schema_version": { "type": "string", "title": "Knowledge Unit Schema Version" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_topic_name", "type", "knowledge_unit_schema_history_id", "knowledge_unit_schema_name", "knowledge_unit_schema_version", "metadata" ], "title": "KnowledgeTopicSchema" }, "KnowledgeTopicSchemaDetailResponse": { "properties": { "_id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "component_schema": { "additionalProperties": true, "type": "object", "title": "Component Schema", "default": {} }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_schema_history_id": { "type": "string", "title": "Knowledge Topic Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_schema_name": { "type": "string", "title": "Knowledge Unit Schema Name" }, "knowledge_unit_schema_version": { "type": "string", "title": "Knowledge Unit Schema Version" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] }, "use_case_config": { "anyOf": [ { "$ref": "#/components/schemas/UseCaseConfigView" }, { "type": "null" } ] } }, "type": "object", "required": [ "_id", "knowledge_topic_name", "type", "knowledge_topic_schema_history_id", "knowledge_unit_schema_history_id", "knowledge_unit_schema_name", "knowledge_unit_schema_version", "metadata" ], "title": "KnowledgeTopicSchemaDetailResponse", "description": "A KT schema as served to clients, plus its use-case columns.\n\nMirrors every persisted ``KnowledgeTopicSchema`` field (the BackLink is\nalready excluded on the document) so the wire shape is unchanged, and adds\n``use_case_config`` so the schema-library grid can render purple columns\nwithout a KU/product payload to read them from." }, "KnowledgeTopicSchemaOrderUpdate": { "properties": { "topic_schema_ids": { "items": { "type": "string" }, "type": "array", "title": "Topic Schema Ids" }, "knowledge_unit_schema_id": { "type": "string", "title": "Knowledge Unit Schema Id" } }, "type": "object", "required": [ "topic_schema_ids", "knowledge_unit_schema_id" ], "title": "KnowledgeTopicSchemaOrderUpdate" }, "KnowledgeTopicSchemaView": { "properties": { "id": { "type": "string", "title": "Id" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "knowledge_topic_schema_history_id": { "type": "string", "title": "Knowledge Topic Schema History Id" }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id" }, "knowledge_unit_schema_name": { "type": "string", "title": "Knowledge Unit Schema Name" }, "knowledge_unit_schema_version": { "type": "string", "title": "Knowledge Unit Schema Version" } }, "type": "object", "required": [ "id", "knowledge_topic_name", "knowledge_topic_schema_history_id", "knowledge_unit_schema_history_id", "knowledge_unit_schema_name", "knowledge_unit_schema_version" ], "title": "KnowledgeTopicSchemaView", "description": "Base model for viewing knowledge topic schema" }, "KnowledgeTopicType": { "type": "string", "enum": [ "single_record", "multi_record", "product_data_collection" ], "title": "KnowledgeTopicType" }, "KnowledgeTopicUpdate": { "properties": { "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "knowledge_topic_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Topic Name" }, "knowledge_topic_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Knowledge Topic Schema" } }, "type": "object", "title": "KnowledgeTopicUpdate", "description": "Model for updating a Knowledge Topic.\n\nOnly allows updating:\n- knowledge_topic_name: The name of the knowledge topic\n- knowledge_topic_schema: The schema definition (form structure)\n- data: The actual data stored in the topic\n\nExcluded fields (immutable/system-managed):\n- knowledge_unit_history_id: Ownership relationship (immutable)\n- product_history_id: Ownership relationship (immutable)\n- type: Fundamental characteristic (immutable)\n- product_data_collection_id: Tied to type and relationships (immutable)\n- source_schema_id: Historical reference (immutable)\n- metadata: System-managed tenant metadata (immutable)\n- audit_info: System-managed audit trail (auto-updated by service)" }, "KnowledgeTopicVersionEntry": { "properties": { "kt_revision_id": { "type": "string", "title": "Kt Revision Id" }, "kt_history_id": { "type": "string", "title": "Kt History Id" }, "kt_name": { "type": "string", "title": "Kt Name" }, "ku_revision_id": { "type": "string", "title": "Ku Revision Id" }, "ku_history_id": { "type": "string", "title": "Ku History Id" }, "ku_version": { "type": "string", "title": "Ku Version" }, "is_approved": { "type": "boolean", "title": "Is Approved" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" } }, "type": "object", "required": [ "kt_revision_id", "kt_history_id", "kt_name", "ku_revision_id", "ku_history_id", "ku_version", "is_approved", "type" ], "title": "KnowledgeTopicVersionEntry", "description": "One (KU revision, KT revision) pair with version and approval status." }, "KnowledgeTopicWithTraces": { "properties": { "_id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_history_id": { "type": "string", "title": "Knowledge Topic History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_version": { "type": "string", "title": "Product Version" }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_version": { "type": "string", "title": "Knowledge Unit Version" }, "knowledge_topic_schema": { "additionalProperties": true, "type": "object", "title": "Knowledge Topic Schema" }, "source_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Source Schema Id" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} }, "product_data_collection_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Data Collection Id" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] }, "latest_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Latest Revision Id" }, "latest_or_latest_approved_revision_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Latest Or Latest Approved Revision Id" }, "use_case_config": { "anyOf": [ { "$ref": "#/components/schemas/UseCaseConfigView" }, { "type": "null" } ] }, "external_source": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/NoExternalSource" }, { "$ref": "#/components/schemas/ExternalSourceInfo" } ], "discriminator": { "propertyName": "is_external", "mapping": { "false": "#/components/schemas/NoExternalSource", "true": "#/components/schemas/ExternalSourceInfo" } } }, { "type": "null" } ], "title": "External Source" }, "traces": { "items": { "$ref": "#/components/schemas/TraceInfo" }, "type": "array", "title": "Traces", "default": [] } }, "type": "object", "required": [ "_id", "knowledge_topic_name", "type", "knowledge_topic_history_id", "product_history_id", "product_version", "knowledge_unit_history_id", "knowledge_unit_version", "knowledge_topic_schema", "metadata" ], "title": "KnowledgeTopicWithTraces" }, "KnowledgeUnit": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "type": "string", "title": "Knowledge Unit Description", "default": "" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_version": { "type": "string", "title": "Product Version", "default": "0.1" }, "source_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Source Schema Id" }, "knowledge_topics": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Knowledge Topics" }, "ordered_knowledge_topics": { "items": { "$ref": "#/components/schemas/OrderedKnowledgeTopic" }, "type": "array", "title": "Ordered Knowledge Topics" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_unit_name", "parent_entity", "product_history_id", "knowledge_unit_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata" ], "title": "KnowledgeUnit" }, "KnowledgeUnitHistoryGroup": { "properties": { "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "latest_revision": { "$ref": "#/components/schemas/KnowledgeUnitRevisionSummary" }, "latest_approved": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitRevisionSummary" }, { "type": "null" } ] }, "revisions": { "items": { "$ref": "#/components/schemas/KnowledgeUnitRevisionSummary" }, "type": "array", "title": "Revisions" }, "total_revisions": { "type": "integer", "title": "Total Revisions", "default": 0 }, "related_product_name": { "type": "string", "title": "Related Product Name" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" }, "product_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product History Id" }, "product_family_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Family History Id" }, "revision_at_product_version": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitRevisionSummary" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_unit_history_id", "name", "latest_revision", "related_product_name", "parent_entity" ], "title": "KnowledgeUnitHistoryGroup", "description": "A group of submission revisions with the same history_id" }, "KnowledgeUnitHistoryGroupSlim": { "properties": { "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "related_product_name": { "type": "string", "title": "Related Product Name" }, "parent_entity": { "$ref": "#/components/schemas/ParentEntity" }, "product_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product History Id" }, "product_family_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product Family History Id" }, "latest_revision": { "$ref": "#/components/schemas/KnowledgeUnitRevisionSlim" }, "latest_approved": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitRevisionSlim" }, { "type": "null" } ] }, "revisions": { "items": { "$ref": "#/components/schemas/KnowledgeUnitRevisionSlim" }, "type": "array", "title": "Revisions" } }, "type": "object", "required": [ "knowledge_unit_history_id", "name", "related_product_name", "parent_entity", "latest_revision" ], "title": "KnowledgeUnitHistoryGroupSlim", "description": "Lightweight history group for list endpoints — no audit fields." }, "KnowledgeUnitOption": { "properties": { "knowledge_unit_history_id": { "type": "string", "title": "Knowledge Unit History Id", "description": "The Knowledge Unit History ID (stable ID)", "example": "5eb7cf5a86d9755df3a6c593" }, "current_revision_id": { "type": "string", "title": "Current Revision Id", "description": "The ID of the latest revision", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "product_name": { "type": "string", "title": "Product Name" }, "version_string": { "type": "string", "title": "Version String" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "from_family": { "type": "boolean", "title": "From Family" } }, "type": "object", "required": [ "knowledge_unit_history_id", "current_revision_id", "knowledge_unit_name", "product_name", "version_string", "product_history_id", "from_family" ], "title": "KnowledgeUnitOption", "description": "Optimized DTO for Dropdowns/Lists.\nFlattens the relationship between History, Product, and Latest Version." }, "KnowledgeUnitRevisionSlim": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "version_string": { "type": "string", "title": "Version String" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" } }, "type": "object", "required": [ "id", "version_string", "is_latest_approved" ], "title": "KnowledgeUnitRevisionSlim", "description": "Minimal revision info for slim list endpoints." }, "KnowledgeUnitRevisionSummary": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "version_string": { "type": "string", "title": "Version String" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "direct_approval_published_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Direct Approval Published At" }, "direct_approval_published_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direct Approval Published By" } }, "type": "object", "required": [ "id", "name", "version_string", "is_latest_approved", "read_only", "created_at", "created_by" ], "title": "KnowledgeUnitRevisionSummary", "description": "Summary of a submission revision for listing purposes" }, "KnowledgeUnitSchema": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Description" }, "knowledge_topic_schemas": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Knowledge Topic Schemas" }, "ordered_knowledge_topic_schemas": { "items": { "$ref": "#/components/schemas/OrderedKnowledgeTopicSchema" }, "type": "array", "title": "Ordered Knowledge Topic Schemas" }, "libraries": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Libraries" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "knowledge_unit_name", "knowledge_unit_schema_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata" ], "title": "KnowledgeUnitSchema" }, "KnowledgeUnitSchemaHistoryGroup": { "properties": { "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "latest_revision": { "$ref": "#/components/schemas/KnowledgeUnitSchemaRevisionSummary" }, "latest_approved": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitSchemaRevisionSummary" }, { "type": "null" } ] }, "revisions": { "items": { "$ref": "#/components/schemas/KnowledgeUnitSchemaRevisionSummary" }, "type": "array", "title": "Revisions" }, "total_revisions": { "type": "integer", "title": "Total Revisions", "default": 0 } }, "type": "object", "required": [ "knowledge_unit_schema_history_id", "name", "latest_revision" ], "title": "KnowledgeUnitSchemaHistoryGroup", "description": "A group of submission revisions with the same history_id" }, "KnowledgeUnitSchemaLibrary": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "knowledge_unit_schemas": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Knowledge Unit Schemas", "default": [] }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "name", "metadata", "audit_info" ], "title": "KnowledgeUnitSchemaLibrary", "description": "Model representing a Knowledge Unit Schema Library.\nA library can contain multiple Knowledge Unit Schemas and vice versa." }, "KnowledgeUnitSchemaRevisionSummary": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "version_string": { "type": "string", "title": "Version String" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" } }, "type": "object", "required": [ "id", "name", "version_string", "is_latest_approved", "read_only", "created_at", "created_by" ], "title": "KnowledgeUnitSchemaRevisionSummary", "description": "Summary of a submission revision for listing purposes" }, "KnowledgeUnitUpdate": { "properties": { "knowledge_unit_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Description" }, "knowledge_topics": { "anyOf": [ { "items": { "$ref": "#/components/schemas/KnowledgeTopicUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Topics" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "parent_entity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Entity" }, "external_source": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/NoExternalSource" }, { "$ref": "#/components/schemas/ExternalSourceInfo" } ], "discriminator": { "propertyName": "is_external", "mapping": { "false": "#/components/schemas/NoExternalSource", "true": "#/components/schemas/ExternalSourceInfo" } } }, { "type": "null" } ], "title": "External Source" } }, "type": "object", "title": "KnowledgeUnitUpdate" }, "KtSyncResult": { "properties": { "knowledge_topic_history_id": { "type": "string", "title": "Knowledge Topic History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "status": { "type": "string", "enum": [ "success", "skipped_no_trace", "failed" ], "title": "Status" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "required": [ "knowledge_topic_history_id", "knowledge_topic_name", "status" ], "title": "KtSyncResult", "description": "Per-knowledge-topic outcome of an 'Update Underlying Schema' action." }, "LastActionType": { "type": "string", "enum": [ "created", "updated", "published" ], "title": "LastActionType" }, "MissingFieldName": { "properties": { "record_display_name": { "type": "string", "title": "Record Display Name" }, "missing_field_name": { "type": "string", "title": "Missing Field Name" } }, "type": "object", "required": [ "record_display_name", "missing_field_name" ], "title": "MissingFieldName" }, "NoExternalSource": { "properties": { "is_external": { "type": "string", "const": "false", "title": "Is External", "default": "false" } }, "type": "object", "title": "NoExternalSource" }, "OrderedKnowledgeTopic": { "properties": { "knowledge_topic_id": { "type": "string", "title": "Knowledge Topic Id", "example": "5eb7cf5a86d9755df3a6c593" }, "index": { "type": "integer", "title": "Index" } }, "type": "object", "required": [ "knowledge_topic_id", "index" ], "title": "OrderedKnowledgeTopic" }, "OrderedKnowledgeTopicSchema": { "properties": { "knowledge_topic_schema_id": { "type": "string", "title": "Knowledge Topic Schema Id", "example": "5eb7cf5a86d9755df3a6c593" }, "index": { "type": "integer", "title": "Index" } }, "type": "object", "required": [ "knowledge_topic_schema_id", "index" ], "title": "OrderedKnowledgeTopicSchema" }, "ParentEntity": { "type": "string", "enum": [ "PRODUCT", "PRODUCT_FAMILY" ], "title": "ParentEntity" }, "Product": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "name": { "type": "string", "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "udi_di": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi Di", "default": "N/A" }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_context": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProductContextQuestion" }, "type": "array" }, { "type": "null" } ], "title": "Product Context" }, "product_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Website" }, "product_families": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Product Families" }, "knowledge_units": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Knowledge Units" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "name", "product_properties", "product_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata", "audit_info" ], "title": "Product" }, "ProductAnalytics": { "properties": { "product_id": { "type": "string", "title": "Product Id" }, "product_name": { "type": "string", "title": "Product Name" }, "product_fields": { "$ref": "#/components/schemas/ProductFields" }, "knowledge_unit_count": { "type": "integer", "title": "Knowledge Unit Count" }, "ku_statistics": { "items": { "$ref": "#/components/schemas/KUStatistics" }, "type": "array", "title": "Ku Statistics" } }, "type": "object", "required": [ "product_id", "product_name", "product_fields", "knowledge_unit_count", "ku_statistics" ], "title": "ProductAnalytics" }, "ProductCollection": { "properties": { "products": { "items": { "$ref": "#/components/schemas/FullProductView" }, "type": "array", "title": "Products" } }, "type": "object", "required": [ "products" ], "title": "ProductCollection" }, "ProductContextQuestion": { "properties": { "question": { "type": "string", "title": "Question" }, "answer": { "type": "string", "title": "Answer" } }, "type": "object", "required": [ "question", "answer" ], "title": "ProductContextQuestion" }, "ProductFamily": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "name": { "type": "string", "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" }, "knowledge_units": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "collection": { "type": "string", "title": "Collection" } }, "type": "object", "required": [ "id", "collection" ] }, "type": "array", "title": "Knowledge Units" }, "product_family_history_id": { "type": "string", "title": "Product Family History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "name", "product_properties", "product_family_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata", "audit_info" ], "title": "ProductFamily" }, "ProductFamilyAnalytics": { "properties": { "product_family_id": { "type": "string", "title": "Product Family Id" }, "product_family_name": { "type": "string", "title": "Product Family Name" }, "product_family_fields": { "$ref": "#/components/schemas/ProductFamilyFields" }, "knowledge_unit_count": { "type": "integer", "title": "Knowledge Unit Count" }, "ku_statistics": { "items": { "$ref": "#/components/schemas/KUStatistics" }, "type": "array", "title": "Ku Statistics" } }, "type": "object", "required": [ "product_family_id", "product_family_name", "product_family_fields", "knowledge_unit_count", "ku_statistics" ], "title": "ProductFamilyAnalytics" }, "ProductFamilyCollection": { "properties": { "product_families": { "items": { "$ref": "#/components/schemas/ProductFamily" }, "type": "array", "title": "Product Families" } }, "type": "object", "required": [ "product_families" ], "title": "ProductFamilyCollection" }, "ProductFamilyFields": { "properties": { "present_fields": { "items": { "type": "string" }, "type": "array", "title": "Present Fields" }, "missing_fields": { "items": { "type": "string" }, "type": "array", "title": "Missing Fields" }, "values": { "additionalProperties": true, "type": "object", "title": "Values" } }, "type": "object", "required": [ "present_fields", "missing_fields", "values" ], "title": "ProductFamilyFields" }, "ProductFamilyHistoryGroup": { "properties": { "product_family_history_id": { "type": "string", "title": "Product Family History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "latest_revision": { "$ref": "#/components/schemas/ProductFamilyRevisionSummary" }, "latest_approved": { "anyOf": [ { "$ref": "#/components/schemas/ProductFamilyRevisionSummary" }, { "type": "null" } ] }, "revisions": { "items": { "$ref": "#/components/schemas/ProductFamilyRevisionSummary" }, "type": "array", "title": "Revisions" }, "total_revisions": { "type": "integer", "title": "Total Revisions", "default": 0 } }, "type": "object", "required": [ "product_family_history_id", "name", "latest_revision" ], "title": "ProductFamilyHistoryGroup", "description": "A group of submission revisions with the same history_id" }, "ProductFamilyRevisionSummary": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "version_string": { "type": "string", "title": "Version String" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" } }, "type": "object", "required": [ "id", "name", "version_string", "is_latest_approved", "read_only", "created_at", "created_by" ], "title": "ProductFamilyRevisionSummary", "description": "Summary of a submission revision for listing purposes" }, "ProductFields": { "properties": { "present_fields": { "items": { "type": "string" }, "type": "array", "title": "Present Fields" }, "missing_fields": { "items": { "type": "string" }, "type": "array", "title": "Missing Fields" }, "values": { "additionalProperties": true, "type": "object", "title": "Values" }, "has_product_family": { "type": "boolean", "title": "Has Product Family" }, "product_family_count": { "type": "integer", "title": "Product Family Count" } }, "type": "object", "required": [ "present_fields", "missing_fields", "values", "has_product_family", "product_family_count" ], "title": "ProductFields" }, "ProductGuidanceResponse": { "properties": { "id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "task_states": { "patternProperties": { "^[a-z0-9_]+$": { "$ref": "#/components/schemas/GuidanceTaskState" } }, "type": "object", "title": "Task States" } }, "type": "object", "required": [ "product_history_id", "task_states" ], "title": "ProductGuidanceResponse" }, "ProductHistoryGroup": { "properties": { "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "latest_revision": { "$ref": "#/components/schemas/ProductRevisionSummary" }, "latest_approved": { "anyOf": [ { "$ref": "#/components/schemas/ProductRevisionSummary" }, { "type": "null" } ] }, "revisions": { "items": { "$ref": "#/components/schemas/ProductRevisionSummary" }, "type": "array", "title": "Revisions" }, "total_revisions": { "type": "integer", "title": "Total Revisions", "default": 0 } }, "type": "object", "required": [ "product_history_id", "name", "latest_revision" ], "title": "ProductHistoryGroup", "description": "A group of submission revisions with the same history_id" }, "ProductProperties": { "properties": { "regulation": { "$ref": "#/components/schemas/Regulation" }, "risk_class": { "$ref": "#/components/schemas/RiskClass" }, "sterile": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sterile" }, "reusable": { "anyOf": [ { "$ref": "#/components/schemas/Reusable" }, { "type": "null" } ] }, "measurement": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Measurement" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" }, "invasive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Invasive" }, "implantable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Implantable" }, "medicinal_product": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Medicinal Product" }, "software": { "anyOf": [ { "$ref": "#/components/schemas/Software" }, { "type": "null" } ], "default": "NoSoftware" }, "software_class": { "anyOf": [ { "$ref": "#/components/schemas/SoftwareClass" }, { "type": "null" } ], "default": "NoSoftware" }, "biocompatibility": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Biocompatibility" }, "clinical_evaluation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Clinical Evaluation" }, "performance_evaluation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Performance Evaluation" }, "reprocessing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reprocessing" }, "reagents": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Reagents" } }, "type": "object", "required": [ "regulation", "risk_class" ], "title": "ProductProperties" }, "ProductRevisionSummary": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "version_string": { "type": "string", "title": "Version String" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "direct_approval_published_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Direct Approval Published At" }, "direct_approval_published_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Direct Approval Published By" } }, "type": "object", "required": [ "id", "name", "version_string", "is_latest_approved", "read_only", "created_at", "created_by" ], "title": "ProductRevisionSummary", "description": "Summary of a submission revision for listing purposes" }, "PublishKnowledgeUnitResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "commit_message": { "type": "string", "title": "Commit Message" }, "knowledge_unit": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnit" }, { "type": "null" } ] } }, "type": "object", "required": [ "success", "commit_message" ], "title": "PublishKnowledgeUnitResponse", "description": "Response for knowledge unit publish operation" }, "PublishKnowledgeUnitRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "PublishKnowledgeUnitRevisionRequest", "description": "Request to publish a revision (morph to next major version)" }, "PublishKnowledgeUnitSchemaResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "commit_message": { "type": "string", "title": "Commit Message" }, "knowledge_unit_schema": { "anyOf": [ { "$ref": "#/components/schemas/KnowledgeUnitSchema" }, { "type": "null" } ] } }, "type": "object", "required": [ "success", "commit_message" ], "title": "PublishKnowledgeUnitSchemaResponse", "description": "Response for knowledge unit schema publish operation" }, "PublishKnowledgeUnitSchemaRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "PublishKnowledgeUnitSchemaRevisionRequest", "description": "Request to publish a revision (morph to next major version)" }, "PublishProductFamilyResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "commit_message": { "type": "string", "title": "Commit Message" }, "product_family": { "anyOf": [ { "$ref": "#/components/schemas/ProductFamily" }, { "type": "null" } ] } }, "type": "object", "required": [ "success", "commit_message" ], "title": "PublishProductFamilyResponse", "description": "Response for product family publish operation" }, "PublishProductFamilyRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "PublishProductFamilyRevisionRequest", "description": "Request to publish a revision (morph to next major version)" }, "PublishProductResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "commit_message": { "type": "string", "title": "Commit Message" }, "product": { "anyOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "null" } ] } }, "type": "object", "required": [ "success", "commit_message" ], "title": "PublishProductResponse", "description": "Response for product publish operation" }, "PublishProductRevisionRequest": { "properties": { "commit_message": { "type": "string", "title": "Commit Message" } }, "type": "object", "required": [ "commit_message" ], "title": "PublishProductRevisionRequest", "description": "Request to publish a revision (morph to next major version)" }, "RecordFields": { "properties": { "record_id": { "type": "string", "title": "Record Id" }, "present_fields": { "additionalProperties": { "$ref": "#/components/schemas/InputType" }, "type": "object", "title": "Present Fields" }, "missing_fields": { "additionalProperties": { "$ref": "#/components/schemas/InputType" }, "type": "object", "title": "Missing Fields" }, "conditional_fields": { "items": { "$ref": "#/components/schemas/ConditionalField" }, "type": "array", "title": "Conditional Fields", "default": [] }, "missing_field_names": { "items": { "$ref": "#/components/schemas/MissingFieldName" }, "type": "array", "title": "Missing Field Names", "default": [] } }, "type": "object", "required": [ "record_id", "present_fields", "missing_fields" ], "title": "RecordFields" }, "RecordsSummary": { "properties": { "records": { "items": { "$ref": "#/components/schemas/RecordFields" }, "type": "array", "title": "Records" }, "records_with_missing_fields": { "type": "integer", "title": "Records With Missing Fields" }, "input_types": { "additionalProperties": { "$ref": "#/components/schemas/InputType" }, "type": "object", "title": "Input Types" } }, "type": "object", "required": [ "records", "records_with_missing_fields", "input_types" ], "title": "RecordsSummary" }, "Regulation": { "type": "string", "enum": [ "MDR", "IVDR" ], "title": "Regulation" }, "Reusable": { "type": "string", "enum": [ "Surgical Reusable Instrument", "Other", "Single Use" ], "title": "Reusable" }, "RiskAnalysisMatrixCell": { "properties": { "record_id": { "type": "string", "title": "Record Id" }, "name": { "type": "string", "title": "Name" }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "default": {} } }, "type": "object", "required": [ "record_id", "name" ], "title": "RiskAnalysisMatrixCell", "description": "One resolved Record in a chain.\n\nIts form schema (needed alongside `data` to resolve the same \" -\n\" display label used elsewhere — `resolveRecordDataName`/\n`formatRecordDisplayName`) is not embedded here; look it up by\n`record_id` in the response's `forms` map instead." }, "RiskAnalysisMatrixResponse": { "properties": { "rows": { "items": { "$ref": "#/components/schemas/RiskAnalysisMatrixRow" }, "type": "array", "title": "Rows", "default": [] }, "forms": { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Forms", "default": {} } }, "type": "object", "title": "RiskAnalysisMatrixResponse" }, "RiskAnalysisMatrixRow": { "properties": { "system_misbehaviour": { "anyOf": [ { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, { "type": "null" } ] }, "hazard": { "anyOf": [ { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, { "type": "null" } ] }, "hazardous_situation": { "anyOf": [ { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, { "type": "null" } ] }, "harm": { "anyOf": [ { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, { "type": "null" } ] }, "risk": { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, "risk_control_measure": { "anyOf": [ { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, { "type": "null" } ] }, "risk_management_team": { "anyOf": [ { "$ref": "#/components/schemas/RiskAnalysisMatrixCell" }, { "type": "null" } ] } }, "type": "object", "required": [ "risk" ], "title": "RiskAnalysisMatrixRow", "description": "One resolved (possibly partial) chain, rooted at `risk`." }, "RiskClass": { "type": "string", "enum": [ "I", "IIa", "IIb", "III", "A", "B", "C", "D" ], "title": "RiskClass" }, "SchemaKnowledgeTopic": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "type": { "$ref": "#/components/schemas/KnowledgeTopicType" }, "knowledge_topic_schema": { "$ref": "#/components/schemas/SchemaKnowledgeTopicSchema" } }, "type": "object", "required": [ "knowledge_topic_name", "type", "knowledge_topic_schema" ], "title": "SchemaKnowledgeTopic" }, "SchemaKnowledgeTopicInput": { "properties": { "key": { "type": "string", "title": "Key" }, "label": { "type": "string", "title": "Label" }, "components": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SchemaKnowledgeTopicInput" }, "type": "array" }, { "type": "null" } ], "title": "Components" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Path" } }, "type": "object", "required": [ "key", "label" ], "title": "SchemaKnowledgeTopicInput" }, "SchemaKnowledgeTopicSchema": { "properties": { "components": { "items": { "$ref": "#/components/schemas/SchemaKnowledgeTopicInput" }, "type": "array", "title": "Components" } }, "type": "object", "required": [ "components" ], "title": "SchemaKnowledgeTopicSchema" }, "SchemaKnowledgeUnit": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_topics": { "items": { "$ref": "#/components/schemas/SchemaKnowledgeTopic" }, "type": "array", "title": "Knowledge Topics" } }, "type": "object", "required": [ "knowledge_unit_name", "knowledge_topics" ], "title": "SchemaKnowledgeUnit" }, "SchemaWithLibraries": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Description" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children", "default": false }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "anyOf": [ { "$ref": "#/components/schemas/AuditInfo" }, { "type": "null" } ] }, "knowledge_topic_schemas": { "anyOf": [ { "items": { "$ref": "#/components/schemas/KnowledgeTopicSchemaDetailResponse" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Topic Schemas", "default": [] }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "libraries": { "items": { "$ref": "#/components/schemas/BaseLibraryResponse" }, "type": "array", "title": "Libraries", "default": [] } }, "type": "object", "required": [ "id", "knowledge_unit_name", "metadata", "knowledge_unit_schema_history_id", "major_version", "minor_version", "is_latest_approved", "read_only" ], "title": "SchemaWithLibraries" }, "SearchEntityType": { "type": "string", "enum": [ "PRODUCT", "KNOWLEDGE_UNIT", "KNOWLEDGE_TOPIC" ], "title": "SearchEntityType" }, "SearchResultItem": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "type": { "$ref": "#/components/schemas/SearchEntityType" }, "name": { "type": "string", "title": "Name" }, "product_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Product History Id" }, "knowledge_unit_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Knowledge Unit History Id" } }, "type": "object", "required": [ "id", "type", "name" ], "title": "SearchResultItem", "description": "A single search hit — only the id and the info needed to build a link." }, "SearchResults": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SearchResultItem" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "results" ], "title": "SearchResults" }, "SkippedKnowledgeTopic": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the skipped knowledge topic" }, "name": { "type": "string", "title": "Name", "description": "Name of the skipped knowledge topic" }, "reason": { "type": "string", "title": "Reason", "description": "Reason why the knowledge topic was skipped" } }, "type": "object", "required": [ "id", "name", "reason" ], "title": "SkippedKnowledgeTopic", "description": "Model for representing a skipped knowledge topic" }, "SlimKnowledgeUnitRef": { "properties": { "_id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" } }, "type": "object", "required": [ "_id" ], "title": "SlimKnowledgeUnitRef", "description": "Minimal knowledge-unit reference: only the id, so callers can determine count." }, "SlimKnowledgeUnitSchemaResponse": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_schema_history_id": { "type": "string", "title": "Knowledge Unit Schema History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_unit_name": { "type": "string", "title": "Knowledge Unit Name" }, "libraries": { "items": { "$ref": "#/components/schemas/SlimLibraryResponse" }, "type": "array", "title": "Libraries" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" } }, "type": "object", "required": [ "id", "knowledge_unit_schema_history_id", "knowledge_unit_name", "major_version", "minor_version", "is_latest_approved", "read_only" ], "title": "SlimKnowledgeUnitSchemaResponse" }, "SlimLibraryResponse": { "properties": { "id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" }, "knowledge_unit_schemas": { "items": { "$ref": "#/components/schemas/SlimKnowledgeUnitSchemaResponse" }, "type": "array", "title": "Knowledge Unit Schemas" } }, "type": "object", "required": [ "id", "name", "metadata", "audit_info" ], "title": "SlimLibraryResponse" }, "SlimProductCollection": { "properties": { "products": { "items": { "$ref": "#/components/schemas/SlimProductView" }, "type": "array", "title": "Products" } }, "type": "object", "required": [ "products" ], "title": "SlimProductCollection" }, "SlimProductFamilyRef": { "properties": { "_id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_family_history_id": { "type": "string", "title": "Product Family History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "_id", "product_family_history_id", "name" ], "title": "SlimProductFamilyRef", "description": "Minimal product-family reference: only identity fields, no nested data." }, "SlimProductRef": { "properties": { "_id": { "type": "string", "title": "Id", "example": "5eb7cf5a86d9755df3a6c593" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "_id", "product_history_id", "name" ], "title": "SlimProductRef", "description": "Minimal product reference: only identity fields, no nested data." }, "SlimProductView": { "properties": { "_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "Id", "description": "MongoDB document ObjectID" }, "name": { "type": "string", "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "udi_di": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi Di", "default": "N/A" }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "product_properties": { "$ref": "#/components/schemas/ProductProperties" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_context": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProductContextQuestion" }, "type": "array" }, { "type": "null" } ], "title": "Product Context" }, "product_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Website" }, "product_families": { "items": { "$ref": "#/components/schemas/SlimProductFamilyRef" }, "type": "array", "title": "Product Families" }, "knowledge_units": { "items": { "$ref": "#/components/schemas/SlimKnowledgeUnitRef" }, "type": "array", "title": "Knowledge Units" }, "product_history_id": { "type": "string", "title": "Product History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "major_version": { "type": "integer", "title": "Major Version" }, "minor_version": { "type": "integer", "title": "Minor Version" }, "is_latest_approved": { "type": "boolean", "title": "Is Latest Approved" }, "read_only": { "type": "boolean", "title": "Read Only" }, "commit_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Message" }, "metadata": { "$ref": "#/components/schemas/TenantMetadata" }, "audit_info": { "$ref": "#/components/schemas/AuditInfo" } }, "type": "object", "required": [ "name", "product_properties", "product_history_id", "major_version", "minor_version", "is_latest_approved", "read_only", "metadata", "audit_info" ], "title": "SlimProductView", "description": "Lightweight product view for list endpoints.\n\nknowledge_units are returned as id-only stubs so callers can determine the\ncount without fetching full KU/KT data.\nproduct_families are returned as shallow refs (id + history id only)." }, "Software": { "type": "string", "enum": [ "NoSoftware", "Software Only", "Embedded" ], "title": "Software" }, "SoftwareClass": { "type": "string", "enum": [ "NoSoftware", "A", "B", "C" ], "title": "SoftwareClass" }, "TenantMetadata": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id" } }, "type": "object", "required": [ "tenant_id" ], "title": "TenantMetadata" }, "TraceInfo": { "properties": { "source": { "type": "string", "title": "Source" }, "target": { "type": "string", "title": "Target" }, "relation_type": { "type": "string", "title": "Relation Type" } }, "type": "object", "required": [ "source", "target", "relation_type" ], "title": "TraceInfo", "description": "Slim trace edge returned alongside a KT overview." }, "UnderlyingSchemaApplyStatus": { "properties": { "eligible": { "type": "boolean", "title": "Eligible", "default": false }, "out_of_sync": { "type": "boolean", "title": "Out Of Sync", "default": false }, "topics": { "items": { "$ref": "#/components/schemas/UnderlyingSchemaSyncTopic" }, "type": "array", "title": "Topics" }, "latest_approved_schema_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Approved Schema Version" } }, "type": "object", "title": "UnderlyingSchemaApplyStatus", "description": "Whether the Product KU's current KT forms differ from the LATEST\nAPPROVED revision of its underlying Schema Library schema - i.e.\nwhether 'Apply Underlying Schema' would actually change anything, and\nprecisely which KTs would be created/updated. Unlike\nUnderlyingSchemaSyncStatus, a KT with no counterpart in the schema is\nnever reported here (Apply never removes anything), and the comparison\nrevision is always the strictly-approved one - never a draft, never a\nfallback to the latest revision." }, "UnderlyingSchemaSyncStatus": { "properties": { "eligible": { "type": "boolean", "title": "Eligible", "default": false }, "out_of_sync": { "type": "boolean", "title": "Out Of Sync", "default": false }, "ku_changed": { "type": "boolean", "title": "Ku Changed", "default": false }, "topics": { "items": { "$ref": "#/components/schemas/UnderlyingSchemaSyncTopic" }, "type": "array", "title": "Topics" }, "compared_schema_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compared Schema Version" } }, "type": "object", "title": "UnderlyingSchemaSyncStatus", "description": "Whether the Product KU's current name/description/KT forms differ from\nthe COMPARISON revision of its underlying Schema Library schema - the\nlatest approved version (e.g. 2.0, 3.0) when one exists, otherwise (for\nschemas still under 1.0) the latest revision - i.e. whether 'Update\nUnderlying Schema' would actually change anything, and precisely which\nKU/KT-level changes it would make. Drives whether the FE shows the update\nbutton, and lets the confirm dialog list only the entities that will\nactually change instead of everything unconditionally. A content diff,\nnot a version comparison." }, "UnderlyingSchemaSyncTopic": { "properties": { "knowledge_topic_history_id": { "type": "string", "title": "Knowledge Topic History Id", "example": "5eb7cf5a86d9755df3a6c593" }, "knowledge_topic_name": { "type": "string", "title": "Knowledge Topic Name" }, "change_type": { "type": "string", "enum": [ "update", "new", "remove" ], "title": "Change Type" } }, "type": "object", "required": [ "knowledge_topic_history_id", "knowledge_topic_name", "change_type" ], "title": "UnderlyingSchemaSyncTopic", "description": "One Knowledge Topic that 'Update Underlying Schema' would actually\nchange - updating its existing Knowledge Topic Schema counterpart\n(\"update\"), creating a brand new one because it has no trace (\"new\"), or\nremoving a schema entry that no longer has any corresponding Product\nKnowledge Topic (\"remove\", e.g. the KT was deleted from the Product).\n\nFor \"remove\", knowledge_topic_history_id/knowledge_topic_name describe\nthe Knowledge Topic Schema being removed (there is no Product KT anymore\nto describe it from)." }, "UpdateGuidanceTaskStatePayload": { "properties": { "task_id": { "type": "string", "title": "Task Id" }, "state": { "$ref": "#/components/schemas/GuidanceTaskState" } }, "type": "object", "required": [ "task_id", "state" ], "title": "UpdateGuidanceTaskStatePayload" }, "UpdateKUSchemaLibrary": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "knowledge_unit_schema_ids": { "anyOf": [ { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Unit Schema Ids", "default": [] } }, "type": "object", "title": "UpdateKUSchemaLibrary" }, "UpdateKnowledgeTopicSchema": { "properties": { "knowledge_topic_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Topic Name" }, "component_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Component Schema" }, "data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Data" }, "knowledge_unit_schema_history_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Schema History Id" } }, "type": "object", "title": "UpdateKnowledgeTopicSchema", "description": "Model for updating a knowledge topic schema" }, "UpdateKnowledgeUnitSchema": { "properties": { "knowledge_unit_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Name" }, "knowledge_unit_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Knowledge Unit Description" }, "is_not_editable_for_children": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Not Editable For Children" }, "knowledge_topic_schemas": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Topic Schemas" }, "library_ids": { "anyOf": [ { "items": { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, "type": "array" }, { "type": "null" } ], "title": "Library Ids" } }, "type": "object", "title": "UpdateKnowledgeUnitSchema" }, "UpdateProduct": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "udi_di": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi Di" }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_properties": { "anyOf": [ { "$ref": "#/components/schemas/ProductProperties" }, { "type": "null" } ] }, "product_families": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Product Families" }, "product_context": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ProductContextQuestion" }, "type": "array" }, { "type": "null" } ], "title": "Product Context" }, "product_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Website" } }, "type": "object", "title": "UpdateProduct" }, "UpdateProductFamily": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "udi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Udi" }, "udi_issuer": { "anyOf": [ { "$ref": "#/components/schemas/IssuingEntityTypeEnum" }, { "type": "null" } ] }, "lot_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lot Number" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial Number" }, "notified_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notified Body" }, "ce_certificate_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ce Certificate Number" }, "regulatory_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulatory Status" }, "product_properties": { "anyOf": [ { "$ref": "#/components/schemas/ProductProperties" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateProductFamily" }, "UpdateUnderlyingSchemaResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "message": { "type": "string", "title": "Message" }, "new_ku_schema_history_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "New Ku Schema History Id" }, "new_ku_schema_id": { "anyOf": [ { "type": "string", "example": "5eb7cf5a86d9755df3a6c593" }, { "type": "null" } ], "title": "New Ku Schema Id" }, "new_ku_schema_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "New Ku Schema Version" }, "kt_results": { "items": { "$ref": "#/components/schemas/KtSyncResult" }, "type": "array", "title": "Kt Results" } }, "type": "object", "required": [ "success", "message" ], "title": "UpdateUnderlyingSchemaResponse", "description": "Response for the 'Update Underlying Schema' action on a Product KU.\n\nPushes the Product KU's current name/description/KT forms into a new\ndraft revision of the Schema Library schema it was \"auto based on\".\nnew_ku_schema_history_id/new_ku_schema_id/new_ku_schema_version identify\nthat freshly created draft revision." }, "UseCaseAvailableRelation": { "properties": { "relation_name": { "type": "string", "title": "Relation Name" }, "target_knowledge_topic": { "type": "string", "title": "Target Knowledge Topic" } }, "type": "object", "required": [ "relation_name", "target_knowledge_topic" ], "title": "UseCaseAvailableRelation" }, "UseCaseColumnView": { "properties": { "relation_name": { "type": "string", "title": "Relation Name" }, "target_knowledge_topic_name": { "type": "string", "title": "Target Knowledge Topic Name" }, "target_knowledge_topic_history_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Knowledge Topic History Id" }, "allow_multiple": { "type": "boolean", "title": "Allow Multiple", "default": false }, "additional_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Field" }, "bidirection": { "type": "boolean", "title": "Bidirection" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "field": { "type": "string", "title": "Field", "default": "" }, "additional_field_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Field Key" } }, "type": "object", "required": [ "relation_name", "target_knowledge_topic_name", "bidirection" ], "title": "UseCaseColumnView", "description": "One purple trace column, with its target topic resolved to a history_id." }, "UseCaseConfigView": { "properties": { "columns": { "items": { "$ref": "#/components/schemas/UseCaseColumnView" }, "type": "array", "title": "Columns", "default": [] }, "status": { "items": { "$ref": "#/components/schemas/UseCaseStatusView" }, "type": "array", "title": "Status", "default": [] } }, "type": "object", "title": "UseCaseConfigView", "description": "Bundled use-case enrichment for one KT: the purple trace columns plus the\ncompleteness-banner status, grouped under a single field on the KT response.\n\nGrouping (rather than two sibling fields) keeps future additions — ordering,\nvalidation rules, etc. — from growing the top-level KT shape. Present only for\nmulti_record topics that belong to a use case; None otherwise." }, "UseCaseDuplicateTopic": { "properties": { "name": { "type": "string", "title": "Name" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "name", "count" ], "title": "UseCaseDuplicateTopic" }, "UseCaseStatusView": { "properties": { "use_case_name": { "type": "string", "title": "Use Case Name" }, "status": { "type": "string", "enum": [ "complete", "incomplete", "duplicate" ], "title": "Status" }, "missing_topics": { "items": { "type": "string" }, "type": "array", "title": "Missing Topics", "default": [] }, "duplicate_topics": { "items": { "$ref": "#/components/schemas/UseCaseDuplicateTopic" }, "type": "array", "title": "Duplicate Topics", "default": [] }, "available_topics": { "items": { "type": "string" }, "type": "array", "title": "Available Topics", "default": [] }, "required_topics": { "items": { "type": "string" }, "type": "array", "title": "Required Topics", "default": [] }, "available_relations": { "items": { "$ref": "#/components/schemas/UseCaseAvailableRelation" }, "type": "array", "title": "Available Relations", "default": [] }, "is_valid": { "type": "boolean", "title": "Is Valid" }, "show_banner": { "type": "boolean", "title": "Show Banner" } }, "type": "object", "required": [ "use_case_name", "status", "is_valid", "show_banner" ], "title": "UseCaseStatusView", "description": "Pre-computed completeness banner for one use case the topic belongs to." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" } } }, "security": [ { "ApiKeyAuth": [] } ] }