# Glossary The Glossary API allows you to manage business terms, categories, and their definitions within your Decube organization. Use these endpoints to create, update, search, and organize glossary terms that provide consistent business context for your data assets. Use the Glossary API to: * Create and manage glossary terms and categories * Search and list glossary objects with filtering * Attach and manage documentation for terms * Build automated glossary synchronization workflows * Maintain consistent business terminology across systems ## Get Glossary Object > Get a glossary object by ID and AssetType ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary":{"get":{"tags":["Catalog","Glossary"],"summary":"Get Glossary Object","description":"Get a glossary object by ID and AssetType","operationId":"get_glossary_object_catalog_glossary_get","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer","title":"Id"}},{"name":"type","in":"query","required":true,"schema":{"enum":["glossary","category","term"],"type":"string","title":"Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/decube__asset__models__AssetData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"decube__asset__models__AssetData":{"properties":{"asset":{"$ref":"#/components/schemas/DataAssets"},"parents":{"items":{"$ref":"#/components/schemas/DataAssets"},"type":"array","title":"Parents"},"assets":{"items":{"$ref":"#/components/schemas/DataAssets"},"type":"array","title":"Assets"},"attrs":{"type":"object","title":"Attrs"}},"type":"object","required":["asset","parents","assets","attrs"],"title":"AssetData"},"DataAssets":{"properties":{"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"id":{"type":"integer","title":"Id"},"subtype":{"anyOf":[{"$ref":"#/components/schemas/DbType"},{"$ref":"#/components/schemas/AssetMetadataSubtypes"},{"type":"string","enum":["glossary","category","term"]}],"title":"Subtype"},"qual_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qual Id"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["type","name","id","subtype"],"title":"DataAssets"},"DbType":{"type":"string","enum":["bigquery","redshift","postgresql","mysql","snowflake","databricks","sql_server","azure_server","singlestore","synapse","oracle","cloudera_hive","hive","power_bi","tableau","looker","dbt_cloud","dbt_core","fivetran","airflow","adf","glue","s3dl","adls","gcsdl","open_lineage","spark","iceberg","cloudera_atlas","atlas","unknown"],"title":"DbType"},"AssetMetadataSubtypes":{"type":"string","enum":["database","schema","table","virtual_table","view","column","virtual_column","data_job","data_task","data_job_run","data_task_run","file","glossary","category","term","monitor","incident","case","policy","policy_rule","property_monitor","dataset_monitor","etl_monitor","custom_monitor","dashboard","report","chart"],"title":"AssetMetadataSubtypes"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Create Glossary Object > Creates a glossary object and return the ID of the newly created object ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary":{"post":{"tags":["Catalog","Glossary"],"summary":"Create Glossary Object","description":"Creates a glossary object and return the ID of the newly created object","operationId":"create_glossary_object_catalog_glossary_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateGlossaryBody"},{"$ref":"#/components/schemas/CreateCategoryBody"},{"$ref":"#/components/schemas/CreateTermBody"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryAssetIdentifier"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateGlossaryBody":{"properties":{"type":{"type":"string","const":"glossary","title":"Type"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Owner","description":"Email of Data Owner"},"business_owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Business Owners","description":"List of emails"}},"type":"object","required":["type","name"],"title":"CreateGlossaryBody"},"CreateCategoryBody":{"properties":{"type":{"type":"string","const":"category","title":"Type"},"name":{"type":"string","title":"Name"},"parent":{"$ref":"#/components/schemas/GlossaryIdentifier"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Owner","description":"Email of Data Owner"},"business_owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Business Owners","description":"List of emails"}},"type":"object","required":["type","name","parent"],"title":"CreateCategoryBody"},"GlossaryIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"glossary","title":"Type"}},"type":"object","required":["id","type"],"title":"GlossaryIdentifier"},"CreateTermBody":{"properties":{"type":{"type":"string","const":"term","title":"Type"},"name":{"type":"string","title":"Name"},"parent":{"anyOf":[{"$ref":"#/components/schemas/CategoryIdentifier"},{"$ref":"#/components/schemas/GlossaryIdentifier"}],"title":"Parent"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Owner","description":"Email of Data Owner"},"business_owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Business Owners","description":"List of emails"},"related_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/decube__asset__models__TermIdentifier"},"type":"array"},{"type":"null"}],"title":"Related Terms"},"linked_assets":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinkedAssetIdentifier"},"type":"array"},{"type":"null"}],"title":"Linked Assets"},"policies_by_name":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Policies By Name","description":"List of governance policies to attach to the term by name of Policy"}},"type":"object","required":["type","name","parent"],"title":"CreateTermBody"},"CategoryIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"category","title":"Type"}},"type":"object","required":["id","type"],"title":"CategoryIdentifier"},"decube__asset__models__TermIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"term","title":"Type"}},"type":"object","required":["id","type"],"title":"TermIdentifier"},"LinkedAssetIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","enum":["dataset","property","dashboard","chart","data_job","collection","source"],"title":"Type"}},"type":"object","required":["id","type"],"title":"LinkedAssetIdentifier"},"GlossaryAssetIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","enum":["glossary","category","term"],"title":"Type"}},"type":"object","required":["id","type"],"title":"GlossaryAssetIdentifier"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Delete Glossary Object > Deletes an existing glossary object. ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary":{"delete":{"tags":["Catalog","Glossary"],"summary":"Delete Glossary Object","description":"Deletes an existing glossary object.","operationId":"delete_glossary_object_catalog_glossary_delete","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer","description":"Id of glossary object","title":"Id"},"description":"Id of glossary object"},{"name":"type","in":"query","required":true,"schema":{"enum":["glossary","category","term"],"type":"string","description":"","title":"Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Modify Glossary Object > Modifies an existing glossary object. ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary":{"patch":{"tags":["Catalog","Glossary"],"summary":"Modify Glossary Object","description":"Modifies an existing glossary object.","operationId":"modify_glossary_object_catalog_glossary_patch","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ModifyGlossaryBody"},{"$ref":"#/components/schemas/ModifyCategoryBody"},{"$ref":"#/components/schemas/ModifyTermBody"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ModifyGlossaryBody":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"glossary","title":"Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Owner","description":"Email of Data Owner"},"business_owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Business Owners","description":"List of emails"}},"type":"object","required":["id","type"],"title":"ModifyGlossaryBody"},"ModifyCategoryBody":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"category","title":"Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Owner","description":"Email of Data Owner"},"business_owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Business Owners","description":"List of emails"}},"type":"object","required":["id","type"],"title":"ModifyCategoryBody"},"ModifyTermBody":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"term","title":"Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"data_owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Owner","description":"Email of Data Owner"},"business_owners":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Business Owners","description":"List of emails"},"related_terms":{"anyOf":[{"items":{"$ref":"#/components/schemas/decube__asset__models__TermIdentifier"},"type":"array"},{"type":"null"}],"title":"Related Terms"},"linked_assets":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinkedAssetIdentifier"},"type":"array"},{"type":"null"}],"title":"Linked Assets"},"policies_by_name":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Policies By Name","description":"List of governance policies to attach to the term by name of Policy"}},"type":"object","required":["id","type"],"title":"ModifyTermBody"},"decube__asset__models__TermIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"term","title":"Type"}},"type":"object","required":["id","type"],"title":"TermIdentifier"},"LinkedAssetIdentifier":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","enum":["dataset","property","dashboard","chart","data_job","collection","source"],"title":"Type"}},"type":"object","required":["id","type"],"title":"LinkedAssetIdentifier"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## List Glossary Objects > List glossary objects.\ > If parent\_id and parent\_type is specified, will return all glossary objects under the parent Glossary object.\ > If type is defined, will return all glossary objects of that type only.\ > page\_size limit is 100. ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary/list":{"get":{"tags":["Catalog","Glossary"],"summary":"List Glossary Objects","description":"List glossary objects.\n If parent_id and parent_type is specified, will return all glossary objects under the parent Glossary object.\n If type is defined, will return all glossary objects of that type only.\n page_size limit is 100.","operationId":"list_glossary_objects_catalog_glossary_list_get","parameters":[{"name":"parent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"ID of the parent object","title":"Parent Id"},"description":"ID of the parent object"},{"name":"parent_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["glossary","category"],"type":"string"},{"type":"null"}],"description":"Type of the parent object","title":"Parent Type"},"description":"Type of the parent object"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["glossary","category","term"],"type":"string"},{"type":"null"}],"description":"Filters the result to only contain glossary objects of this type","title":"Type"},"description":"Filters the result to only contain glossary objects of this type"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Page Size"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/decube__asset__models__AssetData"},"title":"Response List Glossary Objects Catalog Glossary List Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"decube__asset__models__AssetData":{"properties":{"asset":{"$ref":"#/components/schemas/DataAssets"},"parents":{"items":{"$ref":"#/components/schemas/DataAssets"},"type":"array","title":"Parents"},"assets":{"items":{"$ref":"#/components/schemas/DataAssets"},"type":"array","title":"Assets"},"attrs":{"type":"object","title":"Attrs"}},"type":"object","required":["asset","parents","assets","attrs"],"title":"AssetData"},"DataAssets":{"properties":{"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"id":{"type":"integer","title":"Id"},"subtype":{"anyOf":[{"$ref":"#/components/schemas/DbType"},{"$ref":"#/components/schemas/AssetMetadataSubtypes"},{"type":"string","enum":["glossary","category","term"]}],"title":"Subtype"},"qual_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qual Id"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["type","name","id","subtype"],"title":"DataAssets"},"DbType":{"type":"string","enum":["bigquery","redshift","postgresql","mysql","snowflake","databricks","sql_server","azure_server","singlestore","synapse","oracle","cloudera_hive","hive","power_bi","tableau","looker","dbt_cloud","dbt_core","fivetran","airflow","adf","glue","s3dl","adls","gcsdl","open_lineage","spark","iceberg","cloudera_atlas","atlas","unknown"],"title":"DbType"},"AssetMetadataSubtypes":{"type":"string","enum":["database","schema","table","virtual_table","view","column","virtual_column","data_job","data_task","data_job_run","data_task_run","file","glossary","category","term","monitor","incident","case","policy","policy_rule","property_monitor","dataset_monitor","etl_monitor","custom_monitor","dashboard","report","chart"],"title":"AssetMetadataSubtypes"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Search Glossary Objects > Search glossary objects.\ > If name is specified will return all glossary objects with that name.\ > is\_fuzzy flag turns on fuzzy searching that allows non-exact matching.\ > max\_results limit is 100. ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary/search":{"get":{"tags":["Catalog","Glossary"],"summary":"Search Glossary Objects","description":"Search glossary objects.\n If name is specified will return all glossary objects with that name.\n is_fuzzy flag turns on fuzzy searching that allows non-exact matching.\n max_results limit is 100.","operationId":"search_glossary_objects_catalog_glossary_search_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["glossary","category","term"],"type":"string"},{"type":"null"}],"description":"Filters the result to only contain glossary objects of this type","title":"Type"},"description":"Filters the result to only contain glossary objects of this type"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search for glossary object based on the name. Case sensitive","title":"Name"},"description":"Search for glossary object based on the name. Case sensitive"},{"name":"is_fuzzy","in":"query","required":false,"schema":{"type":"boolean","description":"Fuzzy search with name argument","default":false,"title":"Is Fuzzy"},"description":"Fuzzy search with name argument"},{"name":"max_results","in":"query","required":false,"schema":{"type":"integer","maximum":100,"default":10,"title":"Max Results"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/decube__asset__models__AssetData"},"title":"Response Search Glossary Objects Catalog Glossary Search Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"decube__asset__models__AssetData":{"properties":{"asset":{"$ref":"#/components/schemas/DataAssets"},"parents":{"items":{"$ref":"#/components/schemas/DataAssets"},"type":"array","title":"Parents"},"assets":{"items":{"$ref":"#/components/schemas/DataAssets"},"type":"array","title":"Assets"},"attrs":{"type":"object","title":"Attrs"}},"type":"object","required":["asset","parents","assets","attrs"],"title":"AssetData"},"DataAssets":{"properties":{"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"id":{"type":"integer","title":"Id"},"subtype":{"anyOf":[{"$ref":"#/components/schemas/DbType"},{"$ref":"#/components/schemas/AssetMetadataSubtypes"},{"type":"string","enum":["glossary","category","term"]}],"title":"Subtype"},"qual_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qual Id"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["type","name","id","subtype"],"title":"DataAssets"},"DbType":{"type":"string","enum":["bigquery","redshift","postgresql","mysql","snowflake","databricks","sql_server","azure_server","singlestore","synapse","oracle","cloudera_hive","hive","power_bi","tableau","looker","dbt_cloud","dbt_core","fivetran","airflow","adf","glue","s3dl","adls","gcsdl","open_lineage","spark","iceberg","cloudera_atlas","atlas","unknown"],"title":"DbType"},"AssetMetadataSubtypes":{"type":"string","enum":["database","schema","table","virtual_table","view","column","virtual_column","data_job","data_task","data_job_run","data_task_run","file","glossary","category","term","monitor","incident","case","policy","policy_rule","property_monitor","dataset_monitor","etl_monitor","custom_monitor","dashboard","report","chart"],"title":"AssetMetadataSubtypes"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Attach Documentation To Term > Attaches documentation to a term.\ > If an existing documentation is already attached to a term, it will be replaced. ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary/documentation":{"post":{"tags":["Catalog","Glossary"],"summary":"Attach Documentation To Term","description":"Attaches documentation to a term.\n If an existing documentation is already attached to a term, it will be replaced.","operationId":"attach_documentation_to_term_catalog_glossary_documentation_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachDocumentationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AttachDocumentationRequest":{"properties":{"id":{"type":"integer","title":"Id"},"type":{"type":"string","const":"term","title":"Type"},"documentation":{"$ref":"#/components/schemas/TipTapDocument"}},"type":"object","required":["id","type","documentation"],"title":"AttachDocumentationRequest"},"TipTapDocument":{"properties":{"type":{"type":"string","const":"doc","title":"Type"},"content":{"items":{"$ref":"#/components/schemas/TipTapContentNode"},"type":"array","title":"Content","description":"List of content nodes in the document"}},"type":"object","required":["type","content"],"title":"TipTapDocument"},"TipTapContentNode":{"oneOf":[{"$ref":"#/components/schemas/TipTapParagraph"},{"$ref":"#/components/schemas/TipTapHeading"},{"$ref":"#/components/schemas/TipTapBulletList"},{"$ref":"#/components/schemas/TipTapOrderedList"},{"$ref":"#/components/schemas/TipTapCodeBlock"},{"$ref":"#/components/schemas/TipTapBlockquote"},{"$ref":"#/components/schemas/TipTapHorizontalRule"},{"$ref":"#/components/schemas/TipTapTable"}],"title":"TipTapContentNode","discriminator":{"propertyName":"type","mapping":{"blockquote":"#/components/schemas/TipTapBlockquote","bulletList":"#/components/schemas/TipTapBulletList","codeBlock":"#/components/schemas/TipTapCodeBlock","heading":"#/components/schemas/TipTapHeading","horizontalRule":"#/components/schemas/TipTapHorizontalRule","orderedList":"#/components/schemas/TipTapOrderedList","paragraph":"#/components/schemas/TipTapParagraph","table":"#/components/schemas/TipTapTable"}}},"TipTapParagraph":{"properties":{"type":{"type":"string","const":"paragraph","title":"Type"},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/TipTapText"},"type":"array"},{"type":"null"}],"title":"Content","description":"Text content within the paragraph"}},"type":"object","required":["type"],"title":"TipTapParagraph"},"TipTapText":{"properties":{"type":{"type":"string","const":"text","title":"Type"},"text":{"type":"string","title":"Text"},"marks":{"anyOf":[{"items":{"$ref":"#/components/schemas/TipTapMark"},"type":"array"},{"type":"null"}],"title":"Marks"}},"type":"object","required":["type","text"],"title":"TipTapText"},"TipTapMark":{"properties":{"type":{"type":"string","enum":["bold","italic","strike","code"],"title":"Type"}},"type":"object","required":["type"],"title":"TipTapMark"},"TipTapHeading":{"properties":{"type":{"type":"string","const":"heading","title":"Type"},"attrs":{"$ref":"#/components/schemas/TipTapHeadingLevel","description":"Heading H1 attributes"},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/TipTapText"},"type":"array"},{"type":"null"}],"title":"Content"}},"type":"object","required":["type","attrs"],"title":"TipTapHeading"},"TipTapHeadingLevel":{"properties":{"level":{"type":"integer","const":1,"title":"Level","default":1}},"type":"object","title":"TipTapHeadingLevel"},"TipTapBulletList":{"properties":{"type":{"type":"string","const":"bulletList","title":"Type"},"content":{"items":{"$ref":"#/components/schemas/TipTapListItem"},"type":"array","title":"Content","description":"List of list items in bullet list"}},"type":"object","required":["type","content"],"title":"TipTapBulletList"},"TipTapListItem":{"properties":{"type":{"type":"string","const":"listItem","title":"Type"},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/TipTapParagraph"},{"$ref":"#/components/schemas/TipTapTable"},{"$ref":"#/components/schemas/TipTapBulletList"},{"$ref":"#/components/schemas/TipTapOrderedList"},{"$ref":"#/components/schemas/TipTapHorizontalRule"}]},"type":"array","title":"Content","description":"Required list content within the list item"}},"type":"object","required":["type","content"],"title":"TipTapListItem"},"TipTapTable":{"properties":{"type":{"type":"string","const":"table","title":"Type"},"content":{"items":{"$ref":"#/components/schemas/TipTapTableRow"},"type":"array","title":"Content","description":"List of table rows"}},"type":"object","required":["type","content"],"title":"TipTapTable"},"TipTapTableRow":{"properties":{"type":{"type":"string","const":"tableRow","title":"Type"},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/TipTapTableCell"},{"$ref":"#/components/schemas/TipTapTableHeader"}]},"type":"array","title":"Content","description":"List of table cells in the row"}},"type":"object","required":["type","content"],"title":"TipTapTableRow"},"TipTapTableCell":{"properties":{"type":{"type":"string","const":"tableCell","title":"Type"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/TipTapTableCellAttrs"},{"type":"null"}],"description":"Table cell attributes"},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/TipTapParagraph"},{"$ref":"#/components/schemas/TipTapHeading"},{"$ref":"#/components/schemas/TipTapBulletList"},{"$ref":"#/components/schemas/TipTapOrderedList"},{"$ref":"#/components/schemas/TipTapCodeBlock"},{"$ref":"#/components/schemas/TipTapBlockquote"},{"$ref":"#/components/schemas/TipTapHorizontalRule"},{"$ref":"#/components/schemas/TipTapTable"}]},"type":"array","title":"Content","description":"Table cell content"}},"type":"object","required":["type","content"],"title":"TipTapTableCell"},"TipTapTableCellAttrs":{"properties":{"colspan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Colspan","description":"Number of columns this cell spans","default":1},"rowspan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rowspan","description":"Number of rows this cell spans","default":1},"colwidth":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Colwidth","description":"Column widths for this cell"}},"type":"object","title":"TipTapTableCellAttrs"},"TipTapOrderedList":{"properties":{"type":{"type":"string","const":"orderedList","title":"Type"},"attrs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Attrs","description":"Ordered list attributes"},"content":{"items":{"$ref":"#/components/schemas/TipTapListItem"},"type":"array","title":"Content","description":"List of list items in ordered list"}},"type":"object","required":["type","content"],"title":"TipTapOrderedList"},"TipTapCodeBlock":{"properties":{"type":{"type":"string","const":"codeBlock","title":"Type"},"attrs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Attrs","description":"Code block attributes"},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/TipTapText"},"type":"array"},{"type":"null"}],"title":"Content","description":"Text content in code block"}},"type":"object","required":["type"],"title":"TipTapCodeBlock"},"TipTapBlockquote":{"properties":{"type":{"type":"string","const":"blockquote","title":"Type"},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/TipTapParagraph"},{"$ref":"#/components/schemas/TipTapHeading"},{"$ref":"#/components/schemas/TipTapCodeBlock"},{"$ref":"#/components/schemas/TipTapBulletList"},{"$ref":"#/components/schemas/TipTapOrderedList"},{"$ref":"#/components/schemas/TipTapHorizontalRule"},{"$ref":"#/components/schemas/TipTapTable"}]},"type":"array","title":"Content","description":"Quoted content paragraphs, headings, code blocks, lists, dividers, or tables"}},"type":"object","required":["type","content"],"title":"TipTapBlockquote"},"TipTapHorizontalRule":{"properties":{"type":{"type":"string","const":"horizontalRule","title":"Type"},"attrs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Attrs","description":"Horizontal rule attributes"}},"type":"object","required":["type"],"title":"TipTapHorizontalRule"},"TipTapTableHeader":{"properties":{"type":{"type":"string","const":"tableHeader","title":"Type"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/TipTapTableCellAttrs"},{"type":"null"}],"description":"Table header attributes"},"content":{"items":{"anyOf":[{"$ref":"#/components/schemas/TipTapParagraph"},{"$ref":"#/components/schemas/TipTapHeading"},{"$ref":"#/components/schemas/TipTapBulletList"},{"$ref":"#/components/schemas/TipTapOrderedList"},{"$ref":"#/components/schemas/TipTapCodeBlock"},{"$ref":"#/components/schemas/TipTapBlockquote"},{"$ref":"#/components/schemas/TipTapHorizontalRule"},{"$ref":"#/components/schemas/TipTapTable"}]},"type":"array","title":"Content","description":"Table header content"}},"type":"object","required":["type","content"],"title":"TipTapTableHeader"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Delete Documentation To Term > Deletes documentation of a term.\ > Deletes the documentation attached to a term. ```json {"openapi":"3.1.0","info":{"title":"Decube Public API (BETA)","version":"1.0.0"},"servers":[{"url":"https://connect..decube.io/api/v1/data"}],"paths":{"/catalog/glossary/documentation":{"delete":{"tags":["Catalog","Glossary"],"summary":"Delete Documentation To Term","description":"Deletes documentation of a term.\n Deletes the documentation attached to a term.","operationId":"delete_documentation_to_term_catalog_glossary_documentation_delete","parameters":[{"name":"term_id","in":"query","required":true,"schema":{"type":"integer","description":"The ID of the Term.","title":"Term Id"},"description":"The ID of the Term."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ```