\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid.\nThe name and the guid are the 2 ways that the RelationshipDef is identified.\n
\nRelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally\nwhether the end is a container.\n
\nRelationshipDefs can have AttributeDefs - though only primitive types are allowed.
\nRelationshipDefs have a relationshipCategory specifying the UML type of relationship required
\nThe way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as their types.\n
\nRelationshipDefs introduce new attributes to the entity instances. For example\n
\nEntityDef A might have attributes attr1,attr2,attr3
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef AtoB might define 2 ends
\n\n
\n end1: type A, name attr7\n end2: type B, name attr8\n\n
\nWhen an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8\n
\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" + }, + "AtlasRelationshipEndDef": { + "type": "object", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality" + }, + "description": { + "type": "string", + "description": "The description of the relationship end definition." + }, + "isContainer": { + "type": "boolean", + "description": "Determines if it is container." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "name": { + "type": "string", + "description": "The name of the relationship end definition." + }, + "type": { + "type": "string", + "description": "The type of the relationship end." + } + }, + "title": "AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." + }, + "AtlasRelationshipAttributeDef": { + "type": "object", + "properties": { + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasAttributeDef" + } + ], + "title": "AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "relationship": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "title": "AtlasRelationshipWithExtInfo", + "description": "The relationship with extended information." + }, + "AtlasStruct": { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "$ref": "#/definitions/LastModifiedTS" + } + }, + "title": "AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + }, + "AtlasStructDef": { + "type": "object", + "title": "AtlasStructDef", + "properties": { + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasBaseTypeDef" + } + ], + "description": "class that captures details of a struct-type." + }, + "AtlasTermAssignmentHeader": { + "type": "object", + "properties": { + "confidence": { + "type": "integer", + "format": "int32", + "description": "The confidence of the term assignment." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "description": { + "type": "string", + "description": "The description of the term assignment." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term assignment." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermAssignmentStatus" + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + }, + "title": "AtlasTermAssignmentHeader", + "description": "The header for term assignment." + }, + "AtlasTermAssignmentStatus": { + "type": "string", + "title": "AtlasTermAssignmentStatus", + "description": "The status of terms assignment.", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true + } + }, + "AtlasTermCategorizationHeader": { + "type": "object", + "properties": { + "categoryGuid": { + "type": "string", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the record." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus" + } + }, + "title": "AtlasTermCategorizationHeader", + "description": "The basic information for term categorization." + }, + "AtlasTermRelationshipStatus": { + "type": "string", + "title": "AtlasTermRelationshipStatus", + "description": "The status of term relationship.", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true + } + }, + "AtlasTypeDefHeader": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory" + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + }, + "title": "AtlasTypeDefHeader", + "description": "The basic information of the type definition." + }, + "AtlasTypesDef": { + "type": "object", + "properties": { + "businessMetadataDefs": { + "readOnly": false, + "description": "businessMetadataDefs", + "type": "array", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + } + } + }, + "title": "AtlasTypesDef", + "description": "The definitions of types." + }, + "AtlasExtraTypeDef": { + "type": "object", + "properties": { + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n
\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION and AGGREGATION are containment relationships.\n
\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independent.", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true + } + }, + "RoundingMode": { + "type": "string", + "title": "RoundingMode", + "description": "The enum of rounding mode.", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true + } + }, + "SortType": { + "type": "string", + "title": "SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc.", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true + } + }, + "Status": { + "type": "string", + "title": "Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not removed.", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "Status_AtlasRelationship": { + "type": "string", + "title": "Status", + "description": "The enum of relationship status.", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "Status_AtlasRelationship", + "modelAsString": true + } + }, + "TimeBoundary": { + "type": "object", + "properties": { + "endTime": { + "type": "string", + "description": "The end of the time boundary." + }, + "startTime": { + "type": "string", + "description": "The start of the time boundary." + }, + "timeZone": { + "type": "string", + "description": "The timezone of the time boundary." + } + }, + "title": "TimeBoundary", + "description": "Captures time-boundary details" + }, + "TimeZone": { + "type": "object", + "properties": { + "dstSavings": { + "type": "integer", + "format": "int32", + "description": "The value of the daylight saving time." + }, + "id": { + "type": "string", + "description": "The ID of the timezone." + }, + "availableIds": { + "type": "array", + "description": "An array of available IDs.", + "items": { + "type": "string" + } + }, + "default": { + "$ref": "#/definitions/TimeZone" + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + }, + "title": "TimeZone", + "description": "The timezone information." + }, + "TypeCategory": { + "type": "string", + "title": "TypeCategory", + "description": "The enum of type category.", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true + } + }, + "SuggestResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + }, + "title": "SuggestResult", + "description": "The result item of the search suggest." + }, + "SuggestResultValue": { + "type": "object", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by search score by default." + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark." + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + } + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + }, + "title": "SuggestResultValue", + "description": "The value item of the search suggest." + }, + "SearchResult": { + "type": "object", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single page)." + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Absent if there's no more data." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetResultValue" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + }, + "title": "SearchResult", + "description": "The result of the search result." + }, + "SearchFacetResultValue": { + "type": "object", + "properties": { + "entityType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "assetType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "classification": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "term": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "contactId": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "contactType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "label": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "glossaryType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "termStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "termTemplate": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + } + }, + "title": "Context", + "description": "A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets." + }, + "SearchFacetItemValue": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + }, + "title": "SearchFacetItemValue", + "description": "The content of a search facet result item." + }, + "SearchFacetItem": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "type": "object" + } + }, + "title": "SearchFacetItemValue", + "description": "The content of a search facet result item." + }, + "SearchOrderItem": { + "type": "object", + "description": "See examples for the usage of search order." + }, + "SearchResultValue": { + "type": "object", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by search score by default." + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + } + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + }, + "title": "SearchResultValue", + "description": "The value item of the search result." + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.", + "properties": { + "id": { + "type": "array", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "SearchHighlights" + }, + "TermSearchResultValue": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the term." + }, + "glossaryName": { + "type": "string", + "description": "The name of the glossary which contains the term." + }, + "guid": { + "type": "string", + "description": "The GUID of the term." + } + }, + "title": "Context", + "description": "The context." + }, + "ContactSearchResultValue": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the contact." + }, + "info": { + "type": "string", + "description": "The description of the contact." + }, + "contactType": { + "type": "string", + "description": "The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term." + } + }, + "title": "contact", + "description": "The contact in the search and suggest result." + }, + "AutoCompleteRequest": { + "type": "object", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100." + }, + "filter": { + "type": "object", + "description": "The filter for the autocomplete request." + } + }, + "title": "AutoCompleteRequest", + "description": "The query of autocomplete request." + }, + "AutoCompleteResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + } + } + }, + "title": "AutoCompleteResult", + "description": "The result of the autocomplete request." + }, + "AutoCompleteResultValue": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + }, + "title": "AutoCompleteResultValue", + "description": "The value item of the autocomplete suggest." + }, + "SearchRequest": { + "type": "object", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all searchable fields." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit of the number of the search result. default value is 50; maximum value is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data." + }, + "orderby": { + "type": "array", + "description": "The sort order of search results, can specify multiple fields.", + "items": { + "$ref": "#/definitions/SearchOrderItem" + } + }, + "filter": { + "type": "object", + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItem" + } + }, + "taxonomySetting": { + "type": "object", + "properties": { + "assetTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem" + } + } + } + }, + "title": "SearchRequest", + "description": "The search query of advanced search request." + }, + "SuggestRequest": { + "type": "object", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100." + }, + "filter": { + "type": "object", + "description": "The filter for the search." + } + }, + "title": "SuggestRequest", + "description": "The query of suggest request." + }, + "LastModifiedTS": { + "type": "string", + "title": "lastModifiedTS", + "description": "ETag for concurrency control." + }, + "ErrorResponse": { + "description": "An error response from the service", + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "The request ID." + }, + "errorCode": { + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "RelatedCategoryHeaders": { + "type": "object", + "description": "An array of related categories.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + } + } + }, + "RelatedTermHeaders": { + "type": "object", + "description": "An array of related glossary terms for the given glossary or an empty list.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + } + }, + "BusinessMetadata": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "BusinessMetadata" + }, + "BusinessMetadataAttributes": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "BusinessMetadataAttributes" + } + }, + "parameters": { + "endpoint": { + "name": "endpoint", + "description": "The datamap endpoint of your Purview account. Example: https://{accountName}.purview.azure.com", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "format": "url", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "guid": { + "name": "guid", + "description": "The globally unique identifier of the entity.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "classificationName": { + "name": "classificationName", + "description": "The name of the classification.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "typeName": { + "name": "typeName", + "description": "The name of the type.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "categoryGuid": { + "name": "categoryGuid", + "description": "The globally unique identifier of the category.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "limit": { + "name": "limit", + "description": "The page size - by default there is no paging.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "offset": { + "name": "offset", + "description": "The offset for pagination purpose.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "sort": { + "name": "sort", + "description": "The sort order, ASC (default) or DESC.", + "in": "query", + "required": false, + "type": "string", + "default": "ASC", + "x-ms-parameter-location": "method" + }, + "termGuid": { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "fileId": { + "name": "fileId", + "in": "path", + "description": "The globally unique identifier for file.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "glossaryGuid": { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "operationGuid": { + "name": "operationGuid", + "in": "path", + "description": "The globally unique identifier for async operation job.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "glossaryName": { + "name": "glossaryName", + "in": "path", + "description": "The name of the glossary.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "searchLimit": { + "name": "limit", + "description": "Limits the result set to only include the specified number of entries.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "searchKeyword": { + "name": "keyword", + "description": "The keyword to get auto complete.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "depth": { + "name": "depth", + "description": "The number of hops for lineage.", + "in": "query", + "required": false, + "type": "integer", + "default": 3, + "format": "int32", + "x-ms-parameter-location": "method" + }, + "direction": { + "name": "direction", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "extendedInfo": { + "name": "extendedInfo", + "description": "Limits whether includes extended information.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "relationshipGuid": { + "name": "guid", + "description": "The globally unique identifier of the relationship.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "classificationDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the classification.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "classificationDefName": { + "name": "name", + "description": "The name of the classification.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "entityDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the entity.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "entityDefName": { + "name": "name", + "description": "The name of the entity.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "termTemplateDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the term template.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "termTemplateDefName": { + "name": "name", + "description": "The name of the term template.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "enumDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the enum.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "enumDefName": { + "name": "name", + "description": "The name of the enum.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "relationshipDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the relationship.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "relationshipDefName": { + "name": "name", + "description": "The name of the relationship.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "structDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the struct.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "structDefName": { + "name": "name", + "description": "The name of the struct.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "typeDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the type.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "typeDefName": { + "name": "name", + "description": "The name of the type.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "userId": { + "name": "userId", + "description": "The user ID.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "principalId": { + "name": "principalId", + "description": "The principal ID.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "minExtInfo": { + "name": "minExtInfo", + "description": "Whether to return minimal information for referred entities.", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "ignoreRelationships": { + "name": "ignoreRelationships", + "description": "Whether to ignore relationship attributes.", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "includeTermTemplate": { + "name": "includeTermTemplate", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true when search filter type=term_template", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "includeTermHierarchy": { + "name": "includeTermHierarchy", + "description": "Whether include term hierarchy", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "extInfo": { + "name": "extInfo", + "description": "Whether include extended information like contact display name and attribute values", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "ignoreTermsAndCategories": { + "name": "ignoreTermsAndCategories", + "description": "Whether ignore terms and categories", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "purviewAPIVersion": { + "name": "api-version", + "description": "The version of the API.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "atlasAPIVersion": { + "name": "api-version", + "description": "The version of the API.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "type": { + "name": "type", + "description": "Typedef name as search filter when get typedefs.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "requiredCollectionId": { + "name": "collectionId", + "description": "The collection where entities will be moved to.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "collectionId": { + "name": "collectionId", + "description": "The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "forceDeleteEntityAssignment": { + "name": "forceDeleteEntityAssignment", + "description": "Whether delete entity assignment", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "forceDeleteChild": { + "name": "forceDeleteChild", + "description": "Whether delete child terms together with the parent term", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "businessAttributeUpdateBehavior": { + "name": "businessAttributeUpdateBehavior", + "description": "Used to define the update behavior for business attributes when updating entities.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "businessAttributeUpdateBehavior", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 854b5cfdea2d..979ab008d259 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -26,18 +26,27 @@ These are the global settings for the Azure Purview Catalog API. ``` yaml openapi-type: data-plane -tag: package-preview-2023-02 +tag: package-2023-09 ``` +### Tag: package-2023-09 + +These settings apply only when `--tag=package-2023-09` is specified on the command line. + +```yaml $(tag) == 'package-2023-09' +input-file: + - Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +``` ### Tag: package-preview-2023-02 These settings apply only when `--tag=package-preview-2023-02` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-02' +``` yaml $(tag) == 'package-preview-2023-02' input-file: - Azure.Analytics.Purview.Catalog/preview/2023-02-01-preview/purviewcatalog.json ``` + ### Tag: package-2022-11-01-preview These settings apply only when `--tag=package-2022-11-01-preview` is specified on the command line.