From 7fcdb36a9703efad5cdd9534a72aacfdb3323d0c Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Wed, 1 Nov 2023 18:12:26 -0700 Subject: [PATCH 001/132] initial commit --- .../Azure.Analytics.Purview.DataMap/main.tsp | 33 + .../models.tsp | 1754 ++++++++++++++++ .../routes.tsp | 1868 +++++++++++++++++ .../tspconfig.yaml | 36 + 4 files changed, 3691 insertions(+) create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/main.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/models.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp new file mode 100644 index 000000000000..331846964e26 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -0,0 +1,33 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +@service({ + title: "Azure Analytics Purview Data Map", +}) +@server( + "{endpoint}/datamap/api", + "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service.", + { + endpoint: string, + } +) +@doc(""" +Purview Data Map Service is a fully managed cloud service whose users can +discover the data sources they need and understand the data sources they find. +At the same time, Data Map helps organizations get more value from their +existing investments. This spec defines REST API of Purview Data Map Service. +""") +@versioned(ApiVersions) +namespace PurviewDataMap; + +@doc("Service API versions") +enum ApiVersions { + @doc("2023-09-01 service API version") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + "2023-09-01", +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp new file mode 100644 index 000000000000..eb534f79d130 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -0,0 +1,1754 @@ +import "@typespec/rest"; +import "@typespec/http"; + +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace PurviewDataMap; + +enum BusinessAttributeUpdateBehavior { + ignore, + replace, + merge, +} + +enum Status { + ACTIVE, + DELETED, +} + +enum AtlasTermAssignmentStatus { + DISCOVERED, + PROPOSED, + IMPORTED, + VALIDATED, + DEPRECATED, + OBSOLETE, + OTHER, +} + +enum SortType { + NONE, + ASC, + DESC, +} + +enum ImportStatus { + SUCCESS, + FAILED, +} + +enum AtlasTermRelationshipStatus { + DRAFT, + ACTIVE, + DEPRECATED, + OBSOLETE, + OTHER, +} + +enum TermStatus { + Draft, + Approved, + Alert, + Expired, +} + +enum StatusAtlasRelationship { + ACTIVE, + DELETED, +} + +enum Direction { + BOTH, + INPUT, + OUTPUT, +} + +enum LineageDirection { + INPUT, + OUTPUT, + BOTH, +} + +enum Cardinality { + SINGLE, + LIST, + SET, +} + +enum TypeCategory { + PRIMITIVE, + OBJECT_ID_TYPE, + ENUM, + STRUCT, + CLASSIFICATION, + ENTITY, + ARRAY, + MAP, + RELATIONSHIP, + TERM_TEMPLATE, +} + +enum RoundingMode { + UP, + DOWN, + CEILING, + FLOOR, + HALF_UP, + HALF_DOWN, + HALF_EVEN, + UNNECESSARY, +} + +enum RelationshipCategory { + ASSOCIATION, + AGGREGATION, + COMPOSITION, +} + +enum Type { + `enum`, + entity, + classification, + relationship, + struct, + term_template, +} + +@doc(""" +An instance of an entity along with extended info - like hive_table, +hive_database. +""") +model AtlasEntityWithExtInfo { + ...AtlasEntityExtInfo; + + @doc("An instance of an entity - like hive_table, hive_database.") + entity?: AtlasEntity; +} + +@doc("An instance of an entity - like hive_table, hive_database.") +model AtlasEntity { + ...AtlasStruct; + + @doc("Business Attributes") + businessAttributes?: Record; + + @doc("An array of classifications.") + classifications?: AtlasClassification[]; + + @doc("The created time of the record.") + createTime?: int32; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("Custom Attribute") + customAttributes?: Record; + + @doc("The GUID of the entity.") + guid?: string; + + @doc("The home ID of the entity.") + homeId?: string; + + @doc("The collection ID of the entity.") + @visibility("read") + collectionId?: string; + + @doc("Whether it is a shell entity") + isIncomplete?: boolean; + + @doc("labels") + labels?: string[]; + + @doc("An array of term assignment headers indicating the meanings of the entity.") + meanings?: AtlasTermAssignmentHeader[]; + + @doc("Used to record the provenance of an instance of an entity or relationship.") + provenanceType?: float32; + + @doc("Determines if there's a proxy.") + proxy?: boolean; + + @doc("The attributes of relationship.") + relationshipAttributes?: Record; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + status?: Status; + + @doc("The update time of the record.") + updateTime?: int32; + + @doc("The user who updated the record.") + updatedBy?: string; + + @doc("The version of the entity.") + version?: float32; + + @doc("The dictionary of contacts for entities. Key could be Expert or Owner.") + contacts?: Record; +} + +@doc(""" +An instance of a classification; it doesn't have an identity, this object +exists only when associated with an entity. +""") +model AtlasClassification { + ...AtlasStruct; + + @doc("The GUID of the entity.") + entityGuid?: string; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + entityStatus?: Status; + + @doc("Determines if propagations will be removed on entity deletion.") + removePropagationsOnEntityDelete?: boolean; + + @doc("An array of time boundaries indicating validity periods.") + validityPeriods?: TimeBoundary[]; +} + +@doc("Captures time-boundary details") +model TimeBoundary { + @doc("The end of the time boundary.") + endTime?: string; + + @doc("The start of the time boundary.") + startTime?: string; + + @doc("The timezone of the time boundary.") + timeZone?: string; +} + +@doc(""" +Captures details of struct contents. Not instantiated directly, used only via +AtlasEntity, AtlasClassification. +""") +model AtlasStruct { + @doc("The attributes of the struct.") + attributes?: Record; + + @doc("The name of the type.") + typeName?: string; + + @doc("ETag for concurrency control.") + lastModifiedTS?: string; +} + +@doc("The header for term assignment.") +model AtlasTermAssignmentHeader { + @doc("The confidence of the term assignment.") + confidence?: int32; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("The description of the term assignment.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The expression of the term assignment.") + expression?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; + + @doc("The status of terms assignment.") + status?: AtlasTermAssignmentStatus; + + @doc("The steward of the term.") + steward?: string; + + @doc("The GUID of the term.") + termGuid?: string; +} + +@doc("ContactBasic") +model ContactBasic { + @doc("Azure Active Directory object Id.") + id?: string; + + @doc("additional information to describe this contact.") + info?: string; +} + +@doc(""" +An instance of an entity along with extended info - like hive_table, +hive_database. +""") +model AtlasEntityExtInfo { + @doc("The referred entities.") + referredEntities?: Record; +} + +@doc("The mutation response of entity.") +model EntityMutationResponse { + @doc("A map of GUID assignments with entities.") + guidAssignments?: Record; + + @doc("The entity headers of mutated entities.") + mutatedEntities?: Record; + + @doc("An array of entity headers that partially updated.") + partialUpdatedEntities?: AtlasEntityHeader[]; +} + +@doc("An instance of an entity - like hive_table, hive_database.") +model AtlasEntityHeader { + ...AtlasStruct; + + @doc("An array of classification names.") + classificationNames?: string[]; + + @doc("An array of classifications.") + classifications?: AtlasClassification[]; + + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the record.") + guid?: string; + + @doc("Whether it is a shell entity") + isIncomplete?: boolean; + + @doc("labels") + labels?: string[]; + + @doc("An array of meanings.") + meaningNames?: string[]; + + @doc("An array of term assignment headers.") + meanings?: AtlasTermAssignmentHeader[]; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + status?: Status; +} + +@doc("An error response from the service") +@error +model ErrorResponse { + @doc("The request ID.") + requestId?: string; + + @doc("The error code.") + errorCode?: string; + + @doc("The error message.") + errorMessage?: string; +} + +@doc(""" +An instance of an entity along with extended info - like hive_table, +hive_database. +""") +model AtlasEntitiesWithExtInfo { + ...AtlasEntityExtInfo; + + @doc("An array of entities.") + entities?: AtlasEntity[]; +} + +@doc("The request for classification association.") +model ClassificationAssociateRequest { + @doc(""" +An instance of a classification; it doesn't have an identity, this object +exists only when associated with an entity. +""") + classification?: AtlasClassification; + + @doc("The GUID of the entity.") + entityGuids?: string[]; +} + +@doc("REST serialization friendly list.") +model AtlasClassifications { + ...PList; +} + +@doc("Paginated-list, for returning search results.") +model PList { + @doc("An array of objects.") + list?: unknown[]; + + @doc("The size of the page.") + pageSize?: int32; + + @doc("The sorted by field.") + sortBy?: string; + + @doc("to specify whether the result should be sorted? If yes, whether asc or desc.") + sortType?: SortType; + + @doc("The start index of the page.") + startIndex?: int32; + + @doc("The total count of items.") + totalCount?: int32; +} + +@doc("An instance of an entity header map.") +model AtlasEntityHeaders { + @doc("The description of the guid header map,") + guidHeaderMap?: Record; +} + +@doc("example") +model BulkImportResponse { + @doc("failed importInfoList") + failedImportInfoList?: ImportInfo[]; + + @doc("successful importInfoList") + successImportInfoList?: ImportInfo[]; +} + +@doc("ImportInfo") +model ImportInfo { + @doc("childObjectName") + childObjectName?: string; + + @doc("importStatus") + importStatus?: ImportStatus; + + @doc("parentObjectName") + parentObjectName?: string; + + @doc("remarks") + remarks?: string; +} + +model MoveEntitiesRequest { + @doc("An array of entity guids to be moved to target collection.") + entityGuids?: string[]; +} + +@doc("The glossary object.") +model AtlasGlossary { + ...AtlasGlossaryBaseObject; + + @doc("An array of categories.") + categories?: AtlasRelatedCategoryHeader[]; + + @doc("The language of the glossary.") + language?: string; + + @doc("An array of related term headers.") + terms?: AtlasRelatedTermHeader[]; + + @doc("The usage of the glossary.") + usage?: string; +} + +@doc("The header of the related category.") +model AtlasRelatedCategoryHeader { + @doc("The GUID of the category.") + categoryGuid?: string; + + @doc("The description of the category header.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the parent category.") + parentCategoryGuid?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; +} + +@doc("The header of the related term.") +model AtlasRelatedTermHeader { + @doc("The description of the related term.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The expression of the term.") + expression?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; + + @doc("The status of term relationship.") + status?: AtlasTermRelationshipStatus; + + @doc("The steward of the term.") + steward?: string; + + @doc("The GUID of the term.") + termGuid?: string; +} + +@doc("The glossary base object.") +model AtlasGlossaryBaseObject { + ...AtlasBaseModelObject; + + @doc("An array of classifications.") + classifications?: AtlasClassification[]; + + @doc("The long version description.") + longDescription?: string; + + @doc("The name of the glossary object.") + name?: string; + + @doc("The qualified name of the glossary object.") + qualifiedName?: string; + + @doc("The short version of description.") + shortDescription?: string; + + @doc("ETag for concurrency control.") + lastModifiedTS?: string; + + @doc("The created time of the record.") + createTime?: int32; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("The update time of the record.") + updateTime?: int32; + + @doc("The user who updated the record.") + updatedBy?: string; +} + +@doc("The base model object.") +model AtlasBaseModelObject { + @doc("The GUID of the object.") + guid?: string; +} + +@doc("The glossary category.") +model AtlasGlossaryCategory { + ...AtlasGlossaryBaseObject; + + @doc("The glossary header with basic information.") + anchor?: AtlasGlossaryHeader; + + @doc("An array of children categories.") + childrenCategories?: AtlasRelatedCategoryHeader[]; + + @doc("The header of the related category.") + parentCategory?: AtlasRelatedCategoryHeader; + + @doc("An array of related term headers.") + terms?: AtlasRelatedTermHeader[]; +} + +@doc("The glossary header with basic information.") +model AtlasGlossaryHeader { + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the glossary.") + glossaryGuid?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; +} + +@doc("The glossary term.") +model AtlasGlossaryTerm { + ...AtlasGlossaryBaseObject; + + @doc("The abbreviation of the term.") + abbreviation?: string; + templateName?: unknown[]; + + @doc("The glossary header with basic information.") + anchor?: AtlasGlossaryHeader; + + @doc("An array of related term headers as antonyms.") + antonyms?: AtlasRelatedTermHeader[]; + + @doc("Status of the AtlasGlossaryTerm") + status?: TermStatus; + + @doc("The nick name of the term.") + nickName?: string; + + @doc("The hierarchy information of the term.") + hierarchyInfo?: PurviewObjectId[]; + + @doc("An array of resource link for term") + resources?: ResourceLink[]; + + @doc("The dictionary of contacts for terms. Key could be Expert or Steward.") + contacts?: Record; + + @doc(""" +The custom attributes of the term, which is map>. +The +key of the first layer map is term template name. +""") + attributes?: Record>; + + @doc("An array of related object IDs.") + assignedEntities?: AtlasRelatedObjectId[]; + + @doc("An array of term categorization headers.") + categories?: AtlasTermCategorizationHeader[]; + + @doc("An array of related term headers.") + classifies?: AtlasRelatedTermHeader[]; + + @doc("An array of examples.") + examples?: string[]; + + @doc("An array of related term headers indicating the is-a relationship.") + isA?: AtlasRelatedTermHeader[]; + + @doc("An array of preferred related term headers.") + preferredTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers that are preferred to.") + preferredToTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers that are replaced by.") + replacedBy?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers for replacement.") + replacementTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers for see also.") + seeAlso?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers as synonyms.") + synonyms?: AtlasRelatedTermHeader[]; + + @doc("An array of translated related term headers.") + translatedTerms?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers for translation.") + translationTerms?: AtlasRelatedTermHeader[]; + + @doc("The usage of the term.") + usage?: string; + + @doc("An array of related term headers as valid values.") + validValues?: AtlasRelatedTermHeader[]; + + @doc("An array of related term headers as valid values for other records.") + validValuesFor?: AtlasRelatedTermHeader[]; +} + +@doc("PurviewObjectId") +model PurviewObjectId { + ...AtlasObjectId; + name?: string; + displayText?: string; + itemPath?: string; + resourceId?: string; + + @doc("Dictionary of ") + properties?: Record; +} + +@doc("Reference to an object-instance of a type - like entity.") +model AtlasObjectId { + @doc("The GUID of the object.") + guid?: string; + + @doc("The name of the type.") + typeName?: string; + + @doc("The unique attributes of the object.") + uniqueAttributes?: Record; +} + +@doc("ResourceLink") +model ResourceLink { + @doc("Display name for url.") + displayName?: string; + + @doc("web url. http or https") + url?: string; +} + +@doc(""" +Reference to an object-instance of AtlasEntity type used in relationship +attribute values +""") +model AtlasRelatedObjectId { + ...AtlasObjectId; + + @doc("The display text.") + displayText?: string; + + @doc(""" +Status of the entity - can be active or deleted. Deleted entities are not +removed. +""") + entityStatus?: Status; + relationshipType?: string; + + @doc(""" +Captures details of struct contents. Not instantiated directly, used only via +AtlasEntity, AtlasClassification. +""") + relationshipAttributes?: AtlasStruct; + + @doc("The GUID of the relationship.") + relationshipGuid?: string; + + @doc("The enum of relationship status.") + relationshipStatus?: StatusAtlasRelationship; +} + +@doc("The basic information for term categorization.") +model AtlasTermCategorizationHeader { + @doc("The GUID of the category.") + categoryGuid?: string; + + @doc("The description of the record.") + description?: string; + + @doc("The display text.") + displayText?: string; + + @doc("The GUID of the relationship.") + relationGuid?: string; + + @doc("The status of term relationship.") + status?: AtlasTermRelationshipStatus; +} + +@doc("The extended information of glossary.") +model AtlasGlossaryExtInfo { + ...AtlasGlossary; + + @doc("The glossary category information.") + categoryInfo?: Record; + + @doc("The glossary term information.") + termInfo?: Record; +} + +@doc("The search query of advanced search request.") +model SearchRequest { + @doc("The keywords applied to all searchable fields.") + keywords?: string; + + @doc(""" +The limit of the number of the search result. default value is 50; maximum +value is 1000. +""") + limit?: int32; + + @doc(""" +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. +""") + continuationToken?: string; + + @doc("The sort order of search results, can specify multiple fields.") + orderby?: unknown[]; + + @doc("The filter for the search. See examples for the usage of supported filters.") + filter?: unknown; + facets?: SearchFacetItem[]; + taxonomySetting?: SearchRequestTaxonomySetting; +} + +@doc("The content of a search facet result item.") +model SearchFacetItem { + @doc("The count of the facet item.") + count?: int32; + + @doc("The name of the facet item.") + facet?: string; + + @doc("Any object") + sort?: unknown; +} + +model SearchRequestTaxonomySetting { + assetTypes?: string[]; + + @doc("The content of a search facet result item.") + facet?: SearchFacetItem; +} + +@doc("The result of the search result.") +model SearchResult { + @doc(""" +The total number of search results (not the number of documents in a single +page). +""") + @projectedName("json", "@search.count") + SearchCount?: int32; + + @doc("'True' if the '@search.count' is an approximate value and vise versa.") + @projectedName("json", "@search.count.approximate") + SearchCountApproximate?: boolean; + + @doc("The token used to get next batch of data. Absent if there's no more data.") + continuationToken?: string; + + @doc(""" +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. +""") + @projectedName("json", "@search.facets") + SearchFacets?: SearchFacetResultValue; + value?: SearchResultValue[]; +} + +@doc(""" +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. +""") +model SearchFacetResultValue { + entityType?: SearchFacetItemValue[]; + assetType?: SearchFacetItemValue[]; + classification?: SearchFacetItemValue[]; + term?: SearchFacetItemValue[]; + contactId?: SearchFacetItemValue[]; + contactType?: SearchFacetItemValue[]; + label?: SearchFacetItemValue[]; + glossaryType?: SearchFacetItemValue[]; + termStatus?: SearchFacetItemValue[]; + termTemplate?: SearchFacetItemValue[]; +} + +@doc("The content of a search facet result item.") +model SearchFacetItemValue { + @doc("The count of the facet item.") + count?: int32; + + @doc("The name of the facet item.") + value?: string; +} + +@doc("The value item of the search result.") +model SearchResultValue { + @doc(""" +The search score calculated by the search engine. The results are ordered by +search score by default. +""") + @projectedName("json", "@search.score") + SearchScore?: float32; + + @doc(""" +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. +""") + @projectedName("json", "@search.highlights") + SearchHighlights?: SearchHighlights; + + @doc(""" +The object type of the record. Object type is the top-level property to +distinguish whether a record is an asset or a term. +""") + objectType?: string; + + @doc("The create time of the record. The Unix epoch format.") + createTime?: int32; + + @doc("The last update time of the record. The Unix epoch format.") + updateTime?: int32; + + @doc("The GUID of the record.") + id?: string; + + @doc("The name of the record.") + name?: string; + + @doc("The qualified name of the record.") + qualifiedName?: string; + + @doc("The type name of the asset.") + entityType?: string; + + @doc("The description of the asset.") + description?: string; + + @doc("The endorsement of the asset.") + endorsement?: string; + + @doc("The owner of the record.") + owner?: string; + + @doc("The classifications of the record.") + classification?: string[]; + + @doc("The labels of the asset.") + label?: string[]; + + @doc("The terms assigned to the asset.") + term?: TermSearchResultValue[]; + + @doc("The contacts of the asset.") + contact?: ContactSearchResultValue[]; + + @doc("The asset types of the asset.") + assetType?: string[]; + + @doc(""" +The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or +AtlasGlossaryCategory. +""") + glossaryType?: string; + + @doc("The glossary name of the term.") + glossary?: string; + + @doc("The status of the term.") + termStatus?: string; + + @doc("The term template names used by the term.") + termTemplate?: string[]; + + @doc("The definition of the term.") + longDescription?: string; +} + +@doc(""" +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. +""") +model SearchHighlights { + id?: string[]; + qualifiedName?: string[]; + name?: string[]; + description?: string[]; + entityType?: string[]; +} + +@doc("The context.") +model TermSearchResultValue { + @doc("The name of the term.") + name?: string; + + @doc("The name of the glossary which contains the term.") + glossaryName?: string; + + @doc("The GUID of the term.") + guid?: string; +} + +@doc("The contact in the search and suggest result.") +model ContactSearchResultValue { + @doc("The GUID of the contact.") + id?: string; + + @doc("The description of the contact.") + info?: string; + + @doc(""" +The type of the contact. It can be Expert or Owner for an entity. It can be +Expert or Steward for a glossary term. +""") + contactType?: string; +} + +@doc("The query of suggest request.") +model SuggestRequest { + @doc(""" +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. +""") + keywords?: string; + + @doc(""" +The number of suggestions we hope to return. The default value is 5. The value +must be a number between 1 and 100. +""") + limit?: int32; + + @doc("The filter for the search.") + filter?: unknown; +} + +@doc("The result item of the search suggest.") +model SuggestResult { + value?: SuggestResultValue[]; +} + +@doc("The value item of the search suggest.") +model SuggestResultValue { + @doc(""" +The search score calculated by the search engine. The results are ordered by +search score by default. +""") + @projectedName("json", "@search.score") + SearchScore?: float32; + + @doc(""" +The target text that contains the keyword as prefix. The keyword is wrapped +with emphasis mark. +""") + @projectedName("json", "@search.text") + SearchText?: string; + + @doc(""" +The object type of the record. Object type is the top-level property to +distinguish whether a record is an asset or a term. +""") + objectType?: string; + + @doc("The create time of the record. The Unix epoch format.") + createTime?: int32; + + @doc("The last update time of the record. The Unix epoch format.") + updateTime?: int32; + + @doc("The GUID of the record.") + id?: string; + + @doc("The name of the record.") + name?: string; + + @doc("The qualified name of the record.") + qualifiedName?: string; + + @doc("The type name of the asset.") + entityType?: string; + + @doc("The description of the asset.") + description?: string; + + @doc("The endorsement of the asset.") + endorsement?: string; + + @doc("The owner of the record.") + owner?: string; + + @doc("The classifications of the record.") + classification?: string[]; + + @doc("The labels of the asset.") + label?: string[]; + + @doc("The terms assigned to the asset.") + term?: TermSearchResultValue[]; + + @doc("The contacts of the asset.") + contact?: ContactSearchResultValue[]; + + @doc("The asset types of the asset.") + assetType?: string[]; + + @doc(""" +The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or +AtlasGlossaryCategory. +""") + glossaryType?: string; + + @doc("The glossary name of the term.") + glossary?: string; + + @doc("The status of the term.") + termStatus?: string; + + @doc("The term template names used by the term.") + termTemplate?: string[]; + + @doc("The definition of the term.") + longDescription?: string; +} + +@doc("The query of autocomplete request.") +model AutoCompleteRequest { + @doc(""" +The keywords applied to all fields that support autocomplete operation. It must +be at least 1 character, and no more than 100 characters. +""") + keywords?: string; + + @doc(""" +The number of autocomplete results we hope to return. The default value is 50. +The value must be a number between 1 and 100. +""") + limit?: int32; + + @doc("The filter for the autocomplete request.") + filter?: unknown; +} + +@doc("The result of the autocomplete request.") +model AutoCompleteResult { + value?: AutoCompleteResultValue[]; +} + +@doc("The value item of the autocomplete suggest.") +model AutoCompleteResultValue { + @doc("The completed term or phrase.") + text?: string; + + @doc("The completed search query text.") + queryPlusText?: string; +} + +@doc("The lineage information.") +model AtlasLineageInfo { + @doc("The GUID of the base entity.") + baseEntityGuid?: string; + + @doc("The GUID entity map.") + guidEntityMap?: Record; + + @doc("The entity count in specific direction.") + widthCounts?: Record>; + + @doc("The depth of lineage.") + lineageDepth?: int32; + + @doc("The width of lineage.") + lineageWidth?: int32; + + @doc("The number of children node.") + childrenCount?: int32; + + @doc("The enum of lineage direction.") + lineageDirection?: LineageDirection; + + @doc("An array of parentRelations relations.") + parentRelations?: ParentRelation[]; + + @doc("An array of lineage relations.") + relations?: LineageRelation[]; +} + +@doc("The lineage parents relation with GUID of the parent entity and to child entity.") +model ParentRelation { + @doc("The GUID of child entity.") + childEntityId?: string; + + @doc("The GUID of relationship.") + relationshipId?: string; + + @doc("The GUID of parent entity.") + parentEntityId?: string; +} + +@doc("The lineage relation with GUID of the from and to entity.") +model LineageRelation { + @doc("The GUID of from-entity.") + fromEntityId?: string; + + @doc("The GUID of relationship.") + relationshipId?: string; + + @doc("The GUID of to-entity.") + toEntityId?: string; +} + +@doc("Atlas relationship instance.") +model AtlasRelationship { + ...AtlasStruct; + + @doc("The created time of the record.") + createTime?: int32; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("Reference to an object-instance of a type - like entity.") + end1?: AtlasObjectId; + + @doc("Reference to an object-instance of a type - like entity.") + end2?: AtlasObjectId; + + @doc("The GUID of the relationship.") + guid?: string; + + @doc("The home ID of the relationship.") + homeId?: string; + + @doc("The label of the relationship.") + label?: string; + + @doc("Used to record the provenance of an instance of an entity or relationship") + provenanceType?: float32; + + @doc("The enum of relationship status.") + status?: StatusAtlasRelationship; + + @doc("The update time of the record.") + updateTime?: int32; + + @doc("The user who updated the record.") + updatedBy?: string; + + @doc("The version of the relationship.") + version?: float32; +} + +@doc("The relationship with extended information.") +model AtlasRelationshipWithExtInfo { + @doc("The referred entity header.") + referredEntities?: Record; + + @doc("Atlas relationship instance.") + relationship?: AtlasRelationship; +} + +@doc("class that captures details of a struct-type.") +model AtlasBusinessMetadataDef { + ...AtlasStructDef; +} + +@doc("class that captures details of a struct-type.") +model AtlasStructDef { + ...AtlasBaseTypeDef; + + @doc("An array of attribute definitions.") + attributeDefs?: AtlasAttributeDef[]; +} + +@doc("class that captures details of a struct-attribute.") +model AtlasAttributeDef { + @doc("single-valued attribute or multi-valued attribute.") + cardinality?: Cardinality; + + @doc("An array of constraints.") + constraints?: AtlasConstraintDef[]; + + @doc("The default value of the attribute.") + defaultValue?: string; + + @doc("The description of the attribute.") + description?: string; + + @doc("Determines if it is included in notification.") + includeInNotification?: boolean; + + @doc("Determines if it is indexable.") + isIndexable?: boolean; + + @doc("Determines if it is optional.") + isOptional?: boolean; + + @doc("Determines if it unique.") + isUnique?: boolean; + + @doc("The name of the attribute.") + name?: string; + + @doc("The options for the attribute.") + options?: Record; + + @doc("The name of the type.") + typeName?: string; + + @doc("The maximum count of the values.") + valuesMaxCount?: int32; + + @doc("The minimum count of the values.") + valuesMinCount?: int32; +} + +@doc("class that captures details of a constraint.") +model AtlasConstraintDef { + @doc("The parameters of the constraint definition.") + params?: Record; + + @doc("The type of the constraint.") + type?: string; +} + +@doc("Base class that captures common-attributes for all types.") +model AtlasBaseTypeDef { + @doc("The enum of type category.") + category?: TypeCategory; + + @doc("The created time of the record.") + createTime?: int32; + + @doc("The user who created the record.") + createdBy?: string; + + @doc("The date format.") + dateFormatter?: DateFormat; + + @doc("The description of the type definition.") + description?: string; + + @doc("The GUID of the type definition.") + guid?: string; + + @doc("The name of the type definition.") + name?: string; + + @doc("The options for the type definition.") + options?: Record; + + @doc("The service type.") + serviceType?: string; + + @doc("The version of the type.") + typeVersion?: string; + + @doc("The update time of the record.") + updateTime?: int32; + + @doc("The user who updated the record.") + updatedBy?: string; + + @doc("The version of the record.") + version?: float32; + + @doc("ETag for concurrency control.") + lastModifiedTS?: string; +} + +@doc("The date format.") +model DateFormat { + @doc("An array of available locales.") + availableLocales?: string[]; + calendar?: float32; + + @doc("The date format.") + dateInstance?: DateFormat; + + @doc("The date format.") + dateTimeInstance?: DateFormat; + + @doc("The date format.") + instance?: DateFormat; + + @doc("Determines the leniency of the date format.") + lenient?: boolean; + + @doc("The number format.") + numberFormat?: NumberFormat; + + @doc("The date format.") + timeInstance?: DateFormat; + + @doc("The timezone information.") + timeZone?: TimeZone; +} + +@doc("The number format.") +model NumberFormat { + @doc("The number format.") + availableLocales?: string[]; + + @doc("The currency.") + currency?: string; + + @doc("The number format.") + currencyInstance?: NumberFormat; + + @doc("Determines if grouping is used.") + groupingUsed?: boolean; + + @doc("The number format.") + instance?: NumberFormat; + + @doc("The number format.") + integerInstance?: NumberFormat; + + @doc("The maximum of fraction digits.") + maximumFractionDigits?: int32; + + @doc("The maximum of integer digits.") + maximumIntegerDigits?: int32; + + @doc("The minimum of fraction digits.") + minimumFractionDigits?: int32; + + @doc("The minimum of integer digits.") + minimumIntegerDigits?: int32; + + @doc("The number format.") + numberInstance?: NumberFormat; + + @doc("Determines if only integer is parsed.") + parseIntegerOnly?: boolean; + + @doc("The number format.") + percentInstance?: NumberFormat; + + @doc("The enum of rounding mode.") + roundingMode?: RoundingMode; +} + +@doc("The timezone information.") +model TimeZone { + @doc("The value of the daylight saving time.") + dstSavings?: int32; + + @doc("The ID of the timezone.") + id?: string; + + @doc("An array of available IDs.") + availableIds?: string[]; + + @doc("The timezone information.") + default?: TimeZone; + + @doc("The display name of the timezone.") + displayName?: string; + + @doc("The raw offset of the timezone.") + rawOffset?: int32; +} + +@doc("class that captures details of a classification-type.") +model AtlasClassificationDef { + ...AtlasStructDef; + + @doc(""" +Specifying a list of entityType names in the classificationDef, ensures that +classifications can +only be applied to those entityTypes. +
    +
  • Any subtypes +of the entity types inherit the restriction
    • +
  • Any classificationDef +subtypes inherit the parents entityTypes restrictions
    • +
  • Any +classificationDef subtypes can further restrict the parents entityTypes +restrictions by specifying a subset of the entityTypes
    • +
  • An empty +entityTypes list when there are no parent restrictions means there are no +restrictions
    • +
  • An empty entityTypes list when there are parent +restrictions means that the subtype picks up the parents +restrictions
    • +
  • If a list of entityTypes are supplied, where one inherits +from another, this will be rejected. This should encourage cleaner +classificationsDefs
    • +
+""") + entityTypes?: string[]; + + @doc("An array of sub types.") + subTypes?: string[]; + + @doc("An array of super types.") + superTypes?: string[]; +} + +@doc("class that captures details of a entity-type.") +model AtlasEntityDef { + ...AtlasStructDef; + + @doc("An array of sub types.") + subTypes?: string[]; + + @doc("An array of super types.") + superTypes?: string[]; + + @doc("An array of relationship attributes.") + relationshipAttributeDefs?: AtlasRelationshipAttributeDef[]; +} + +@doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") +model AtlasRelationshipAttributeDef { + ...AtlasAttributeDef; + + @doc("Determines if it is a legacy attribute.") + isLegacyAttribute?: boolean; + + @doc("The name of the relationship type.") + relationshipTypeName?: string; +} + +@doc("class that captures details of an enum-type.") +model AtlasEnumDef { + ...AtlasBaseTypeDef; + + @doc("The default value.") + defaultValue?: string; + + @doc("An array of enum element definitions.") + elementDefs?: AtlasEnumElementDef[]; +} + +@doc("class that captures details of an enum-element.") +model AtlasEnumElementDef { + @doc("The description of the enum element definition.") + description?: string; + + @doc("The ordinal of the enum element definition.") + ordinal?: float32; + + @doc("The value of the enum element definition.") + value?: string; +} + +@doc(""" +AtlasRelationshipDef is a TypeDef that defines a relationship. +

+As with +other typeDefs the AtlasRelationshipDef has a name. Once created the +RelationshipDef has a guid. +The name and the guid are the 2 ways that the +RelationshipDef is identified. +

+RelationshipDefs have 2 ends, each of which +specify cardinality, an EntityDef type name and name and optionally +whether the +end is a container. +

+RelationshipDefs can have AttributeDefs - though only +primitive types are allowed.
+RelationshipDefs have a relationshipCategory +specifying the UML type of relationship required
+The way EntityDefs and +RelationshipDefs are intended to be used is that EntityDefs will define +AttributeDefs these AttributeDefs +will not specify an EntityDef type name as +their types. +

+RelationshipDefs introduce new attributes to the entity +instances. For example +

+EntityDef A might have attributes attr1,attr2,attr3 +
+EntityDef B might have attributes attr4,attr5,attr6
+RelationshipDef +AtoB might define 2 ends
+ +

+   end1:  type A, name attr7
+   end2: 
+type B, name attr8
+ +

+When an instance of EntityDef A is created, it +will have attributes attr1,attr2,attr3,attr7
+When an instance of EntityDef +B is created, it will have attributes attr4,attr5,attr6,attr8 +

+In this way +relationshipDefs can be authored separately from entityDefs and can inject +relationship attributes into +the entity instances +""") +model AtlasRelationshipDef { + ...AtlasStructDef; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef1?: AtlasRelationshipEndDef; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef2?: AtlasRelationshipEndDef; + + @doc(""" +The Relationship category determines the style of relationship around +containment and lifecycle. +UML terminology is used for the +values. +

+ASSOCIATION is a relationship with no containment.
+COMPOSITION +and AGGREGATION are containment relationships. +

+The difference being in the +lifecycles of the container and its children. In the COMPOSITION case, +the +children cannot exist without the container. For AGGREGATION, the life +cycles +of the container and children are totally independent. +""") + relationshipCategory?: RelationshipCategory; + + @doc("The label of the relationship.") + relationshipLabel?: string; +} + +@doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") +model AtlasRelationshipEndDef { + @doc("single-valued attribute or multi-valued attribute.") + cardinality?: Cardinality; + + @doc("The description of the relationship end definition.") + description?: string; + + @doc("Determines if it is container.") + isContainer?: boolean; + + @doc("Determines if it is a legacy attribute.") + isLegacyAttribute?: boolean; + + @doc("The name of the relationship end definition.") + name?: string; + + @doc("The type of the relationship end.") + type?: string; +} + +@doc("The definitions of type.") +model AtlasTypeDef { + ...AtlasBaseTypeDef; + ...AtlasExtraTypeDef; +} + +@doc("Extra properties for a type.") +model AtlasExtraTypeDef { + @doc(""" +Specifying a list of entityType names in the classificationDef, ensures that +classifications can +only be applied to those entityTypes. +

    +
  • Any subtypes +of the entity types inherit the restriction
    • +
  • Any classificationDef +subtypes inherit the parents entityTypes restrictions
    • +
  • Any +classificationDef subtypes can further restrict the parents entityTypes +restrictions by specifying a subset of the entityTypes
    • +
  • An empty +entityTypes list when there are no parent restrictions means there are no +restrictions
    • +
  • An empty entityTypes list when there are parent +restrictions means that the subtype picks up the parents +restrictions
    • +
  • If a list of entityTypes are supplied, where one inherits +from another, this will be rejected. This should encourage cleaner +classificationsDefs
    • +
+""") + entityTypes?: string[]; + + @doc("An array of sub types.") + subTypes?: string[]; + + @doc("An array of super types.") + superTypes?: string[]; + + @doc("An array of relationship attributes.") + relationshipAttributeDefs?: AtlasRelationshipAttributeDef[]; + + @doc("The default value.") + defaultValue?: string; + + @doc("An array of enum element definitions.") + elementDefs?: AtlasEnumElementDef[]; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef1?: AtlasRelationshipEndDef; + + @doc(""" +The relationshipEndDef represents an end of the relationship. The end of the +relationship is defined by a type, an +attribute name, cardinality and whether +it is the container end of the relationship. +""") + endDef2?: AtlasRelationshipEndDef; + + @doc(""" +The Relationship category determines the style of relationship around +containment and lifecycle. +UML terminology is used for the +values. +

+ASSOCIATION is a relationship with no containment.
+COMPOSITION +and AGGREGATION are containment relationships. +

+The difference being in the +lifecycles of the container and its children. In the COMPOSITION case, +the +children cannot exist without the container. For AGGREGATION, the life +cycles +of the container and children are totally independent. +""") + relationshipCategory?: RelationshipCategory; + + @doc("The label of the relationship.") + relationshipLabel?: string; + + @doc("An array of attribute definitions.") + attributeDefs?: AtlasAttributeDef[]; +} + +@doc("The definitions of types.") +model AtlasTypesDef { + @doc("businessMetadataDefs") + businessMetadataDefs?: AtlasBusinessMetadataDef[]; + + @doc("An array of classification definitions.") + classificationDefs?: AtlasClassificationDef[]; + + @doc("An array of entity definitions.") + entityDefs?: AtlasEntityDef[]; + + @doc("An array of enum definitions.") + enumDefs?: AtlasEnumDef[]; + + @doc("An array of relationship definitions.") + relationshipDefs?: AtlasRelationshipDef[]; + + @doc("An array of struct definitions.") + structDefs?: AtlasStructDef[]; + + @doc("An array of term template definitions.") + termTemplateDefs?: TermTemplateDef[]; +} + +@doc("term template definition for glossary term.") +model TermTemplateDef { + ...AtlasStructDef; +} + +@doc("The basic information of the type definition.") +model AtlasTypeDefHeader { + @doc("The enum of type category.") + category?: TypeCategory; + + @doc("The GUID of the type definition.") + guid?: string; + + @doc("The name of the type definition.") + name?: string; +} + +model PathsEsavagAtlasV2EntityBusinessmetadataImportPostRequestbodyContentMultipartFormDataSchema { + @doc("InputStream of file") + uploadedInputStream?: bytes; +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp new file mode 100644 index 000000000000..fe17a5563357 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -0,0 +1,1868 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; + +namespace PurviewDataMap; + +interface EntityOperations { + @doc(""" +Create or update an entity. +Existing entity is matched using its unique guid if +supplied or by its unique attributes eg: qualifiedName. +Map and array of +collections are not well supported. E.g., array>, array>. +For each contact type, the maximum number of contacts is 20. +""") + @route("/atlas/v2/entity") + @post + createOrUpdate is Azure.Core.Foundations.Operation< + { + @doc(""" +Used to define the update behavior for business attributes when updating +entities. +""") + @query + businessAttributeUpdateBehavior: BusinessAttributeUpdateBehavior; + + @doc(""" +The collection where entities will be moved to. Only specify a value if you +need to move an entity to another collection. +""") + @query + collectionId: string; + + @doc("Atlas entity with extended information.") + @body + entity: AtlasEntityWithExtInfo; + }, + EntityMutationResponse + >; + + @doc("List entities in bulk identified by its GUIDs.") + @route("/atlas/v2/entity/bulk") + @get + listByGuids is Azure.Core.Foundations.Operation< + { + @doc("An array of GUIDs of entities to list.") + @query({format: "multi"}) + guid: string[]; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships: boolean; + }, + AtlasEntitiesWithExtInfo + >; + + @doc(""" +Create or update entities in bulk. +Existing entity is matched using its unique +guid if supplied or by its unique attributes eg: qualifiedName. +Map and array +of collections are not well supported. E.g., array>, +array>. +For each contact type, the maximum number of contacts +is 20. +""") + @route("/atlas/v2/entity/bulk") + @post + bulkCreateOrUpdate is Azure.Core.Foundations.Operation< + { + @doc(""" +The collection where entities will be moved to. Only specify a value if you +need to move an entity to another collection. +""") + @query + collectionId: string; + + @doc(""" +Used to define the update behavior for business attributes when updating +entities. +""") + @query + businessAttributeUpdateBehavior: BusinessAttributeUpdateBehavior; + + @doc("An array of entities to create or update.") + @body + entities: AtlasEntitiesWithExtInfo; + }, + EntityMutationResponse + >; + + @doc(""" +Delete a list of entities in bulk identified by their GUIDs or unique +attributes. +""") + @route("/atlas/v2/entity/bulk") + @delete + bulkDelete is Azure.Core.Foundations.Operation< + { + @doc("An array of GUIDs of entities to delete.") + @query({format: "multi"}) + guid: string[]; + }, + EntityMutationResponse + >; + + @doc("Associate a classification to multiple entities in bulk.") + @route("/atlas/v2/entity/bulk/classification") + @post + addClassification is Azure.Core.Foundations.Operation< + { + @doc("The request to associate a classification to multiple entities.") + @body + request: ClassificationAssociateRequest; + }, + void + >; + + @doc("Get complete definition of an entity given its GUID.") + @route("/atlas/v2/entity/guid/{guid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships: boolean; + }, + AtlasEntityWithExtInfo + >; + + @doc(""" +Update entity partially - create or update entity attribute identified by its +GUID. +Supports only primitive attribute type and entity references. +It does not +support updating complex types like arrays, and maps. +Null updates are not +possible. +""") + @route("/atlas/v2/entity/guid/{guid}") + @put + partialUpdateAttributeByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the attribute.") + @query + name: string; + + @doc("The value of the attribute.") + @body + body: unknown; + }, + EntityMutationResponse + >; + + @doc("Delete an entity identified by its GUID.") + @route("/atlas/v2/entity/guid/{guid}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + EntityMutationResponse + >; + + @doc("Get classification for a given entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") + @get + getClassification is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the classification.") + @path + classificationName: string; + }, + AtlasClassification + >; + + @doc("Delete a given classification from an existing entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") + @delete + removeClassification is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the classification.") + @path + classificationName: string; + }, + void + >; + + @doc("List classifications for a given entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @get + getClassifications is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasClassifications + >; + + @doc("Add classifications to an existing entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @post + addClassifications is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("An array of classifications to be added.") + @body + classifications: AtlasClassification[]; + }, + void + >; + + @doc("Update classifications to an existing entity represented by a guid.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @put + updateClassifications is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("An array of classifications to be updated.") + @body + classifications: AtlasClassification[]; + }, + void + >; + + @doc(""" +Get complete definition of an entity given its type and unique attribute. + +In +addition to the typeName path parameter, attribute key-value pair(s) can be +provided in the following format: +attr:\\=. + +NOTE: The +attrName and attrValue should be unique across entities, eg. +qualifiedName. + +The REST request would look something like this: +GET +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @get + getByUniqueAttributes is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships: boolean; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + }, + AtlasEntityWithExtInfo + >; + + @doc(""" +Update entity partially - Allow a subset of attributes to be updated on an +entity which is identified by its type and unique attribute eg: +Referenceable.qualifiedName. Null updates are not possible. + +In addition to the +typeName path parameter, attribute key-value pair(s) can be provided in the +following format: + +attr:=. +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: +PUT +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @put + partialUpdateByUniqueAttributes is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + + @doc("Atlas entity with extended information.") + @body + atlasEntityWithExtInfo: AtlasEntityWithExtInfo; + }, + EntityMutationResponse + >; + + @doc(""" +Delete an entity identified by its type and unique attributes. +In addition to +the typeName path parameter, attribute key-value pair(s) can be provided in the +following format: +attr:\\=\\. +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: +DELETE +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @delete + deleteByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + }, + EntityMutationResponse + >; + + @doc(""" +Delete a given classification from an entity identified by its type and unique +attributes. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") + @delete + removeClassificationByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("The name of the classification.") + @path + classificationName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + }, + void + >; + + @doc("Add classification to the entity identified by its type and unique attributes.") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") + @post + addClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + + @doc("An array of classification to be added.") + @body + atlasClassificationArray: AtlasClassification[]; + }, + void + >; + + @doc("Update classification on an entity identified by its type and unique attributes.") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") + @put + updateClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + + @doc("An array of classification to be updated.") + @body + atlasClassificationArray: AtlasClassification[]; + }, + void + >; + + @doc("Set classifications on entities in bulk.") + @route("/atlas/v2/entity/bulk/setClassifications") + @post + bulkSetClassifications is Azure.Core.Foundations.Operation< + { + @doc("Atlas entity headers.") + @body + entityHeaders: AtlasEntityHeaders; + }, + void + >; + + @doc(""" +Bulk API to retrieve list of entities identified by its unique attributes. +In +addition to the typeName path parameter, attribute key-value pair(s) can be +provided in the following +format + +typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\ + +NOTE: +The attrName should be an unique attribute for the given entity-type. +The REST +request would look something like this + +GET +/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + +Note: +at least one unique attribute must be provided. +""") + @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") + @get + listByUniqueAttributes is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships: boolean; + + @doc(""" +Qualified name of an entity. E.g. to find 2 entities you can set +attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an +example. qualifiedName can be changed to other unique attributes) +""") + @query + `attr_N:qualifiedName`: string; + }, + AtlasEntitiesWithExtInfo + >; + + @doc("Get entity header given its GUID.") + @route("/atlas/v2/entity/guid/{guid}/header") + @get + getHeader is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasEntityHeader + >; + + @doc("Remove business metadata from an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata") + @delete + removeBusinessMetadata is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + @body businessMetadata: Record; + }, + void + >; + + @doc("Add business metadata to an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata") + @post + addOrUpdateBusinessMetadata is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc(""" +Whether to overwrite the existing business metadata on the entity or not, +default is false. +""") + @query + isOverwrite: boolean; + @body businessMetadata: Record; + }, + void + >; + + @doc("Delete business metadata attributes from an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") + @delete + removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + { + @doc("BusinessMetadata name") + @path + bmName: string; + + @doc("The globally unique identifier of the entity.") + @path + guid: string; + @body businessMetadataAttributes: Record; + }, + void + >; + + @doc("Add or update business metadata attributes.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") + @post + addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + { + @doc("BusinessMetadata name") + @path + bmName: string; + + @doc("The globally unique identifier of the entity.") + @path + guid: string; + @body businessMetadataAttributes: Record; + }, + void + >; + + @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") + @route("/atlas/v2/entity/businessmetadata/import/template") + @get + getSampleBusinessMetadataTemplate is Azure.Core.Foundations.Operation< + { + @doc("Accept header") + @header + Accept: "application/octet-stream"; + }, + void + >; + + @doc("Upload the file for creating Business Metadata in BULK") + @route("/atlas/v2/entity/businessmetadata/import") + @post + importBusinessMetadata is Azure.Core.Foundations.Operation< + { + @doc("InputStream of file") + @body + uploadedInputStream: bytes; + }, + BulkImportResponse + >; + + @doc("Delete given labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @delete + removeLabels is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be deleted") + @body + body: string[]; + }, + void + >; + + @doc("Set labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @post + setLabels is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be set to the entity") + @body + body: string[]; + }, + void + >; + + @doc("Add given labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @put + addLabel is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be added") + @body + body: string[]; + }, + void + >; + + @doc(""" +Delete given labels to a given entity identified by its type and unique +attribute. + +If labels is null/empty, no labels will be removed. + +If any labels +in labels set are non-existing labels, they will be ignored, only existing +labels will be removed. In addition to the typeName path parameter, attribute +key-value pair(s) can be provided in the following format: +attr:=. NOTE: The attrName and attrValue should be unique +across entities, eg. qualifiedName. The REST request would look something like +this: DELETE +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @delete + removeLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + + @doc("set of labels to be deleted") + @body + body: string[]; + }, + void + >; + + @doc(""" +Set labels to a given entity identified by its type and unique attributes. + +If +labels is null/empty, existing labels will all be removed. + +In addition to the +typeName path parameter, attribute key-value pair(s) can be provided in the +following format: attr:=. + +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: POST +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @post + setLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + + @doc("set of labels to be set") + @body + body: string[]; + }, + void + >; + + @doc(""" +Add given labels to a given entity identified by its type and unique +attributes. + +If labels is null/empty, no labels will be added. + +In addition to +the typeName path parameter, attribute key-value pair(s) can be provided in the +following format: attr:=. + +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: PUT +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @put + addLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + + @doc("set of labels to be added") + @body + body: string[]; + }, + void + >; + + @doc("Move existing entities to the target collection.") + @route("/entity/moveTo") + @post + moveEntitiesToCollection is Azure.Core.Foundations.Operation< + { + @doc("The collection where entities will be moved to.") + @query + collectionId: string; + + @doc("Entity guids to be moved to target collection.") + @body + moveEntitiesRequest: MoveEntitiesRequest; + }, + EntityMutationResponse + >; +} + +interface GlossaryOperations { + @doc(""" +Get all glossaries. Recommend using limit/offset to get pagination result. +Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories +separately using + + 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' +and + + 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'. +""") + @route("/atlas/v2/glossary") + @get + list is Azure.Core.Foundations.Operation< + { + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories: boolean; + }, + void + >; + + @doc("Create a glossary.") + @route("/atlas/v2/glossary") + @post + create is Azure.Core.Foundations.Operation< + { + @doc(""" +Glossary definition, terms & categories can be anchored to a glossary. +Using +the anchor attribute when creating the Term/Category. +""") + @body + atlasGlossary: AtlasGlossary; + }, + AtlasGlossary + >; + + @doc("Create glossary category in bulk.") + @route("/atlas/v2/glossary/categories") + @post + createCategories is Azure.Core.Foundations.Operation< + { + @doc("An array of glossary category definitions to be created.") + @body + glossaryCategory: AtlasGlossaryCategory[]; + }, + void + >; + + @doc("Create a glossary category.") + @route("/atlas/v2/glossary/category") + @post + createCategory is Azure.Core.Foundations.Operation< + { + @doc(""" +The glossary category definition. A category must be anchored to a Glossary +when creating. +Optionally, terms belonging to the category and the hierarchy +can also be defined during creation. +""") + @body + glossaryCategory: AtlasGlossaryCategory; + }, + AtlasGlossaryCategory + >; + + @doc("Get specific glossary category by its GUID.") + @route("/atlas/v2/glossary/category/{categoryGuid}") + @get + getCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + }, + AtlasGlossaryCategory + >; + + @doc("Update the given glossary category by its GUID.") + @route("/atlas/v2/glossary/category/{categoryGuid}") + @put + updateCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc("The glossary category to be updated.") + @body + glossaryCategory: AtlasGlossaryCategory; + }, + AtlasGlossaryCategory + >; + + @doc("Delete a glossary category.") + @route("/atlas/v2/glossary/category/{categoryGuid}") + @delete + deleteCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + }, + void + >; + + @doc(""" +Update the glossary category partially. So far we only supports partial +updating shortDescription and longDescription for category. +""") + @route("/atlas/v2/glossary/category/{categoryGuid}/partial") + @put + partialUpdateCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values for partial update. +""") + @body + partialUpdates: unknown; + }, + AtlasGlossaryCategory + >; + + @doc(""" +Get all related categories (parent and children). Limit, offset, and sort +parameters are currently not being enabled and won't work even they are passed. +""") + @route("/atlas/v2/glossary/category/{categoryGuid}/related") + @get + listRelatedCategories is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc("Get all terms associated with the specific category.") + @route("/atlas/v2/glossary/category/{categoryGuid}/terms") + @get + listCategoryTerms is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc("Create a glossary term.") + @route("/atlas/v2/glossary/term") + @post + createTerm is Azure.Core.Foundations.Operation< + { + @doc("Whether include term hierarchy") + @query + includeTermHierarchy: boolean; + + @doc(""" +The glossary term definition. A term must be anchored to a Glossary at the time +of creation. +Optionally it can be categorized as well. +""") + @body + glossaryTerm: AtlasGlossaryTerm; + }, + AtlasGlossaryTerm + >; + + @doc("Get a specific glossary term by its GUID. ") + @route("/atlas/v2/glossary/term/{termGuid}") + @get + getTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + }, + AtlasGlossaryTerm + >; + + @doc("Update the given glossary term by its GUID.") + @route("/atlas/v2/glossary/term/{termGuid}") + @put + updateTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("Whether include term hierarchy") + @query + includeTermHierarchy: boolean; + + @doc("The glossary term to be updated.") + @body + glossaryTerm: AtlasGlossaryTerm; + }, + AtlasGlossaryTerm + >; + + @doc("Delete a glossary term.") + @route("/atlas/v2/glossary/term/{termGuid}") + @delete + deleteTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + }, + void + >; + + @doc(""" +Update the glossary term partially. So far we only supports partial updating +shortDescription, longDescription, abbreviation, usage and status for term. +""") + @route("/atlas/v2/glossary/term/{termGuid}/partial") + @put + partialUpdateTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("Whether include term hierarchy") + @query + includeTermHierarchy: boolean; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values to be updated. +""") + @body + partialUpdates: unknown; + }, + AtlasGlossaryTerm + >; + + @doc("Create glossary terms in bulk.") + @route("/atlas/v2/glossary/terms") + @post + createTerms is Azure.Core.Foundations.Operation< + { + @doc("Whether include term hierarchy") + @query + includeTermHierarchy: boolean; + + @doc("An array of glossary term definitions to be created in bulk.") + @body + glossaryTerm: AtlasGlossaryTerm[]; + }, + void + >; + + @doc(""" +List all related objects assigned with the specified term. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @get + listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc(""" +Assign the given term to the provided list of related objects. Recommend using +small batches with multiple API calls. + +[Entities Create Or Update +operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) +is an alternative to assign a term to multiple entities. +""") + @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @post + assignTermToEntities is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("An array of related object IDs to which the term has to be associated.") + @body + relatedObjectIds: AtlasRelatedObjectId[]; + }, + void + >; + + @doc("Delete the term assignment for the given list of related objects.") + @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @delete + deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("An array of related object IDs from which the term has to be dissociated.") + @body + relatedObjectIds: AtlasRelatedObjectId[]; + }, + void + >; + + @doc(""" +Get all related terms for a specific term by its GUID. Limit, offset, and sort +parameters are currently not being enabled and won't work even they are passed. +""") + @route("/atlas/v2/glossary/terms/{termGuid}/related") + @get + listRelatedTerms is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc("Get a specific Glossary by its GUID.") + @route("/atlas/v2/glossary/{glossaryGuid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + }, + AtlasGlossary + >; + + @doc("Update the given glossary.") + @route("/atlas/v2/glossary/{glossaryGuid}") + @put + update is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories: boolean; + + @doc("The glossary definition to be updated.") + @body + updatedGlossary: AtlasGlossary; + }, + AtlasGlossary + >; + + @doc(""" +Delete a glossary. Will delete underlying terms/categories together. Recommend +separate delete terms and categories. +""") + @route("/atlas/v2/glossary/{glossaryGuid}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + }, + void + >; + + @doc(""" +Get the categories belonging to a specific glossary. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/categories") + @get + listCategories is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc(""" +Get the category headers belonging to a specific glossary. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") + @get + listCategoriesHeaders is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc(""" +Get a specific glossary with detailed information. This API is not +recommend. + +Recommend to fetch terms/categories details separately using + + +'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and + + 'GET +'/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/detailed") + @get + getDetailed is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + }, + AtlasGlossaryExtInfo + >; + + @doc(""" +Update the glossary partially. Some properties such as qualifiedName are not +allowed to be updated. + +So far we only supports partial updating +shortDescription, longDescription, language and usage for glossary. + +Recommend +using 'ignoreTermsAndCategories=true' to reduce response body size. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/partial") + @put + partialUpdate is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories: boolean; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values. +""") + @body + partialUpdates: unknown; + }, + AtlasGlossary + >; + + @doc(""" +Get terms belonging to a specific glossary. Recommend using limit/offset to get +pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/terms") + @get + listTerms is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; + + @doc(""" +Get term headers belonging to a specific glossary. Recommend using limit/offset +to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") + @get + listTermHeaders is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort: string; + }, + void + >; +} + +interface DiscoveryOperations { + @doc("Get data using search.") + @route("/search/query") + @post + query is Azure.Core.Foundations.Operation< + { + @doc("An object specifying the search criteria.") + @body + searchRequest: SearchRequest; + }, + SearchResult + >; + + @doc("Get search suggestions by query criteria.") + @route("/search/suggest") + @post + suggest is Azure.Core.Foundations.Operation< + { + @doc("An object specifying the suggest criteria.") + @body + suggestRequest: SuggestRequest; + }, + SuggestResult + >; + + @doc("Get auto complete options.") + @route("/search/autocomplete") + @post + autoComplete is Azure.Core.Foundations.Operation< + { + @doc("An object specifying the autocomplete criteria.") + @body + autoCompleteRequest: AutoCompleteRequest; + }, + AutoCompleteResult + >; +} + +interface LineageOperations { + @doc("Get lineage info of the entity specified by GUID.") + @route("/atlas/v2/lineage/{guid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The number of hops for lineage.") + @query + depth: int32; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: Direction; + }, + AtlasLineageInfo + >; + + @doc("Return immediate next page lineage info about entity with pagination") + @route("/lineage/{guid}/next/") + @get + getNextPage is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: Direction; + + @doc("The offset for pagination purpose.") + @query + offset: int32; + + @doc("The page size - by default there is no paging.") + @query + limit: int32; + }, + AtlasLineageInfo + >; + + @doc(""" +Return lineage info about entity. + +In addition to the typeName path parameter, +attribute key-value pair(s) can be provided in the following +format + +attr:[attrName]=[attrValue] + +NOTE: The attrName and attrValue should be +unique across entities, eg. qualifiedName. + +The REST request would look +something like this: + +GET +/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") + @get + getByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("The number of hops for lineage.") + @query + depth: int32; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: Direction; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query + `attr:qualifiedName`: string; + }, + AtlasLineageInfo + >; +} + +interface RelationshipOperations { + @doc("Create a new relationship between entities.") + @route("/atlas/v2/relationship") + @post + create is Azure.Core.Foundations.Operation< + { + @doc(""" +The AtlasRelationship object containing the information for the relationship to +be created. +""") + @body + relationship: AtlasRelationship; + }, + AtlasRelationship + >; + + @doc("Update an existing relationship between entities.") + @route("/atlas/v2/relationship") + @put + update is Azure.Core.Foundations.Operation< + { + @doc(""" +The AtlasRelationship object containing the information for the relationship to +be created. +""") + @body + relationship: AtlasRelationship; + }, + AtlasRelationship + >; + + @doc("Get relationship information between entities by its GUID.") + @route("/atlas/v2/relationship/guid/{guid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + + @doc("Limits whether includes extended information.") + @query + extendedInfo: boolean; + }, + AtlasRelationshipWithExtInfo + >; + + @doc("Delete a relationship between entities by its GUID.") + @route("/atlas/v2/relationship/guid/{guid}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + }, + void + >; +} + +interface TypeOperations { + @doc("Get the businessMetadata definition for the given guid.") + @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") + @get + getBusinessMetadataDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("businessMetadata guid") + @path + guid: string; + }, + AtlasBusinessMetadataDef + >; + + @doc("Get the businessMetadata definition by it's name (unique).") + @route("/atlas/v2/types/businessmetadatadef/name/{name}") + @get + getBusinessMetadataDefByName is Azure.Core.Foundations.Operation< + { + @doc("businessMetadata name") + @path + name: string; + }, + AtlasBusinessMetadataDef + >; + + @doc("Get the classification definition for the given GUID.") + @route("/atlas/v2/types/classificationdef/guid/{guid}") + @get + getClassificationDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the classification.") + @path + guid: string; + }, + AtlasClassificationDef + >; + + @doc("Get the classification definition by its name (unique).") + @route("/atlas/v2/types/classificationdef/name/{name}") + @get + getClassificationDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the classification.") + @path + name: string; + }, + AtlasClassificationDef + >; + + @doc("Get the Entity definition for the given GUID.") + @route("/atlas/v2/types/entitydef/guid/{guid}") + @get + getEntityDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasEntityDef + >; + + @doc("Get the entity definition by its name (unique).") + @route("/atlas/v2/types/entitydef/name/{name}") + @get + getEntityDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the entity.") + @path + name: string; + }, + AtlasEntityDef + >; + + @doc("Get the enum definition for the given GUID.") + @route("/atlas/v2/types/enumdef/guid/{guid}") + @get + getEnumDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the enum.") + @path + guid: string; + }, + AtlasEnumDef + >; + + @doc("Get the enum definition by its name (unique).") + @route("/atlas/v2/types/enumdef/name/{name}") + @get + getEnumDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the enum.") + @path + name: string; + }, + AtlasEnumDef + >; + + @doc("Get the relationship definition for the given GUID.") + @route("/atlas/v2/types/relationshipdef/guid/{guid}") + @get + getRelationshipDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + }, + AtlasRelationshipDef + >; + + @doc("Get the relationship definition by its name (unique).") + @route("/atlas/v2/types/relationshipdef/name/{name}") + @get + getRelationshipDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the relationship.") + @path + name: string; + }, + AtlasRelationshipDef + >; + + @doc("Get the struct definition for the given GUID.") + @route("/atlas/v2/types/structdef/guid/{guid}") + @get + getStructDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the struct.") + @path + guid: string; + }, + AtlasStructDef + >; + + @doc("Get the struct definition by its name (unique).") + @route("/atlas/v2/types/structdef/name/{name}") + @get + getStructDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the struct.") + @path + name: string; + }, + AtlasStructDef + >; + + @doc("Get the type definition for the given GUID.") + @route("/atlas/v2/types/typedef/guid/{guid}") + @get + getByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the type.") + @path + guid: string; + }, + AtlasTypeDef + >; + + @doc("Get the type definition by its name (unique).") + @route("/atlas/v2/types/typedef/name/{name}") + @get + getByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + name: string; + }, + AtlasTypeDef + >; + + @doc("Delete API for type identified by its name.") + @route("/atlas/v2/types/typedef/name/{name}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + name: string; + }, + void + >; + + @doc("List all type definitions in bulk.") + @route("/atlas/v2/types/typedefs") + @get + list is Azure.Core.Foundations.Operation< + { + @doc(""" +Whether include termtemplatedef when return all typedefs. +This is always true +when search filter type=term_template +""") + @query + includeTermTemplate: boolean; + + @doc("Typedef name as search filter when get typedefs.") + @query + type: Type; + }, + AtlasTypesDef + >; + + @doc(""" +Create all atlas type definitions in bulk, only new definitions will be +created. +Any changes to the existing definitions will be discarded. +""") + @route("/atlas/v2/types/typedefs") + @post + bulkCreate is Azure.Core.Foundations.Operation< + { + @doc("A composite wrapper object with corresponding lists of the type definition.") + @body + typesDef: AtlasTypesDef; + }, + AtlasTypesDef + >; + + @doc(""" +Update all types in bulk, changes detected in the type definitions would be +persisted. +""") + @route("/atlas/v2/types/typedefs") + @put + bulkUpdate is Azure.Core.Foundations.Operation< + { + @doc("A composite object that captures all type definition changes.") + @body + typesDef: AtlasTypesDef; + }, + AtlasTypesDef + >; + + @doc("Delete API for all types in bulk.") + @route("/atlas/v2/types/typedefs") + @delete + bulkDelete is Azure.Core.Foundations.Operation< + { + @doc("A composite object that captures all types to be deleted") + @body + typesDef: AtlasTypesDef; + }, + void + >; + + @doc("List all type definitions returned as a list of minimal information header.") + @route("/atlas/v2/types/typedefs/headers") + @get + listHeaders is Azure.Core.Foundations.Operation< + { + @doc(""" +Whether include termtemplatedef when return all typedefs. +This is always true +when search filter type=term_template +""") + @query + includeTermTemplate: boolean; + + @doc("Typedef name as search filter when get typedefs.") + @query + type: Type; + }, + void + >; + + @doc("Get the term template definition for the given GUID.") + @route("/types/termtemplatedef/guid/{guid}") + @get + getTermTemplateDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the term template.") + @path + guid: string; + }, + TermTemplateDef + >; + + @doc("Get the term template definition by its name (unique).") + @route("/types/termtemplatedef/name/{name}") + @get + getTermTemplateDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the term template.") + @path + name: string; + }, + TermTemplateDef + >; +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml new file mode 100644 index 000000000000..2b52ec73631c --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -0,0 +1,36 @@ +parameters: + "service-dir": + default: "sdk/azure.analytics.purview.datamap" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + examples-directory: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/openapi.json" + "@azure-tools/typespec-python": + package-dir: "azure-analytics-purview-datamap" + package-name: "{package-dir}" + package-mode: dataplane + "@azure-tools/typespec-csharp": + package-dir: "Azure.Analytics.Purview.DataMap" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + "@azure-tools/typespec-ts": + package-dir: "azure-analytics-purview-datamap-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/azure-analytics-purview-datamap-rest" + description: "Azure.Analytics.Purview.DataMap Service" + "@azure-tools/typespec-java": + package-dir: "azure-analytics-purview-datamap" + namespace: com.azure.analytics.purview.datamap +linter: + extends: + - "@azure-tools/typespec-azure-core/all" From 22f6a1991bf5bbbae107fcab10cfe93b72ea7f08 Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Wed, 8 Nov 2023 14:23:40 -0800 Subject: [PATCH 002/132] update attr --- .../routes.tsp | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index fe17a5563357..b82bfcb014a0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -296,8 +296,8 @@ GET The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; }, AtlasEntityWithExtInfo >; @@ -332,8 +332,8 @@ PUT The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; @doc("Atlas entity with extended information.") @body @@ -368,8 +368,8 @@ DELETE The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; }, EntityMutationResponse >; @@ -394,8 +394,8 @@ attributes. The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; }, void >; @@ -413,8 +413,8 @@ be changed to other unique attributes) The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; @doc("An array of classification to be added.") @body @@ -436,8 +436,8 @@ be changed to other unique attributes) The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; @doc("An array of classification to be updated.") @body @@ -683,8 +683,8 @@ this: DELETE The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; @doc("set of labels to be deleted") @body @@ -722,8 +722,8 @@ request would look something like this: POST The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; @doc("set of labels to be set") @body @@ -761,8 +761,8 @@ request would look something like this: PUT The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; @doc("set of labels to be added") @body @@ -1511,8 +1511,8 @@ GET The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) - @query - `attr:qualifiedName`: string; + @query("attr:qualifiedName") + attr: string; }, AtlasLineageInfo >; From 5a37c4e513ad62beff0562344afae9bc49c7d735 Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Wed, 8 Nov 2023 14:29:37 -0800 Subject: [PATCH 003/132] add security scheme --- .../purview/Azure.Analytics.Purview.DataMap/main.tsp | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 331846964e26..59fbf96d117e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -22,6 +22,7 @@ discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service. """) +@useAuth(AADToken) @versioned(ApiVersions) namespace PurviewDataMap; @@ -31,3 +32,12 @@ enum ApiVersions { @useDependency(Azure.Core.Versions.v1_0_Preview_2) "2023-09-01", } + +@doc("The Azure Active Directory OAuth2 Flow") +model AADToken is OAuth2Auth<[ + { + type: OAuth2FlowType.implicit; + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; + scopes: ["user_impersonation"]; + } +]>; \ No newline at end of file From c9c74a0777567cfeafbeab4506ad3cc8e0cb5b9b Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Mon, 13 Nov 2023 15:35:18 +0800 Subject: [PATCH 004/132] Update models.tsp --- .../models.tsp | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index eb534f79d130..b4d43974e84a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -6,76 +6,125 @@ using TypeSpec.Http; namespace PurviewDataMap; +@doc("Enum for business attribute update behavior") enum BusinessAttributeUpdateBehavior { + @doc("Ignore the business attribute payload for update.") ignore, + @doc("Replace all the business attributes using the payload.") replace, + @doc("Merge the business attributes. Business attributes will not be updated if not provided.") merge, } +@doc("Status - can be active or deleted") enum Status { + @doc("The status is active.") ACTIVE, + @doc("The status is deleted.") DELETED, } +@doc("Status for term assignment") enum AtlasTermAssignmentStatus { + @doc("The status is discorverred.") DISCOVERED, + @doc("The status is proposed.") PROPOSED, + @doc("The status is imported.") IMPORTED, + @doc("The status is validated.") VALIDATED, + @doc("The status is deprecated.") DEPRECATED, + @doc("The status is obsolete.") OBSOLETE, + @doc("Other status.") OTHER, } +@doc("Type for sorting") enum SortType { + @doc("No sorting order") NONE, + @doc("Use ascending order for sorting") ASC, + @doc("Use descending order for sorting") DESC, } +@doc("Status for import") enum ImportStatus { + @doc("Success") SUCCESS, + @doc("Failed") FAILED, } +@doc("Status for atlas term relationship") enum AtlasTermRelationshipStatus { + @doc("draft") DRAFT, + @doc("active") ACTIVE, + @doc("deprecated") DEPRECATED, + @doc("obsolete") OBSOLETE, + @doc("other") OTHER, } +@doc("Status for term") enum TermStatus { + @doc("draft") Draft, + @doc("approved") Approved, + @doc("alert") Alert, + @doc("expired") Expired, } +@doc("Status for atlas relationship") enum StatusAtlasRelationship { + @doc("active") ACTIVE, + @doc("deleted") DELETED, } +@doc("Direction") enum Direction { + @doc("both") BOTH, + @doc("input") INPUT, + @doc("output") OUTPUT, } +@doc("Lineage direction") enum LineageDirection { + @doc("input") INPUT, + @doc("output") OUTPUT, + @doc("both") BOTH, } +@doc("Cardinality") enum Cardinality { + @doc("single") SINGLE, + @doc("list") LIST, + @doc("set") SET, } +@doc("Type Category") enum TypeCategory { PRIMITIVE, OBJECT_ID_TYPE, @@ -429,6 +478,7 @@ model ImportInfo { remarks?: string; } +@doc("MoveEntitiesRequest") model MoveEntitiesRequest { @doc("An array of entity guids to be moved to target collection.") entityGuids?: string[]; From 506ddf606af4e3704357e7fab4bb6f81748af09a Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 15 Nov 2023 11:07:32 +0800 Subject: [PATCH 005/132] update --- .../models.tsp | 79 ++++++++++++++++++- .../routes.tsp | 4 + 2 files changed, 82 insertions(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index b4d43974e84a..c6c3e88d7446 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -126,41 +126,71 @@ enum Cardinality { @doc("Type Category") enum TypeCategory { + @doc("primitive") PRIMITIVE, + @doc("object id type") OBJECT_ID_TYPE, + @doc("enum") ENUM, + @doc("struct") STRUCT, + @doc("classification") CLASSIFICATION, + @doc("entity") ENTITY, + @doc("array") ARRAY, + @doc("map") MAP, + @doc("relationship") RELATIONSHIP, + @doc("term template") TERM_TEMPLATE, } +@doc("Rounding Mode") enum RoundingMode { + @doc("up") UP, + @doc("down") DOWN, + @doc("ceiling") CEILING, + @doc("floor") FLOOR, + @doc("half up") HALF_UP, + @doc("half down") HALF_DOWN, + @doc("half even") HALF_EVEN, + @doc("unnecessary") UNNECESSARY, } +@doc("Relationship Category") enum RelationshipCategory { + @doc("association") ASSOCIATION, + @doc("aggregation") AGGREGATION, + @doc("composition") COMPOSITION, } +@doc("Type") enum Type { + @doc("enum") `enum`, + @doc("entity") entity, + @doc("classification") classification, + @doc("relationship") relationship, + @doc("struct") struct, + @doc("term template") term_template, } @@ -179,7 +209,7 @@ model AtlasEntityWithExtInfo { model AtlasEntity { ...AtlasStruct; - @doc("Business Attributes") + @doc("Business attributes") businessAttributes?: Record; @doc("An array of classifications.") @@ -619,6 +649,8 @@ model AtlasGlossaryTerm { @doc("The abbreviation of the term.") abbreviation?: string; + + @doc("The name of the template.") templateName?: unknown[]; @doc("The glossary header with basic information.") @@ -701,9 +733,17 @@ key of the first layer map is term template name. @doc("PurviewObjectId") model PurviewObjectId { ...AtlasObjectId; + + @doc("Name") name?: string; + + @doc("Display text") displayText?: string; + + @doc("Item path") itemPath?: string; + + @doc("Resouce Id") resourceId?: string; @doc("Dictionary of ") @@ -746,6 +786,8 @@ Status of the entity - can be active or deleted. Deleted entities are not removed. """) entityStatus?: Status; + + @doc("Relationship type") relationshipType?: string; @doc(""" @@ -818,6 +860,7 @@ batch, and will return new token in each response unless there's no more data. @doc("The content of a search facet result item.") model SearchFacetItem { + @doc("The count of the facet item.") count?: int32; @@ -828,7 +871,9 @@ model SearchFacetItem { sort?: unknown; } +@doc("Taxonomy setting for search request") model SearchRequestTaxonomySetting { + @doc("Asset types") assetTypes?: string[]; @doc("The content of a search facet result item.") @@ -858,6 +903,8 @@ the facet is returned as an element of @search.facets. """) @projectedName("json", "@search.facets") SearchFacets?: SearchFacetResultValue; + + @doc("Search result value") value?: SearchResultValue[]; } @@ -867,15 +914,34 @@ contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. """) model SearchFacetResultValue { + @doc("Entity type") entityType?: SearchFacetItemValue[]; + + @doc("Asset type") assetType?: SearchFacetItemValue[]; + + @doc("Classiciation") classification?: SearchFacetItemValue[]; + + @doc("Term") term?: SearchFacetItemValue[]; + + @doc("Contact id") contactId?: SearchFacetItemValue[]; + + @doc("Contact type") contactType?: SearchFacetItemValue[]; + + @doc("Label") label?: SearchFacetItemValue[]; + + @doc("Glossary type") glossaryType?: SearchFacetItemValue[]; + + @doc("Term status") termStatus?: SearchFacetItemValue[]; + + @doc("Term template") termTemplate?: SearchFacetItemValue[]; } @@ -980,10 +1046,19 @@ the field, attached with emphasis mark, is returned as an element of @search.highlights. """) model SearchHighlights { + @doc("Id") id?: string[]; + + @doc("Qualified name") qualifiedName?: string[]; + + @doc("Name") name?: string[]; + + @doc("Descirption") description?: string[]; + + @doc("Entity type") entityType?: string[]; } @@ -1036,6 +1111,7 @@ must be a number between 1 and 100. @doc("The result item of the search suggest.") model SuggestResult { + @doc("The result value") value?: SuggestResultValue[]; } @@ -1142,6 +1218,7 @@ The value must be a number between 1 and 100. @doc("The result of the autocomplete request.") model AutoCompleteResult { + @doc("The result value") value?: AutoCompleteResultValue[]; } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index b82bfcb014a0..32faaf30c949 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -545,6 +545,7 @@ default is false. """) @query isOverwrite: boolean; + @doc("BusinessMetadata payload") @body businessMetadata: Record; }, void @@ -562,6 +563,8 @@ default is false. @doc("The globally unique identifier of the entity.") @path guid: string; + + @doc("Business metadata attribute payload") @body businessMetadataAttributes: Record; }, void @@ -579,6 +582,7 @@ default is false. @doc("The globally unique identifier of the entity.") @path guid: string; + @doc("Business metadata attribute payload") @body businessMetadataAttributes: Record; }, void From e057bb475573ff0914a50176c464122fbbb45c74 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 15 Nov 2023 11:39:16 +0800 Subject: [PATCH 006/132] Update models.tsp --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index c6c3e88d7446..84d2b4db3eeb 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -961,7 +961,7 @@ The search score calculated by the search engine. The results are ordered by search score by default. """) @projectedName("json", "@search.score") - SearchScore?: float32; + searchScore?: float32; @doc(""" A highlight list that consists of index fields id ,qualifiedName, name, @@ -970,7 +970,7 @@ the field, attached with emphasis mark, is returned as an element of @search.highlights. """) @projectedName("json", "@search.highlights") - SearchHighlights?: SearchHighlights; + searchHighlights?: SearchHighlights; @doc(""" The object type of the record. Object type is the top-level property to @@ -1448,6 +1448,8 @@ model AtlasBaseTypeDef { model DateFormat { @doc("An array of available locales.") availableLocales?: string[]; + + @doc("Calendar") calendar?: float32; @doc("The date format.") From 1451f83c3549e09d641dce40b3b07afa480a5602 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 15 Nov 2023 13:37:03 +0800 Subject: [PATCH 007/132] update --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 9 +++------ .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 2 +- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 84d2b4db3eeb..960d05243a28 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -854,7 +854,9 @@ batch, and will return new token in each response unless there's no more data. @doc("The filter for the search. See examples for the usage of supported filters.") filter?: unknown; + @doc("The facets for search. See examples for the usage of supported facets.") facets?: SearchFacetItem[]; + @doc("The taxonomy setting for search.") taxonomySetting?: SearchRequestTaxonomySetting; } @@ -1875,9 +1877,4 @@ model AtlasTypeDefHeader { @doc("The name of the type definition.") name?: string; -} - -model PathsEsavagAtlasV2EntityBusinessmetadataImportPostRequestbodyContentMultipartFormDataSchema { - @doc("InputStream of file") - uploadedInputStream?: bytes; -} +} \ No newline at end of file diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 32faaf30c949..71a7de1fb237 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -595,7 +595,7 @@ default is false. { @doc("Accept header") @header - Accept: "application/octet-stream"; + accept: "application/octet-stream"; }, void >; From 056778636e3fb87709e4c434502fa417162e93da Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 15 Nov 2023 15:30:55 +0800 Subject: [PATCH 008/132] update examples --- .../2023-09-01/Discovery_AutoComplete.json | 40 +++ .../examples/2023-09-01/Discovery_Query.json | 109 +++++++ .../2023-09-01/Discovery_Query_And.json | 80 +++++ .../Discovery_Query_AndOrNested.json | 97 ++++++ .../2023-09-01/Discovery_Query_AssetType.json | 140 +++++++++ .../2023-09-01/Discovery_Query_Attribute.json | 97 ++++++ ...overy_Query_BusinessMetadataAttribute.json | 54 ++++ .../Discovery_Query_Classification.json | 69 +++++ .../Discovery_Query_Collection.json | 68 ++++ .../2023-09-01/Discovery_Query_Facet.json | 150 +++++++++ .../Discovery_Query_FileExtension.json | 62 ++++ .../Discovery_Query_GlossaryTerm.json | 96 ++++++ .../2023-09-01/Discovery_Query_Id.json | 45 +++ .../2023-09-01/Discovery_Query_Not.json | 60 ++++ .../Discovery_Query_ObjectType.json | 77 +++++ ...very_Query_PaginationContinuationPage.json | 111 +++++++ .../Discovery_Query_PaginationFirstPage.json | 110 +++++++ .../Discovery_Query_PaginationLastPage.json | 110 +++++++ .../Discovery_Query_SystemTime.json | 55 ++++ .../2023-09-01/Discovery_Query_Taxonomy.json | 94 ++++++ .../Discovery_Query_TermAssignment.json | 59 ++++ .../2023-09-01/Discovery_Query_Type.json | 66 ++++ .../2023-09-01/Discovery_Suggest.json | 60 ++++ ...tity_AddClassificationToEntityByGuids.json | 21 ++ .../2023-09-01/Entity_AddClassifications.json | 21 ++ ...y_AddClassificationsByUniqueAttribute.json | 20 ++ .../2023-09-01/Entity_AddCustomAttribute.json | 57 ++++ .../Entity_AddLabelsByUniqueAttribute.json | 15 + .../Entity_AddOrUpdate_BusinessAttribute.json | 15 + .../2023-09-01/Entity_BulkCreateOrUpdate.json | 106 +++++++ .../2023-09-01/Entity_BulkDelete.json | 37 +++ .../Entity_BulkSetClassifications.json | 41 +++ .../examples/2023-09-01/Entity_Create.json | 62 ++++ .../examples/2023-09-01/Entity_Delete.json | 29 ++ .../Entity_DeleteByUniqueAttribute.json | 35 +++ .../examples/2023-09-01/Entity_Get.json | 63 ++++ .../Entity_GetByUniqueAttributes.json | 37 +++ .../2023-09-01/Entity_GetClassification.json | 19 ++ .../2023-09-01/Entity_GetClassifications.json | 24 ++ .../examples/2023-09-01/Entity_GetHeader.json | 30 ++ ...ity_GetSampleBusinessMetadataTemplate.json | 12 + .../Entity_ImportBusinessMetadata.json | 22 ++ .../examples/2023-09-01/Entity_Label.json | 15 + .../2023-09-01/Entity_ListByGuids.json | 116 +++++++ .../Entity_ListByUniqueAttributes.json | 52 ++++ .../Entity_MoveEntitiesToCollection.json | 47 +++ .../Entity_PartialUpdateAttributeByGuid.json | 39 +++ ...ntity_PartialUpdateByUniqueAttributes.json | 62 ++++ .../Entity_RemoveBusinessAttribute.json | 15 + .../Entity_RemoveBusinessMetadata.json | 16 + .../Entity_RemoveClassification.json | 12 + ...RemoveClassificationByUniqueAttribute.json | 13 + .../Entity_RemoveLabelsByUniqueAttribute.json | 15 + .../Entity_SetLabelsByUniqueAttribute.json | 16 + .../examples/2023-09-01/Entity_Update.json | 61 ++++ .../Entity_UpdateClassifications.json | 21 ++ ...pdateClassificationsByUniqueAttribute.json | 20 ++ .../Glossary_AssignTermToEntities.json | 24 ++ .../examples/2023-09-01/Glossary_Create.json | 32 ++ .../2023-09-01/Glossary_CreateCategories.json | 47 +++ .../2023-09-01/Glossary_CreateCategory.json | 39 +++ .../2023-09-01/Glossary_CreateTerm.json | 78 +++++ .../Glossary_CreateTermWithTemplate.json | 53 ++++ .../2023-09-01/Glossary_CreateTerms.json | 93 ++++++ .../examples/2023-09-01/Glossary_Delete.json | 11 + .../2023-09-01/Glossary_DeleteCategory.json | 11 + .../2023-09-01/Glossary_DeleteTerm.json | 11 + .../examples/2023-09-01/Glossary_Get.json | 43 +++ .../2023-09-01/Glossary_GetCategory.json | 41 +++ .../2023-09-01/Glossary_GetDetailed.json | 231 ++++++++++++++ .../examples/2023-09-01/Glossary_GetTerm.json | 86 ++++++ .../Glossary_GetTermWithoutAssets.json | 66 ++++ .../examples/2023-09-01/Glossary_List.json | 61 ++++ .../2023-09-01/Glossary_ListCategories.json | 74 +++++ .../Glossary_ListCategoriesHeaders.json | 34 ++ .../Glossary_ListCategoryTerms.json | 22 ++ ...Glossary_ListEntitiesAssignedWithTerm.json | 59 ++++ .../Glossary_ListRelatedCategories.json | 31 ++ .../2023-09-01/Glossary_ListRelatedTerms.json | 31 ++ .../2023-09-01/Glossary_ListTermHeaders.json | 27 ++ .../2023-09-01/Glossary_ListTerms.json | 105 +++++++ .../2023-09-01/Glossary_PartialUpdate.json | 60 ++++ .../Glossary_PartialUpdateCategory.json | 45 +++ .../Glossary_PartialUpdateTerm.json | 60 ++++ ...sary_RemoveTermAssignmentFromEntities.json | 17 + .../examples/2023-09-01/Glossary_Update.json | 98 ++++++ .../2023-09-01/Glossary_UpdateCategory.json | 65 ++++ .../2023-09-01/Glossary_UpdateTerm.json | 94 ++++++ .../examples/2023-09-01/Lineage_Get.json | 26 ++ .../Lineage_GetByUniqueAttribute.json | 65 ++++ .../2023-09-01/Lineage_GetNextPage.json | 27 ++ .../2023-09-01/Relationship_Create.json | 60 ++++ .../2023-09-01/Relationship_Delete.json | 11 + .../examples/2023-09-01/Relationship_Get.json | 41 +++ .../2023-09-01/Relationship_Update.json | 61 ++++ .../examples/2023-09-01/Type_BulkCreate.json | 73 +++++ .../Type_BulkCreateBusinessMetadataDefs.json | 77 +++++ .../examples/2023-09-01/Type_BulkDelete.json | 35 +++ .../examples/2023-09-01/Type_BulkUpdate.json | 290 ++++++++++++++++++ .../examples/2023-09-01/Type_Delete.json | 11 + .../Type_GetBusinessMetadataDefByGuid.json | 43 +++ .../Type_GetBusinessMetadataDefByName.json | 43 +++ .../examples/2023-09-01/Type_GetByGuid.json | 43 +++ .../examples/2023-09-01/Type_GetByName.json | 43 +++ .../Type_GetClassificationDefByGuid.json | 28 ++ .../Type_GetClassificationDefByName.json | 28 ++ .../2023-09-01/Type_GetEntityDefByGuid.json | 58 ++++ .../2023-09-01/Type_GetEntityDefByName.json | 58 ++++ .../2023-09-01/Type_GetEnumDefByGuid.json | 38 +++ .../2023-09-01/Type_GetEnumDefByName.json | 38 +++ .../Type_GetRelationshipDefByGuid.json | 41 +++ .../Type_GetRelationshipDefByName.json | 41 +++ .../2023-09-01/Type_GetStructDefByGuid.json | 48 +++ .../2023-09-01/Type_GetStructDefByName.json | 48 +++ .../Type_GetTermTemplateDefByGuid.json | 85 +++++ .../Type_GetTermTemplateDefByName.json | 85 +++++ .../examples/2023-09-01/Type_List.json | 271 ++++++++++++++++ .../2023-09-01/Type_ListEnumDefs.json | 92 ++++++ .../examples/2023-09-01/Type_ListHeaders.json | 29 ++ .../2023-09-01/Type_ListTermTemplateDefs.json | 93 ++++++ 120 files changed, 6874 insertions(+) create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json new file mode 100644 index 000000000000..2c6462c735ab --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "autoCompleteRequest": { + "keywords": "exa", + "filter": { + "and": [ + { + "entityType": "azure_blob_path", + "includeSubTypes": false + } + ] + }, + "limit": 10 + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "text": "example", + "queryPlusText": "example" + }, + { + "text": "exampleconfiguration", + "queryPlusText": "exampleconfiguration" + }, + { + "text": "exampleresources", + "queryPlusText": "exampleresources" + } + ] + } + } + }, + "title": "Discovery_AutoComplete", + "operationId": "Discovery_AutoComplete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json new file mode 100644 index 000000000000..24ef568e34e7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 10, + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json new file mode 100644 index 000000000000..858d8fec1f54 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "entityType": "azure_blob_path" + }, + { + "attributeName": "qualifiedName", + "operator": "contains", + "attributeValue": ".csv" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 5, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv" + ] + }, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv" + ] + }, + "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv", + "name": "AllTypes.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_And", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json new file mode 100644 index 000000000000..2175edbbaa01 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "entityType": "azure_blob_path" + }, + { + "attributeName": "qualifiedName", + "operator": "contains", + "attributeValue": ".csv" + }, + { + "or": [ + { + "attributeName": "name", + "operator": "eq", + "attributeValue": "exampledata.csv" + }, + { + "attributeName": "qualifiedName", + "operator": "prefix", + "attributeValue": "https://" + } + ] + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv" + ] + }, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "@search.highlights": { + "qualifiedName": [ + "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv" + ], + "name": [ + "AllTypes.csv" + ] + }, + "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv", + "name": "AllTypes.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_AndOrNested", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json new file mode 100644 index 000000000000..15afdce1337f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "assetType": "SQL Server" + }, + { + "assetType": "Azure SQL Server" + }, + { + "assetType": "Azure SQL Database" + }, + { + "assetType": "Azure SQL Data Warehouse" + }, + { + "assetType": "Azure SQL Managed Instance" + }, + { + "assetType": "Azure Storage Account" + }, + { + "assetType": "Azure Blob Storage" + }, + { + "assetType": "Azure Files" + }, + { + "assetType": "Azure Table Storage" + }, + { + "assetType": "Azure Data Lake Storage Gen1" + }, + { + "assetType": "Azure Data Lake Storage Gen2" + }, + { + "assetType": "Azure Cosmos DB" + }, + { + "assetType": "Azure Data Factory" + }, + { + "assetType": "Azure Cognitive Search" + }, + { + "assetType": "Power BI" + }, + { + "assetType": "Azure Data Explorer" + }, + { + "assetType": "Amazon S3" + }, + { + "assetType": "Azure Data Share" + }, + { + "assetType": "Teradata" + }, + { + "assetType": "SAP S4HANA" + }, + { + "assetType": "SAP ECC" + }, + { + "assetType": "SQL Server Integration Services" + }, + { + "assetType": "hive" + }, + { + "assetType": "Azure Database for MySQL" + }, + { + "assetType": "Azure Database for MariaDB" + }, + { + "assetType": "Azure Database for PostgreSQL" + }, + { + "assetType": "Azure Synapse Analytics" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 5155, + "@search.count.approximate": true, + "value": [ + { + "@search.score": 1.0, + "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1", + "name": "exampledata1", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_AssetType", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json new file mode 100644 index 000000000000..3baee531460e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "attributeName": "name", + "operator": "eq", + "attributeValue": "exampledata.csv" + }, + { + "attributeName": "createTime", + "operator": "ge", + "attributeValue": 1545580800000 + }, + { + "attributeName": "modifiedTime", + "operator": "timerange", + "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 4, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "55b2290d-e11d-4ed2-8c7a-0d8d35eb6254", + "qualifiedName": "https://examplegen2account.dfs.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": "$superuser", + "entityType": "azure_datalake_gen2_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Data Lake Storage Gen2" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "55ceaddf-30ac-40f3-b656-71f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v1", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1", + "assetType": [ + "Azure SQL Managed Instance" + ] + }, + { + "@search.score": 1.0, + "id": "89416661-5269-4f3d-ba35-e0f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v2", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2", + "assetType": [ + "Azure SQL Managed Instance" + ] + } + ] + } + } + }, + "title": "Discovery_Query_Attribute", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json new file mode 100644 index 000000000000..1920ea21bd36 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "attributeName": ".", + "operator": "eq|ne|contains|prefix", + "attributeValue": "string value" + }, + { + "attributeName": ".", + "operator": "eq|ne|gt|ge|lt|le", + "attributeValue": 123 + }, + { + "attributeName": ".", + "operator": "eq|ne", + "attributeValue": true + }, + { + "attributeName": ".", + "operator": "timerange", + "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", + "entityType": "azure_blob_path", + "objectType": "Files" + } + ] + } + } + }, + "title": "Discovery_Query_BusinessMetadataAttribute", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json new file mode 100644 index 000000000000..6b1c6113741e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "classification": "MICROSOFT.PERSONAL.EMAIL", + "includeSubClassifications": true + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 5, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1", + "name": "exampledata1", + "description": null, + "owner": null, + "entityType": "azure_sql_table", + "classification": [ + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.US.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Database" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_dw_table", + "classification": [ + "MICROSOFT.GOVERNMENT.CITY_NAME", + "MICROSOFT.GOVERNMENT.US.STATE", + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Data Warehouse" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Classification", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json new file mode 100644 index 000000000000..6c10f84bbc17 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "collectionId": "collectionName" + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 5, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1", + "name": "exampledata1", + "description": null, + "owner": null, + "entityType": "azure_sql_table", + "classification": [ + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.US.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Database" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000", + "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_dw_table", + "classification": [ + "MICROSOFT.GOVERNMENT.CITY_NAME", + "MICROSOFT.GOVERNMENT.US.STATE", + "MICROSOFT.PERSONAL.NAME", + "MICROSOFT.PERSONAL.EU.PHONE_NUMBER", + "MICROSOFT.PERSONAL.EMAIL" + ], + "label": [], + "assetType": [ + "Azure SQL Data Warehouse" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Collection", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json new file mode 100644 index 000000000000..4180c50799e1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "filter": { + "objectType": "Tables" + }, + "limit": 10, + "facets": [ + { + "facet": "assetType", + "count": 10 + }, + { + "facet": "classification", + "count": 10 + }, + { + "facet": "term", + "count": 10 + }, + { + "facet": "label", + "count": 10 + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 5156, + "@search.count.approximate": false, + "@search.facets": { + "classification": [ + { + "count": 8, + "value": "MICROSOFT.PERSONAL.NAME" + }, + { + "count": 6, + "value": "MICROSOFT.PERSONAL.EU.PHONE_NUMBER" + }, + { + "count": 5, + "value": "MICROSOFT.PERSONAL.EMAIL" + }, + { + "count": 5, + "value": "MICROSOFT.PERSONAL.US.PHONE_NUMBER" + }, + { + "count": 4, + "value": "MICROSOFT.GOVERNMENT.CITY_NAME" + }, + { + "count": 2, + "value": "MICROSOFT.GOVERNMENT.US.STATE" + } + ], + "assetType": [ + { + "count": 1476, + "value": "Azure SQL Database" + }, + { + "count": 1358, + "value": "Azure SQL Data Warehouse" + }, + { + "count": 1331, + "value": "Azure SQL Managed Instance" + }, + { + "count": 293, + "value": "Azure Data Lake Storage Gen1" + }, + { + "count": 261, + "value": "Azure Blob Storage" + }, + { + "count": 231, + "value": "Azure Data Lake Storage Gen2" + }, + { + "count": 194, + "value": "Azure Files" + }, + { + "count": 18, + "value": "Azure Cosmos DB" + } + ], + "label": [ + { + "count": 835, + "value": "Example.Label" + } + ], + "term": [ + { + "count": 1, + "value": "terma" + } + ] + }, + "value": [ + { + "@search.score": 1.0, + "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata", + "name": "exampledata", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Facet", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json new file mode 100644 index 000000000000..7687c14e90fb --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "fileExtension": "txt" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 49, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_FileExtension", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json new file mode 100644 index 000000000000..bc25305cc75f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "", + "limit": 10, + "filter": { + "and": [ + { + "objectType": "Glossary terms" + }, + { + "or": [ + { + "glossaryType": "AtlasGlossary" + }, + { + "glossaryType": "AtlasGlossaryTerm" + } + ] + } + ] + }, + "facets": [ + { + "facet": "termStatus", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "termTemplate", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "objectType": "Glossary terms", + "glossaryType": "AtlasGlossaryTerm", + "id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3", + "name": "termSample1", + "glossary": "DefaultGlossary", + "longDescription": "it is the definition of the term", + "termStatus": "Approved", + "termTemplate": [ + "termTemplateSample" + ], + "createTime": 1625819659805, + "updateTime": 1625819659805, + "qualifiedName": "termSample1@DefaultGlossary" + }, + { + "@search.score": 1.0, + "objectType": "Glossary terms", + "glossaryType": "AtlasGlossary", + "id": "b28f35e4-fcd4-43ca-91a3-daf432c87156", + "name": "DefaultGlossary", + "longDescription": "it is the definition of the glossary", + "createTime": 1625819658745, + "updateTime": 1640656877302, + "qualifiedName": "DefaultGlossary" + } + ], + "@search.facets": { + "termTemplate": [ + { + "count": 1, + "value": "termTemplateSample" + } + ], + "termStatus": [ + { + "count": 1, + "value": "Approved" + } + ] + } + } + } + }, + "title": "Discovery_Query_GlossaryTerm", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json new file mode 100644 index 000000000000..7c4e797a0be8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Id", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json new file mode 100644 index 000000000000..4b861a28b2fb --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "not": { + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + } + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 5158, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "11fd6e94-2dc6-4ebd-822c-caf6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata", + "name": "exampledata", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "1af82c87-798c-41a2-abab-93f6f6f60000", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata2", + "name": "exampledata2", + "description": null, + "owner": null, + "entityType": "azure_sql_mi_table", + "classification": [], + "label": [], + "assetType": [ + "Azure SQL Managed Instance" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Not", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json new file mode 100644 index 000000000000..c741d8fb1bc2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + [ + { + "objectType": "Dashboards" + }, + { + "objectType": "Data pipelines" + }, + { + "objectType": "Files" + }, + { + "objectType": "Folders" + }, + { + "objectType": "Glossary terms" + }, + { + "objectType": "Reports" + }, + { + "objectType": "Stored procedures" + }, + { + "objectType": "Tables" + } + ] + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "objectType": "Tables", + "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampledata1", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1", + "assetType": [ + "Azure SQL Managed Instance" + ] + }, + { + "@search.score": 1.0, + "objectType": "Glossary terms", + "id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3", + "glossaryType": "AtlasGlossaryTerm", + "name": "termSample1", + "glossary": "DefaultGlossary", + "longDescription": "it is the definition of the term", + "termStatus": "Approved", + "termTemplate": [ + "termTemplateSample" + ], + "qualifiedName": "termSample1@DefaultGlossary" + } + ] + } + } + }, + "title": "Discovery_Query_ObjectType", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json new file mode 100644 index 000000000000..1946af0bda97 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 2, + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 6, + "@search.count.approximate": false, + "continuationToken": "ZXlKelpYTnphVzl1U1dRaU9pSTVaV1JpWW1Fek5DMHdZbU0wTFRReE5HRXRPVFkyTkMwMU9HTTJaVEJrTXpJM09EWWlMQ0p2Wm1aelpYUWlPakkxTENKeVpYRjFaWE4wU0dGemFDSTZJalppTW1Gak1UbG1NR0V4WmpsbU1qWTJOemMwWkRkaFpEY3pOVEUzT1dKbUluMD0=", + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_PaginationContinuationPage", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json new file mode 100644 index 000000000000..37cbd7af29b0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 2, + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 6, + "@search.count.approximate": false, + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_PaginationFirstPage", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json new file mode 100644 index 000000000000..9d4d92d9a531 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "entityType": "azure_blob_path" + } + ] + }, + "limit": 2, + "continuationToken": "ZXlKelpYTnphVzl1U1dRaU9pSTVaV1JpWW1Fek5DMHdZbU0wTFRReE5HRXRPVFkyTkMwMU9HTTJaVEJrTXpJM09EWWlMQ0p2Wm1aelpYUWlPakkxTENKeVpYRjFaWE4wU0dGemFDSTZJalppTW1Gak1UbG1NR0V4WmpsbU1qWTJOemMwWkRkaFpEY3pOVEUzT1dKbUluMD0=", + "orderby": [ + { + "name": "ASC" + }, + { + "updateTime": "DESC" + } + ], + "facets": [ + { + "facet": "assetType", + "count": 0, + "sort": { + "count": "desc" + } + }, + { + "facet": "classification", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "contactId", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "label", + "count": 10, + "sort": { + "count": "desc" + } + }, + { + "facet": "term", + "count": 10, + "sort": { + "count": "desc" + } + } + ] + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 6, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_PaginationLastPage", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json new file mode 100644 index 000000000000..705f0bfdf7ff --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "or": [ + { + "createTime": { + "operator": "lt", + "timeThreshold": 1545580800000 + } + }, + { + "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 2, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "55ceaddf-30ac-40f3-b656-71f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v1", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1", + "assetType": [ + "Azure SQL Managed Instance" + ] + }, + { + "@search.score": 1.0, + "id": "89416661-5269-4f3d-ba35-e0f6f6f60000", + "entityType": "azure_sql_mi_table", + "name": "exampleData_v2", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2", + "assetType": [ + "Azure SQL Managed Instance" + ] + } + ] + } + } + }, + "title": "Discovery_Query_SystemTime", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json new file mode 100644 index 000000000000..f7aac26f09f1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "objectType": "Files" + }, + { + "not": { + "or": [ + { + "attributeName": "size", + "operator": "eq", + "attributeValue": 0 + }, + { + "attributeName": "fileSize", + "operator": "eq", + "attributeValue": 0 + } + ] + } + }, + { + "not": { + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + } + } + ] + }, + "limit": 10, + "taxonomySetting": { + "assetTypes": [ + "Azure Blob Storage" + ], + "facet": { + "count": 10, + "sort": { + "count": "desc" + } + } + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 339, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt", + "name": "exampledata1.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt", + "name": "exampledata2.txt", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Taxonomy", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json new file mode 100644 index 000000000000..5f02b441bfb6 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": "", + "limit": 3, + "filter": { + "or": [ + { + "term": "ExampleTerm" + }, + { + "term": "ExampleTerm", + "glossary": "GlossaryName" + }, + { + "termGuid": "" + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "@search.count.approximate": false, + "value": [ + { + "@search.score": 1.0, + "id": "b20ac13a-7883-4376-b076-bac9f8f214a8", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer", + "name": "examplecontainer", + "description": null, + "owner": null, + "entityType": "azure_blob_container", + "classification": [], + "assetType": [ + "Azure Blob Storage" + ], + "term": [ + { + "name": "ExampleTerm", + "glossaryName": "Glossary" + } + ], + "contact": [], + "label": [ + "Example.Label" + ] + } + ] + } + } + }, + "title": "Discovery_Query_TermAssignment", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json new file mode 100644 index 000000000000..473133d7d26f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "searchRequest": { + "keywords": null, + "limit": 10, + "filter": { + "and": [ + { + "entityType": "azure_blob_path", + "includeSubTypes": false + } + ] + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "continuationToken": "eyJzZXNzaW9uSWQiOiI5ZWRiYmEzNC0wYmM0LTQxNGEtOTY2NC01OGM2ZTBkMzI3ODYiLCJvZmZzZXQiOjI1LCJyZXF1ZXN0SGFzaCI6IjZiMmFjMTlmMGExZjlmMjY2Nzc0ZDdhZDczNTE3OWJmIn0=", + "@search.count": 221, + "value": [ + { + "@search.score": 1.0, + "id": "1d797ddf-47bf-4151-8fe8-918590d62e70", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv", + "name": "exampledata.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + }, + { + "@search.score": 1.0, + "id": "d3e83b17-c730-4898-94c8-58579cda04f6", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.csv", + "name": "exampledata2.csv", + "description": null, + "owner": null, + "entityType": "azure_blob_path", + "classification": [], + "label": [ + "Example.Label" + ], + "assetType": [ + "Azure Blob Storage" + ], + "term": [], + "contact": [] + } + ] + } + } + }, + "title": "Discovery_Query_Type", + "operationId": "Discovery_Query" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json new file mode 100644 index 000000000000..95ec0ed6f307 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "suggestRequest": { + "keywords": "exampledata", + "filter": { + "and": [ + { + "entityType": "azure_blob_path", + "includeSubTypes": false + } + ] + }, + "limit": 10 + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "exampledata.csv", + "@search.score": 9.81402, + "description": "Example Description", + "id": "af7a01b0-1b14-4ab6-83a5-12cb11a717ed", + "name": "exampledata.csv", + "owner": "$superuser", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv", + "entityType": "azure_blob_path", + "assetType": [ + "Azure Blob Storage" + ], + "classification": [ + "MICROSOFT.GOVERNMENT.US.PASSPORT_NUMBER" + ], + "contact": [ + { + "id": "8a597ffc-6993-4772-ac25-86b7251e1234", + "info": "Example Info", + "contactType": "Expert" + } + ], + "label": [ + "Example.Label" + ], + "term": [ + { + "name": "Example Term", + "glossaryName": "Glossary" + } + ] + } + ] + } + } + }, + "title": "Discovery_Suggest", + "operationId": "Discovery_Suggest" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json new file mode 100644 index 000000000000..d45c65f6681f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "request": { + "classification": { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "attributes": {}, + "validityPeriods": [] + }, + "entityGuids": [ + "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" + ] + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddClassificationToEntityByGuids", + "operationId": "Entity_AddClassificationToEntityByGuids" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json new file mode 100644 index 000000000000..3bdb3c19b4a9 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", + "classifications": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" + }, + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", + "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddClassifications", + "operationId": "Entity_AddClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json new file mode 100644 index 000000000000..9ceb5785ba20 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "atlasClassificationArray": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" + }, + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddClassificationsByUniqueAttribute", + "operationId": "Entity_AddClassificationsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json new file mode 100644 index 000000000000..20c7d135e2c9 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "entity": { + "referredEntities": {}, + "entity": { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount", + "description": null, + "publicAccessLevel": null + }, + "customAttributes": { + "custAttr1": "attr1", + "custAttr2": "attr2" + } + } + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount" + }, + "lastModifiedTS": "1", + "guid": "c696b935-2c76-4208-bc0d-8864553a67f1", + "displayText": "ExampleStorageAccount", + "classificationNames": [], + "classifications": [], + "meaningNames": [], + "meanings": [], + "isIncomplete": false, + "labels": [] + } + ] + }, + "guidAssignments": { + "-16806536444330": "c696b935-2c76-4208-bc0d-8864553a67f1" + } + } + } + }, + "title": "Entity_AddCustomAttribute", + "operationId": "Entity_AddCustomAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json new file mode 100644 index 000000000000..3a2bc5a3f537 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "Asset", + "attr:qualifiedName": "https://asset1", + "body": [ + "label3" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_AddLabelsByUniqueAttribute", + "operationId": "Entity_AddLabelsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json new file mode 100644 index 000000000000..972e4811601d --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "bmName": "myBizMetaData1", + "body": { + "bizAttr1": "bizAttr1" + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddOrUpdate_BusinessAttribute", + "operationId": "Entity_AddOrUpdate_BusinessAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json new file mode 100644 index 000000000000..ad389111aaac --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "entities": { + "referredEntities": {}, + "entities": [ + { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "exampleaccount1", + "name": "ExampleStorageAccount1", + "description": null, + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + }, + { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "exampleaccount2", + "name": "ExampleStorageAccount2", + "description": "Example Description", + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + ] + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "UPDATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount2" + }, + "lastModifiedTS": "2", + "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1", + "status": "ACTIVE" + } + ], + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount1" + }, + "lastModifiedTS": "1", + "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "status": "ACTIVE" + } + ] + }, + "guidAssignments": { + "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1" + } + } + } + }, + "title": "Entity_BulkCreateOrUpdate", + "operationId": "Entity_BulkCreateOrUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json new file mode 100644 index 000000000000..3b8c27b9b5fc --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkDelete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": [ + "18e06957-e265-967a-07f1-e14e2ab8940f", + "cc0730ba-9b30-41f0-6953-559d17626d2b" + ] + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "DELETE": [ + { + "typeName": "azure_blob_container", + "attributes": { + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer" + }, + "guid": "18e06957-e265-967a-07f1-e14e2ab8940f", + "status": "ACTIVE" + }, + { + "typeName": "azure_blob_container", + "attributes": { + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer2" + }, + "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", + "status": "ACTIVE" + } + ] + } + } + } + }, + "title": "Entity_BulkDelete", + "operationId": "Entity_BulkDelete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json new file mode 100644 index 000000000000..ea7c077e8df3 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "entityHeaders": { + "guidHeaderMap": { + "9fb74c11-ac48-4650-95bc-760665c5bd92": { + "attributes": { + "qualifiedName": "https://exampleaccount1.core.windows.net" + }, + "typeName": "azure_storage_account", + "classifications": [ + { + "typeName": "MICROSOFT.PERSONAL.EMAIL" + } + ] + }, + "7fcc43ab-55ea-45d4-9971-ce0443cb10bb": { + "attributes": { + "qualifiedName": "https://exampleaccount2.core.windows.net" + }, + "typeName": "azure_storage_account", + "classifications": [ + { + "typeName": "MICROSOFT.PERSONAL.IPADDRESS" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": [ + "Add:9fb74c11-ac48-4650-95bc-760665c5bd92:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.EMAIL:(Done)", + "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" + ] + } + }, + "title": "Entity_BulkSetClassifications", + "operationId": "Entity_BulkSetClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json new file mode 100644 index 000000000000..29c4fdc0657d --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "entity": { + "referredEntities": {}, + "entity": { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount", + "description": null, + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "lastModifiedTS": "1", + "guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6", + "status": "ACTIVE" + } + ] + }, + "guidAssignments": { + "-9514774903018162": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6" + } + } + } + }, + "title": "Entity_Create", + "operationId": "Entity_Create" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json new file mode 100644 index 000000000000..9e6ab2104d44 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f" + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "DELETE": [ + { + "guid": "fd279eb4-f6c3-1b0b-ad67-e4f8abd2972f", + "status": "ACTIVE", + "lastModifiedTS": "2", + "attributes": { + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAaccount" + }, + "typeName": "azure_storage_account" + } + ] + } + } + } + }, + "title": "Entity_Delete", + "operationId": "Entity_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json new file mode 100644 index 000000000000..3df1ba7cee96 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_DeleteByUniqueAttribute.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net" + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "DELETE": [ + { + "classificationNames": [], + "displayText": "Example Name", + "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a", + "meaningNames": [], + "meanings": [], + "status": "ACTIVE", + "lastModifiedTS": "1", + "attributes": { + "owner": "ExampleOwner", + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleName" + }, + "typeName": "azure_storage_account" + } + ] + } + } + } + }, + "title": "Entity_DeleteByUniqueAttribute", + "operationId": "Entity_DeleteByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json new file mode 100644 index 000000000000..2acf46b04d68 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb" + }, + "responses": { + "200": { + "body": { + "referredEntities": {}, + "entity": { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath", + "name": "~XmlInputPath", + "description": null, + "type": "string" + }, + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "5a4510d4-57d0-467c-888f-4b61df42702b", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + } + } + } + } + }, + "title": "Entity_Get", + "operationId": "Entity_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json new file mode 100644 index 000000000000..113dab2d668f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net" + }, + "responses": { + "200": { + "body": { + "entity": { + "createTime": 1605703532110, + "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a", + "relationshipAttributes": { + "services": [], + "meanings": [] + }, + "status": "ACTIVE", + "updateTime": 1605703532110, + "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "lastModifiedTS": "2", + "version": 0.0, + "attributes": { + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "createTime": 0, + "name": "ExampleNewName" + }, + "typeName": "azure_storage_account" + }, + "referredEntities": {} + } + } + }, + "title": "Entity_GetByUniqueAttributes", + "operationId": "Entity_GetByUniqueAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json new file mode 100644 index 000000000000..968a4d7e0fcc --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassification.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", + "classificationName": "MICROSOFT.PERSONAL.DATE_OF_BIRTH" + }, + "responses": { + "200": { + "body": { + "typeName": "MICROSOFT.PERSONAL.DATE_OF_BIRTH", + "lastModifiedTS": "1", + "entityGuid": "9347abc5-7b86-4b82-a1e2-ad77c7c3cac3", + "entityStatus": "ACTIVE" + } + } + }, + "title": "Entity_GetClassification", + "operationId": "Entity_GetClassification" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json new file mode 100644 index 000000000000..ae0d81292c04 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetClassifications.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd" + }, + "responses": { + "200": { + "body": { + "list": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "entityGuid": "67d26de6-771d-1a2d-cb2b-dec4dbd2a9bd" + } + ], + "startIndex": 0, + "pageSize": 1, + "totalCount": 1, + "sortType": "NONE" + } + } + }, + "title": "Entity_GetClassifications", + "operationId": "Entity_GetClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json new file mode 100644 index 000000000000..029a55bbbb96 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetHeader.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92" + }, + "responses": { + "200": { + "body": { + "classificationNames": [ + "MICROSOFT.PERSONAL.EMAIL" + ], + "displayText": "Example Storage Account", + "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92", + "meaningNames": [], + "meanings": [], + "status": "ACTIVE", + "lastModifiedTS": "3", + "attributes": { + "owner": "ExampleOwner", + "createTime": 0, + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount" + }, + "typeName": "azure_storage_account" + } + } + }, + "title": "Entity_GetHeader", + "operationId": "Entity_GetHeader" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json new file mode 100644 index 000000000000..1e6900e014eb --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" + } + }, + "title": "Entity_GetSampleBusinessMetadataTemplate", + "operationId": "Entity_GetSampleBusinessMetadataTemplate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json new file mode 100644 index 000000000000..8dec58efba8a --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "file": "examplefile.csv" + }, + "responses": { + "200": { + "body": { + "successImportInfoList": [ + { + "parentObjectName": "24a77100-1b3a-4c37-884e-7d4f591f5a64", + "childObjectName": "{myBizType1={bizAttr1=Awesome Attribute 1}}", + "importStatus": "SUCCESS", + "remarks": "" + } + ] + } + } + }, + "title": "Entity_ImportBusinessMetadata", + "operationId": "Entity_ImportBusinessMetadata" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json new file mode 100644 index 000000000000..bb9ce5b59ba5 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_Label", + "operationId": "Entity_Label" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json new file mode 100644 index 000000000000..ed6951961940 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": [ + "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" + ] + }, + "responses": { + "200": { + "body": { + "referredEntities": {}, + "entities": [ + { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "name": "ExampleName1", + "description": null, + "type": "string" + }, + "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "400fd8e4-97bd-45eb-a21c-880b4094ce5b", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + } + }, + { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/ExampleName2", + "name": "ExampleName2", + "description": null, + "type": "string" + }, + "guid": "b4ebc8be-cef4-860a-bee9-28cc34cb5caa", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "381dd3e6-dad5-7409-c21d-ea55b666e420", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "0b652860-ab79-48cd-a0cf-0867fbba31a3", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + } + } + ] + } + } + }, + "title": "Entity_ListByGuids", + "operationId": "Entity_ListByGuids" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json new file mode 100644 index 000000000000..c4ce33dd6345 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1" + }, + "responses": { + "200": { + "body": { + "referredEntities": {}, + "entities": [ + { + "typeName": "column", + "attributes": { + "owner": null, + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "name": "ExampleName1", + "description": null, + "type": "string" + }, + "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553072455110, + "updateTime": 1553072455110, + "version": 0, + "relationshipAttributes": { + "schema": [], + "inputToProcesses": [], + "composeSchema": { + "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929", + "typeName": "tabular_schema", + "displayText": "tabular_schema", + "relationshipGuid": "400fd8e4-97bd-45eb-a21c-880b4094ce5b", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "tabular_schema_columns" + } + }, + "meanings": [], + "outputFromProcesses": [], + "tabular_schema": null + } + } + ] + } + } + }, + "title": "Entity_ListByUniqueAttributes", + "operationId": "Entity_ListByUniqueAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json new file mode 100644 index 000000000000..3ba4742d9a49 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "collectionId": "ExampleNewCollection", + "api-version": "2023-09-01", + "moveEntitiesRequest": { + "entityGuids": [ + "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "b2f9c306-cf65-4bb0-878e-cfaafde156b1" + ] + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "UPDATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount" + }, + "lastModifiedTS": "3", + "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1", + "status": "ACTIVE" + }, + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount2" + }, + "lastModifiedTS": "2", + "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "status": "ACTIVE" + } + ] + }, + "guidAssignments": { + "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2", + "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1" + } + } + } + }, + "title": "Entity_MoveEntitiesToCollection", + "operationId": "Entity_MoveEntitiesToCollection" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json new file mode 100644 index 000000000000..4320bdb7e9a7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateAttributeByGuid.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "394d9a03-912e-483b-bbd2-bedee1a69798", + "name": "ExampleName", + "body": "ExampleNewName" + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "CREATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "lastModifiedTS": "1", + "guid": "394d9a03-912e-483b-bbd2-bedee1a69798", + "status": "ACTIVE" + } + ] + }, + "partialUpdatedEntities": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "lastModifiedTS": "1", + "guid": "394d9a03-912e-483b-bbd2-bedee1a69798" + } + ] + } + } + }, + "title": "Entity_PartialUpdateAttributeByGuid", + "operationId": "Entity_PartialUpdateAttributeByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json new file mode 100644 index 000000000000..50f18d78fe73 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "atlasEntityWithExtInfo": { + "entity": { + "createTime": 1605766397985.0, + "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", + "relationshipAttributes": { + "services": [], + "meanings": [] + }, + "status": "ACTIVE", + "updateTime": 1605766397985.0, + "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", + "lastModifiedTS": "1", + "version": 0.0, + "attributes": { + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "createTime": 0, + "name": "ExampleNewName" + }, + "typeName": "azure_storage_account" + }, + "referredEntities": {} + } + }, + "responses": { + "200": { + "body": { + "guidAssignments": {}, + "mutatedEntities": { + "PARTIAL_UPDATE": [ + { + "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", + "lastModifiedTS": "2", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "typeName": "azure_storage_account" + } + ] + }, + "partialUpdatedEntities": [ + { + "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", + "lastModifiedTS": "2", + "attributes": { + "qualifiedName": "https://exampleaccount.core.windows.net" + }, + "typeName": "azure_storage_account" + } + ] + } + } + }, + "title": "Entity_PartialUpdateByUniqueAttributes", + "operationId": "Entity_PartialUpdateByUniqueAttributes" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json new file mode 100644 index 000000000000..befe2788c6a8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "bmName": "myBizMetaData1", + "body": { + "bizAttr1": "bizAttr1" + } + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveBusinessAttribute", + "operationId": "Entity_RemoveBusinessAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json new file mode 100644 index 000000000000..9e2de7361e36 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": { + "myBizMetadata1": { + "bizAttr1": "myBizMetaData1.bizAttr1" + } + } + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveBusinessMetadata", + "operationId": "Entity_RemoveBusinessMetadata" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json new file mode 100644 index 000000000000..408744950b01 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassification.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", + "classificationName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveClassification", + "operationId": "Entity_RemoveClassification" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json new file mode 100644 index 000000000000..75717c4f59ad --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveClassificationByUniqueAttribute.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "column", + "classificationName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", + "attr:qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer/exampledata.csv" + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveClassificationByUniqueAttribute", + "operationId": "Entity_RemoveClassificationByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json new file mode 100644 index 000000000000..3ae4c0b565f8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "Asset", + "attr:qualifiedName": "https://asset1", + "body": [ + "label1" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveLabelsByUniqueAttribute", + "operationId": "Entity_RemoveLabelsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json new file mode 100644 index 000000000000..9ffba096b022 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "Asset", + "attr:qualifiedName": "https://asset1", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_SetLabelsByUniqueAttribute", + "operationId": "Entity_SetLabelsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json new file mode 100644 index 000000000000..fc3eb1207d16 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "entity": { + "referredEntities": {}, + "entity": { + "typeName": "azure_storage_account", + "attributes": { + "owner": "ExampleOwner", + "modifiedTime": 0, + "createTime": 0, + "qualifiedName": "exampleaccount", + "name": "ExampleStorageAccount", + "description": null, + "publicAccessLevel": null + }, + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Owner": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Owner Info" + } + ] + }, + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + } + }, + "responses": { + "200": { + "body": { + "mutatedEntities": { + "UPDATE": [ + { + "typeName": "azure_storage_account", + "attributes": { + "qualifiedName": "exampleaccount" + }, + "lastModifiedTS": "2", + "guid": "029d5668-a36c-40a9-bc11-6f352bafdc3b" + } + ] + }, + "guidAssignments": { + "-9514774903018167": "029d5668-a36c-40a9-bc11-6f352bafdc3b" + } + } + } + }, + "title": "Entity_Update", + "operationId": "Entity_Update" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json new file mode 100644 index 000000000000..bdf3ce57c20f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", + "classifications": [ + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", + "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" + }, + { + "typeName": "MICROSOFT.FINANCIAL.US_BANK_ACCOUNT_NUMBER", + "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_UpdateClassifications", + "operationId": "Entity_UpdateClassifications" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json new file mode 100644 index 000000000000..acc71465ee0d --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_storage_account", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "atlasClassificationArray": [ + { + "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" + }, + { + "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_UpdateClassificationsByUniqueAttribute", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json new file mode 100644 index 000000000000..f5805466ff13 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "relatedObjectIds": [ + { + "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", + "relationshipAttributes": { + "attributes": { + "expression": "Example Expression", + "confidence": 100, + "description": "Example Description", + "source": "ExampleSource" + } + } + } + ] + }, + "responses": { + "204": {} + }, + "title": "Glossary_AssignTermToEntities", + "operationId": "Glossary_AssignTermToEntities" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json new file mode 100644 index 000000000000..2af15856d99f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "atlasGlossary": { + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "language": "en", + "usage": "Example Glossary" + } + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688 + } + } + }, + "title": "Glossary_Create", + "operationId": "Glossary_Create" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json new file mode 100644 index 000000000000..5e56de8fc2a1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryCategory": [ + { + "name": "ExampleCategory2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + } + }, + { + "name": "ExampleCategory3", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + } + } + ] + }, + "responses": { + "200": { + "body": [ + { + "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + } + }, + { + "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "qualifiedName": "ExampleCategory3@Glossary", + "name": "ExampleCategory3", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + } + } + ] + } + }, + "title": "Glossary_CreateCategories", + "operationId": "Glossary_CreateCategories" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json new file mode 100644 index 000000000000..cee2e98178e0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryCategory": { + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "name": "ExampleCategory1", + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + } + ] + } + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_CreateCategory", + "operationId": "Glossary_CreateCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json new file mode 100644 index 000000000000..d9ff8a381e4e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryTerm": { + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T1", + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward info" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + } + } + } + }, + "title": "Glossary_CreateTerm", + "operationId": "Glossary_CreateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json new file mode 100644 index 000000000000..a9367908ade4 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryTerm": { + "name": "ExampleTerm", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "attributes": { + "ExampleTermTemplateAttribute": { + "plain string": "Example String", + "date": 1606233600000, + "single choice": "Example Single Choice A", + "multi choice": [ + "Example Multi Choice A", + "Example Multi Choice B" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "guid": "9390cc82-1077-403e-a4d2-b6a69834707b", + "qualifiedName": "ExampleTerm@Glossary", + "name": "ExampleTerm", + "lastModifiedTS": "1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "attributes": { + "ExampleTermTemplateAttribute": { + "plain string": "Example String", + "date": 1606233600000, + "single choice": "Example Single Choice A", + "multi choice": [ + "Example Multi Choice A", + "Example Multi Choice B" + ] + } + } + } + } + }, + "title": "Glossary_CreateTermWithTemplate", + "operationId": "Glossary_CreateTermWithTemplate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json new file mode 100644 index 000000000000..1c74cfa028c0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryTerm": [ + { + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "name": "ExampleTerm2", + "status": "Approved", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T2", + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + { + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "name": "ExampleTerm3", + "status": "Approved", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "abbreviation": "T3", + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + ] + }, + "responses": { + "200": { + "body": [ + { + "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T2", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + { + "guid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", + "qualifiedName": "ExampleTerm3@Glossary", + "name": "ExampleTerm3", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T3", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "f4de4878-3e43-4f8b-b090-07a233bb0ce6" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + ] + } + }, + "title": "Glossary_CreateTerms", + "operationId": "Glossary_CreateTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json new file mode 100644 index 000000000000..66d0c8e21a8d --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" + }, + "responses": { + "204": {} + }, + "title": "Glossary_Delete", + "operationId": "Glossary_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json new file mode 100644 index 000000000000..814f4a434f6f --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" + }, + "responses": { + "204": {} + }, + "title": "Glossary_DeleteCategory", + "operationId": "Glossary_DeleteCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json new file mode 100644 index 000000000000..edfc59de8017 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + }, + "responses": { + "204": {} + }, + "title": "Glossary_DeleteTerm", + "operationId": "Glossary_DeleteTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json new file mode 100644 index 000000000000..1f99715ebf1e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" + }, + "responses": { + "200": { + "body": { + "guid": "47029611-67a1-42d5-8766-90eb904f7f22", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "29d88363-9677-4ce6-aeee-5fdf45f84e9b", + "relationGuid": "fb3d4ac4-27e0-45a2-bb13-105214e0ef7e", + "displayText": "ExampleTerm3" + }, + { + "termGuid": "e5136a91-bc02-49da-81f4-f075bd54b8f5", + "relationGuid": "741186cd-1d62-4798-8e58-6cbe35105baa", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "68347d87-ae38-43b4-a62c-0fdc25b54cb1", + "relationGuid": "2f2b1fe6-d2b6-4aef-81cd-bea7a510312e", + "displayText": "ExampleTerm2" + } + ] + } + } + }, + "title": "Glossary_Get", + "operationId": "Glossary_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json new file mode 100644 index 000000000000..230d037dad82 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", + "displayText": "ExampleCategory3" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_GetCategory", + "operationId": "Glossary_GetCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json new file mode 100644 index 000000000000..d302e7e999a8 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + } + ], + "termInfo": { + "54688d39-b298-4104-9e80-f2a16f44aaea": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "2", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606290587593, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "assignedEntities": [ + { + "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", + "typeName": "hdfs_path", + "entityStatus": "ACTIVE", + "displayText": "1", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": "Example Expression", + "createdBy": "ExampleCreator", + "steward": "ExampleSteward", + "confidence": 100, + "description": "Example Description", + "source": "Azure", + "status": null + } + } + } + ], + "categories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007" + } + ], + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + "952c7ba4-4c89-42d8-a05a-7d2161be7008": { + "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T2", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189" + }, + "seeAlso": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm1" + } + ], + "synonyms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm1" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + }, + "categoryInfo": { + "ed7458f0-9463-48a5-b5c6-4f785fb34e12": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "longDescription": "Example Long Description", + "lastModifiedTS": "3", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + }, + "e47c4584-daca-4f9e-9092-194e04692c9a": { + "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + }, + "childrenCategories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + } + ] + }, + "0d6766f6-f4b6-435b-bda2-d3edc358998e": { + "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory3", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + }, + "parentCategory": { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + } + } + } + } + }, + "title": "Glossary_GetDetailed", + "operationId": "Glossary_GetDetailed" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json new file mode 100644 index 000000000000..9b89e65e50f1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "assignedEntities": [ + { + "guid": "7e255139-b654-4c8d-a4bd-fbb5a243e83f", + "typeName": "azure_datalake_gen2_path", + "entityStatus": "ACTIVE", + "displayText": "moviesDB.csv", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "ace36560-6259-4e7f-9214-3850b2af0a86", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": null, + "createdBy": null, + "steward": null, + "confidence": null, + "description": null, + "source": null, + "status": null + } + } + } + ] + } + } + }, + "title": "Glossary_GetTerm", + "operationId": "Glossary_GetTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json new file mode 100644 index 000000000000..bdf443c37c65 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "excludeRelationshipTypes": [ + "AtlasGlossarySemanticAssignment" + ] + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + } + }, + "title": "Glossary_GetTermWithoutAssets", + "operationId": "Glossary_GetTermWithoutAssets" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json new file mode 100644 index 000000000000..c454ce6b68f7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "limit": "1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675688, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + ] + } + }, + "title": "Glossary_List", + "operationId": "Glossary_List" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json new file mode 100644 index 000000000000..ca06ec508a72 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + }, + { + "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d" + }, + "childrenCategories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + } + ] + }, + { + "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory3", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2" + }, + "parentCategory": { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f" + } + } + ] + } + }, + "title": "Glossary_ListCategories", + "operationId": "Glossary_ListCategories" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json new file mode 100644 index 000000000000..ebd4d7c6acc9 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + }, + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + } + ] + } + }, + "title": "Glossary_ListCategoriesHeaders", + "operationId": "Glossary_ListCategoriesHeaders" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json new file mode 100644 index 000000000000..091df398e96c --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + }, + "title": "Glossary_ListCategoryTerms", + "operationId": "Glossary_ListCategoryTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json new file mode 100644 index 000000000000..d2be6d8d0f3c --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "ea116881-222e-41c8-8acb-9af6f6f60009", + "typeName": "column", + "entityStatus": "ACTIVE", + "displayText": "ExampleColumnName", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "ff9023a5-8495-49d6-bf04-a22c3634151e", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": null, + "createdBy": null, + "steward": null, + "confidence": null, + "description": null, + "source": null, + "status": null + } + } + }, + { + "guid": "fbf0a84d-7080-456b-b889-b5ba42186c2e", + "typeName": "azure_blob_path", + "entityStatus": "ACTIVE", + "displayText": "exampledata.csv", + "relationshipType": "AtlasGlossarySemanticAssignment", + "relationshipGuid": "dedc1294-a893-4e52-ba27-6be9b8694748", + "relationshipStatus": "ACTIVE", + "relationshipAttributes": { + "typeName": "AtlasGlossarySemanticAssignment", + "attributes": { + "expression": null, + "createdBy": null, + "steward": null, + "confidence": null, + "description": null, + "source": null, + "status": null + } + } + } + ] + } + }, + "title": "Glossary_ListEntitiesAssignedWithTerm", + "operationId": "Glossary_ListEntitiesAssignedWithTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json new file mode 100644 index 000000000000..ddd15b9191e1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": { + "parent": [ + { + "categoryGuid": "6c8233cd-f6dc-6ef7-5597-b18ab590f2fc", + "relationGuid": "25cf5e46-c551-4ed4-8919-505c29ae311d" + } + ], + "children": [ + { + "categoryGuid": "abc6ac1b-5700-9c70-3f5a-60a519150035", + "parentCategoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", + "relationGuid": "12d41563-2fd9-4be5-9eb9-9908f811a8f2", + "displayText": "ExampleCategory4" + } + ] + } + } + }, + "title": "Glossary_ListRelatedCategories", + "operationId": "Glossary_ListRelatedCategories" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json new file mode 100644 index 000000000000..33619369a434 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": { + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ] + } + } + }, + "title": "Glossary_ListRelatedTerms", + "operationId": "Glossary_ListRelatedTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json new file mode 100644 index 000000000000..24dbbdef0dfd --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ] + } + }, + "title": "Glossary_ListTermHeaders", + "operationId": "Glossary_ListTermHeaders" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json new file mode 100644 index 000000000000..ddf242126dcd --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "limit": "-1", + "offset": "0", + "sort": "ASC" + }, + "responses": { + "200": { + "body": [ + { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "contacts": { + "Expert": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Expert Info" + } + ], + "Steward": [ + { + "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", + "info": "Example Steward Info" + } + ] + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + }, + { + "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T2", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287312495, + "updateTime": 1606287312495, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189" + }, + "seeAlso": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm1" + } + ], + "synonyms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm1" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + ] + } + }, + "title": "Glossary_ListTerms", + "operationId": "Glossary_ListTerms" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json new file mode 100644 index 000000000000..6b1d846fd25e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "partialUpdates": { + "longDescription": "Example Long Description" + } + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "3", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675600, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + } + }, + "title": "Glossary_PartialUpdate", + "operationId": "Glossary_PartialUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json new file mode 100644 index 000000000000..b1b3b5eb05b7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", + "partialUpdates": { + "longDescription": "Example Long Description" + } + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "longDescription": "Example Long Description", + "lastModifiedTS": "3", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", + "displayText": "ExampleCategory3" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_PartialUpdateCategory", + "operationId": "Glossary_PartialUpdateCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json new file mode 100644 index 000000000000..e2bc0df64883 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "partialUpdates": { + "longDescription": "Example Long Descrition" + } + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Descrition", + "lastModifiedTS": "2", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606290587593, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "categories": [ + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleCategory1" + } + ], + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + } + }, + "title": "Glossary_PartialUpdateTerm", + "operationId": "Glossary_PartialUpdateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json new file mode 100644 index 000000000000..29c16783845a --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "relatedObjectIds": [ + { + "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", + "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" + } + ] + }, + "responses": { + "204": {} + }, + "title": "Glossary_RemoveTermAssignmentFromEntities", + "operationId": "Glossary_RemoveTermAssignmentFromEntities" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json new file mode 100644 index 000000000000..4eabcf439a58 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "updatedGlossary": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", + "language": "en", + "usage": "Example Glossary", + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + }, + "responses": { + "200": { + "body": { + "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "qualifiedName": "Glossary", + "name": "Glossary", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "2", + "language": "en", + "usage": "Example Glossary", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1672892675600, + "updateTime": 1672892675688, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", + "displayText": "ExampleTerm1" + }, + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", + "displayText": "ExampleTerm2" + } + ], + "categories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", + "displayText": "ExampleCategory3" + }, + { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", + "displayText": "ExampleCategory1" + }, + { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", + "displayText": "ExampleCategory2" + } + ] + } + } + }, + "title": "Glossary_Update", + "operationId": "Glossary_Update" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json new file mode 100644 index 000000000000..a195f431da37 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "glossaryCategory": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "1", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007" + } + ], + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e" + } + ], + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a" + } + } + }, + "responses": { + "200": { + "body": { + "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "qualifiedName": "ExampleCategory1.Category2@Glossary", + "name": "ExampleCategory1", + "lastModifiedTS": "2", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0" + }, + "parentCategory": { + "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", + "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20" + }, + "childrenCategories": [ + { + "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", + "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", + "displayText": "ExampleCategory3" + } + ], + "terms": [ + { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", + "displayText": "ExampleTerm1" + } + ] + } + } + }, + "title": "Glossary_UpdateCategory", + "operationId": "Glossary_UpdateCategory" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json new file mode 100644 index 000000000000..4fb70086784b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "glossaryTerm": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ], + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18" + } + ] + } + }, + "responses": { + "200": { + "body": { + "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "lastModifiedTS": "1", + "abbreviation": "T1", + "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createTime": 1606287247276, + "updateTime": 1606287247276, + "status": "Approved", + "anchor": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" + }, + "seeAlso": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", + "displayText": "ExampleTerm2" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", + "relationGuid": "4d802ada-65f3-45a8-969f-aba47d9c6200", + "displayText": "ExampleTerm3" + } + ], + "synonyms": [ + { + "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", + "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", + "displayText": "ExampleTerm2" + }, + { + "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", + "relationGuid": "bb26fe7c-6e26-46ad-b936-50a5f7ffbbaf", + "displayText": "ExampleTerm3" + } + ], + "resources": [ + { + "displayName": "Example Display Name", + "url": "Example Url" + } + ] + } + } + }, + "title": "Glossary_UpdateTerm", + "operationId": "Glossary_UpdateTerm" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json new file mode 100644 index 000000000000..a08de217b1c0 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "depth": "1", + "width": "5", + "direction": "INPUT" + }, + "responses": { + "200": { + "body": { + "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "lineageDirection": "INPUT", + "lineageDepth": 1, + "lineageWidth": 1, + "childrenCount": 1, + "guidEntityMap": {}, + "widthCounts": {}, + "relations": [], + "parentRelations": [] + } + } + }, + "title": "Lineage_Get", + "operationId": "Lineage_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json new file mode 100644 index 000000000000..ab738e50995b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetByUniqueAttribute.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typeName": "azure_blob_path", + "depth": "2", + "width": "2", + "direction": "BOTH", + "attr:qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/" + }, + "responses": { + "200": { + "body": { + "baseEntityGuid": "9b2751f1-2633-4f06-a578-e14fab4c52fd", + "lineageDirection": "BOTH", + "lineageDepth": 2, + "lineageWidth": 2, + "childrenCount": -1, + "guidEntityMap": { + "9b2751f1-2633-4f06-a578-e14fab4c52fd": { + "typeName": "azure_blob_path", + "attributes": { + "owner": "testOwner", + "modifiedTime": 0, + "qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/", + "isBlob": false, + "accessTierInferred": false, + "description": "testDesc", + "committedBlockCount": 0, + "path": "/test/AzureBlobPath.json", + "size": 731, + "createTime": 0, + "name": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3", + "blobType": "BlockBlob", + "serverEncrypted": true + }, + "lastModifiedTS": "1", + "guid": "9b2751f1-2633-4f06-a578-e14fab4c52fd", + "status": "ACTIVE", + "displayText": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3", + "classificationNames": [ + "MICROSOFT.PERSONAL.EMAIL", + "MICROSOFT.PERSONAL.NAME" + ], + "meaningNames": [], + "meanings": [], + "isIncomplete": false, + "labels": [] + } + }, + "relations": [], + "parentRelations": [], + "widthCounts": { + "INPUT": { + "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0 + }, + "OUTPUT": { + "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0 + } + } + } + } + }, + "title": "Lineage_GetByUniqueAttribute", + "operationId": "Lineage_GetByUniqueAttribute" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json new file mode 100644 index 000000000000..778a391f5b59 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Lineage_GetNextPage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "offset": "0", + "limit": "5", + "direction": "INPUT", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a", + "lineageDirection": "INPUT", + "lineageDepth": 1, + "lineageWidth": 1, + "childrenCount": 1, + "guidEntityMap": {}, + "widthCounts": {}, + "relations": [], + "parentRelations": [] + } + } + }, + "title": "Lineage_GetNextPage", + "operationId": "Lineage_GetNextPage" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json new file mode 100644 index 000000000000..883d47b5986c --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "relationship": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "end1": { + "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + }, + "responses": { + "200": { + "body": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "guid": "63023d5b-c499-4360-a513-16bcbf73b039", + "end1": { + "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553840134724, + "updateTime": 1553840134724, + "version": 0 + } + } + }, + "title": "Relationship_Create", + "operationId": "Relationship_Create" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json new file mode 100644 index 000000000000..c6e4848b9952 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb" + }, + "responses": { + "204": {} + }, + "title": "Relationship_Delete", + "operationId": "Relationship_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json new file mode 100644 index 000000000000..182684f354bd --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "extendedInfo": "false" + }, + "responses": { + "200": { + "body": { + "relationship": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": null, + "steward": null, + "description": null, + "source": null, + "status": null + }, + "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b", + "end1": { + "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553838993803, + "updateTime": 1553838993803, + "version": 0 + } + } + } + }, + "title": "Relationship_Get", + "operationId": "Relationship_Get" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json new file mode 100644 index 000000000000..6287df03708b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "relationship": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "guid": "b2810301-293f-493f-88f1-7ac8784fb1fd", + "end1": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "version": 0 + } + }, + "responses": { + "200": { + "body": { + "typeName": "AtlasGlossarySynonym", + "attributes": { + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", + "source": null, + "status": null + }, + "guid": "b2810301-293f-493f-88f1-7ac8784fb1fd", + "end1": { + "guid": "77481037-2874-9bdc-9b9e-76bb94ee71aa", + "typeName": "AtlasGlossaryTerm" + }, + "end2": { + "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef", + "typeName": "AtlasGlossaryTerm" + }, + "label": "r:AtlasGlossarySynonym", + "status": "ACTIVE", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553839805039, + "updateTime": 1553839805039, + "version": 0 + } + } + }, + "title": "Relationship_Update", + "operationId": "Relationship_Update" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json new file mode 100644 index 000000000000..cdb16a858b47 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typesDef": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "name": "azure_sql_server_example", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + } + ], + "relationshipDefs": [] + } + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "category": "ENTITY", + "guid": "a47fd902-a564-45f1-aa51-ce9224955881", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553672211954, + "updateTime": 1553672211954, + "version": 1, + "name": "azure_sql_server_example", + "description": "azure_sql_server_example", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "azure_resource" + ], + "subTypes": [] + } + ], + "relationshipDefs": [] + } + } + }, + "title": "Type_BulkCreate", + "operationId": "Type_BulkCreate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json new file mode 100644 index 000000000000..187d6e01ac31 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typesDef": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [], + "businessMetadataDefs": [ + { + "name": "myBizMetadata1", + "description": "", + "attributeDefs": [ + { + "name": "bizAttr1", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "isUnique": false, + "isIndexable": true, + "options": { + "maxStrLength": "50", + "applicableEntityTypes": "[\"Path\"]" + } + } + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [], + "businessMetadataDefs": [ + { + "category": "BUSINESS_METADATA", + "guid": "f26dc6d1-be9c-a0ce-a274-b6388ff6e2eb", + "createdBy": "ServiceAdmin", + "updatedBy": "ServiceAdmin", + "createTime": 1646994112241, + "updateTime": 1646994112241, + "version": 1, + "name": "myBizMetadata1", + "description": "This is my businessMetadata1", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "bizAttr1", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": true, + "includeInNotification": false, + "options": { + "applicableEntityTypes": "[\"Path\"]", + "maxStrLength": "50" + } + } + ] + } + ] + } + } + }, + "title": "Type_BulkCreateBusinessMetadataDefs", + "operationId": "Type_BulkCreateBusinessMetadataDefs" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json new file mode 100644 index 000000000000..eda61c210ee7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typesDef": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "name": "azure_sql_server_example", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + } + ], + "relationshipDefs": [] + } + }, + "responses": { + "204": {} + }, + "title": "Type_BulkDelete", + "operationId": "Type_BulkDelete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json new file mode 100644 index 000000000000..3216472dba52 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json @@ -0,0 +1,290 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "typesDef": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "name": "azure_sql_server", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + }, + { + "name": "azure_sql_db", + "superTypes": [ + "azure_resource" + ], + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "server", + "typeName": "azure_sql_server", + "cardinality": "SINGLE", + "constraints": [ + { + "type": "inverseRef", + "params": { + "attribute": "databases" + } + } + ], + "isIndexable": false, + "isOptional": false, + "isUnique": false + }, + { + "name": "schemas", + "typeName": "array", + "cardinality": "SET", + "isIndexable": false, + "isOptional": true, + "isUnique": false + }, + { + "name": "collation", + "typeName": "string", + "cardinality": "SINGLE", + "isIndexable": false, + "isOptional": true, + "isUnique": false + }, + { + "name": "compatibilityLevel", + "typeName": "int", + "cardinality": "SINGLE", + "isIndexable": false, + "isOptional": true, + "isUnique": false + } + ] + } + ], + "relationshipDefs": [ + { + "name": "azure_sql_server_databases", + "typeVersion": "1.0", + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_server", + "name": "databases", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_db", + "name": "server", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + } + }, + { + "name": "azure_sql_db_schemas", + "typeVersion": "1.0", + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_db", + "name": "schemas", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_schema", + "name": "db", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [ + { + "category": "ENTITY", + "guid": "a59fe369-2b1d-4bba-bb74-c273f3d74eb1", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841689501, + "updateTime": 1553671448662, + "version": 3, + "name": "azure_sql_server", + "description": "azure_sql_server", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "databases", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "azure_resource" + ], + "subTypes": [] + }, + { + "category": "ENTITY", + "guid": "cc33ec5a-205a-4853-91dd-c0ebd0049ffb", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841689575, + "updateTime": 1553671448783, + "version": 3, + "name": "azure_sql_db", + "description": "azure_sql_db", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "server", + "typeName": "azure_sql_server", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "constraints": [ + { + "type": "inverseRef", + "params": { + "attribute": "databases" + } + } + ] + }, + { + "name": "schemas", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "collation", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "compatibilityLevel", + "typeName": "int", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "azure_resource" + ], + "subTypes": [] + } + ], + "relationshipDefs": [ + { + "category": "RELATIONSHIP", + "guid": "1e0584a8-2587-4e1d-a772-db1e879469af", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841689879, + "updateTime": 1553671449536, + "version": 3, + "name": "azure_sql_server_databases", + "description": "azure_sql_server_databases", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_server", + "name": "databases", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_db", + "name": "server", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + }, + "relationshipLabel": "r:azure_sql_server_databases" + }, + { + "category": "RELATIONSHIP", + "guid": "77ee34f6-ea48-4fe3-86bf-7e2e722f4596", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1548841690094, + "updateTime": 1553671449545, + "version": 3, + "name": "azure_sql_db_schemas", + "description": "azure_sql_db_schemas", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "COMPOSITION", + "endDef1": { + "type": "azure_sql_db", + "name": "schemas", + "isContainer": true, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "azure_sql_schema", + "name": "db", + "isContainer": false, + "cardinality": "SINGLE", + "isLegacyAttribute": true + }, + "relationshipLabel": "r:azure_sql_db_schemas" + } + ] + } + } + }, + "title": "Type_BulkUpdate", + "operationId": "Type_BulkUpdate" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json new file mode 100644 index 000000000000..8a364027401e --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "hive_order" + }, + "responses": { + "204": {} + }, + "title": "Type_Delete", + "operationId": "Type_Delete" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json new file mode 100644 index 000000000000..34921a8239b7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByGuid.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "d8757510-c866-61ba-486f-1afca09f43b8" + }, + "responses": { + "200": { + "body": { + "category": "BUSINESS_METADATA", + "guid": "d8757510-c866-61ba-486f-1afca09f43b8", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1671545620780, + "updateTime": 1671545620780, + "version": 1, + "name": "Business_Metadata_Type_Name", + "description": "Business_Metadata_Type_Name", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "customAttribute", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "maxStrLength": "5000", + "isDisabled": "false", + "applicableEntityTypes": "[\"DataSet\"]" + } + } + ] + } + } + }, + "title": "Type_GetBusinessMetadataDefByGuid", + "operationId": "Type_GetBusinessMetadataDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json new file mode 100644 index 000000000000..64d92fefd723 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetBusinessMetadataDefByName.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "Business_Metadata_Type_Name" + }, + "responses": { + "200": { + "body": { + "category": "BUSINESS_METADATA", + "guid": "d8757510-c866-61ba-486f-1afca09f43b8", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1671545620780, + "updateTime": 1671545620780, + "version": 1, + "name": "Business_Metadata_Type_Name", + "description": "Business_Metadata_Type_Name", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "customAttribute", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "maxStrLength": "5000", + "isDisabled": "false", + "applicableEntityTypes": "[\"DataSet\"]" + } + } + ] + } + } + }, + "title": "Type_GetBusinessMetadataDefByName", + "operationId": "Type_GetBusinessMetadataDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json new file mode 100644 index 000000000000..e94b5ad8b518 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByGuid.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetByGuid", + "operationId": "Type_GetByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json new file mode 100644 index 000000000000..804029d070e1 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetByName.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "glossary_term_status_value" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetByName", + "operationId": "Type_GetByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json new file mode 100644 index 000000000000..bf27840af6aa --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByGuid.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49" + }, + "responses": { + "200": { + "body": { + "category": "CLASSIFICATION", + "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065966043, + "updateTime": 1553065966043, + "version": 1, + "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER", + "description": "Canada Social Insurance Number", + "typeVersion": "1.0", + "attributeDefs": [], + "superTypes": [], + "entityTypes": [], + "subTypes": [] + } + } + }, + "title": "Type_GetClassificationDefByGuid", + "operationId": "Type_GetClassificationDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json new file mode 100644 index 000000000000..e7a58bf32bfb --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetClassificationDefByName.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER" + }, + "responses": { + "200": { + "body": { + "category": "CLASSIFICATION", + "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065966043, + "updateTime": 1553065966043, + "version": 1, + "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER", + "description": "Canada Social Insurance Number", + "typeVersion": "1.0", + "attributeDefs": [], + "superTypes": [], + "entityTypes": [], + "subTypes": [] + } + } + }, + "title": "Type_GetClassificationDefByName", + "operationId": "Type_GetClassificationDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json new file mode 100644 index 000000000000..9c0d6ce53cb7 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByGuid.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43" + }, + "responses": { + "200": { + "body": { + "category": "ENTITY", + "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065960959, + "updateTime": 1553065960959, + "version": 1, + "name": "DataSet", + "description": "DataSet", + "typeVersion": "1.1", + "attributeDefs": [], + "superTypes": [ + "Asset" + ], + "subTypes": [ + "rdbms_foreign_key", + "azure_datalake_gen1_path", + "hive_table", + "mssql_column", + "sqoop_dbdatastore", + "hbase_column", + "azure_sql_table", + "rdbms_instance", + "azure_datalake_gen2_path", + "jms_topic", + "falcon_feed", + "hbase_table", + "rdbms_table", + "rdbms_column", + "hbase_column_family", + "hive_column", + "azure_blob_container", + "rdbms_db", + "column", + "azure_blob_path", + "kafka_topic", + "tabular_schema", + "azure_datalake_gen2_filesystem", + "rdbms_index", + "azure_sql_column", + "mssql_table", + "avro_type", + "fs_path" + ] + } + } + }, + "title": "Type_GetEntityDefByGuid", + "operationId": "Type_GetEntityDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json new file mode 100644 index 000000000000..140ba1a5b309 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEntityDefByName.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "DataSet" + }, + "responses": { + "200": { + "body": { + "category": "ENTITY", + "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065960959, + "updateTime": 1553065960959, + "version": 1, + "name": "DataSet", + "description": "DataSet", + "typeVersion": "1.1", + "attributeDefs": [], + "superTypes": [ + "Asset" + ], + "subTypes": [ + "rdbms_foreign_key", + "azure_datalake_gen1_path", + "hive_table", + "mssql_column", + "sqoop_dbdatastore", + "hbase_column", + "azure_sql_table", + "rdbms_instance", + "azure_datalake_gen2_path", + "jms_topic", + "falcon_feed", + "hbase_table", + "rdbms_table", + "rdbms_column", + "hbase_column_family", + "hive_column", + "azure_blob_container", + "rdbms_db", + "column", + "azure_blob_path", + "kafka_topic", + "tabular_schema", + "azure_datalake_gen2_filesystem", + "rdbms_index", + "azure_sql_column", + "mssql_table", + "avro_type", + "fs_path" + ] + } + } + }, + "title": "Type_GetEntityDefByName", + "operationId": "Type_GetEntityDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json new file mode 100644 index 000000000000..ab9e4048b0d2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByGuid.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968102, + "updateTime": 1553065968102, + "version": 1, + "name": "hive_principal_type", + "description": "hive_principal_type", + "typeVersion": "1.0", + "elementDefs": [ + { + "value": "USER", + "ordinal": 1 + }, + { + "value": "ROLE", + "ordinal": 2 + }, + { + "value": "GROUP", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetEnumDefByGuid", + "operationId": "Type_GetEnumDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json new file mode 100644 index 000000000000..62907f8f6a69 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetEnumDefByName.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "hive_principal_type" + }, + "responses": { + "200": { + "body": { + "category": "ENUM", + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968102, + "updateTime": 1553065968102, + "version": 1, + "name": "hive_principal_type", + "description": "hive_principal_type", + "typeVersion": "1.0", + "elementDefs": [ + { + "value": "USER", + "ordinal": 1 + }, + { + "value": "ROLE", + "ordinal": 2 + }, + { + "value": "GROUP", + "ordinal": 3 + } + ] + } + } + }, + "title": "Type_GetEnumDefByName", + "operationId": "Type_GetEnumDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json new file mode 100644 index 000000000000..71c9a03a65d9 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByGuid.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45" + }, + "responses": { + "200": { + "body": { + "category": "RELATIONSHIP", + "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065976797, + "updateTime": 1553065976797, + "version": 1, + "name": "storm_topology_nodes", + "description": "storm_topology_nodes", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "ASSOCIATION", + "endDef1": { + "type": "storm_topology", + "name": "nodes", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "storm_node", + "name": "topolgies", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": false + }, + "relationshipLabel": "r:storm_topology_nodes" + } + } + }, + "title": "Type_GetRelationshipDefByGuid", + "operationId": "Type_GetRelationshipDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json new file mode 100644 index 000000000000..ecdafc07a934 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetRelationshipDefByName.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "storm_topology_nodes" + }, + "responses": { + "200": { + "body": { + "category": "RELATIONSHIP", + "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065976797, + "updateTime": 1553065976797, + "version": 1, + "name": "storm_topology_nodes", + "description": "storm_topology_nodes", + "typeVersion": "1.0", + "attributeDefs": [], + "relationshipCategory": "ASSOCIATION", + "endDef1": { + "type": "storm_topology", + "name": "nodes", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "storm_node", + "name": "topolgies", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": false + }, + "relationshipLabel": "r:storm_topology_nodes" + } + } + }, + "title": "Type_GetRelationshipDefByName", + "operationId": "Type_GetRelationshipDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json new file mode 100644 index 000000000000..c31ae06aeeb6 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByGuid.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437" + }, + "responses": { + "200": { + "body": { + "category": "STRUCT", + "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968145, + "updateTime": 1553065968145, + "version": 1, + "name": "hive_order", + "description": "hive_order", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "order", + "typeName": "int", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "col", + "typeName": "string", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ] + } + } + }, + "title": "Type_GetStructDefByGuid", + "operationId": "Type_GetStructDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json new file mode 100644 index 000000000000..26f8e843a6d6 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetStructDefByName.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "hive_order" + }, + "responses": { + "200": { + "body": { + "category": "STRUCT", + "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1553065968145, + "updateTime": 1553065968145, + "version": 1, + "name": "hive_order", + "description": "hive_order", + "typeVersion": "1.0", + "attributeDefs": [ + { + "name": "order", + "typeName": "int", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "col", + "typeName": "string", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": 1, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ] + } + } + }, + "title": "Type_GetStructDefByName", + "operationId": "Type_GetStructDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json new file mode 100644 index 000000000000..e6c263c691e5 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByGuid.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "category": "TERM_TEMPLATE", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1606300465443, + "updateTime": 1606300465443, + "version": 1, + "name": "MS KPI", + "description": "This is the description", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "date", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "single choice", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "multi choice", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "plain string", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "defaultValue": "this is a default value", + "options": { + "isDisabled": "false" + } + } + ] + } + } + }, + "title": "Type_GetTermTemplateDefByGuid", + "operationId": "Type_GetTermTemplateDefByGuid" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json new file mode 100644 index 000000000000..d8b28d19db05 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_GetTermTemplateDefByName.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "name": "MS KPI", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "category": "TERM_TEMPLATE", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1606300465443, + "updateTime": 1606300465443, + "version": 1, + "name": "MS KPI", + "description": "This is the description", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "date", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "single choice", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "multi choice", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "plain string", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "defaultValue": "this is a default value", + "options": { + "isDisabled": "false" + } + } + ] + } + } + }, + "title": "Type_GetTermTemplateDefByName", + "operationId": "Type_GetTermTemplateDefByName" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json new file mode 100644 index 000000000000..4f9be7fe0434 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "includeTermTemplate": true + }, + "responses": { + "200": { + "body": { + "enumDefs": [ + { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + } + ], + "structDefs": [ + { + "category": "STRUCT", + "guid": "a8892bd7-59d6-47d8-b80d-ba4c7631098f", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604729507664, + "updateTime": 1604729507664, + "version": 1, + "name": "blob_soft_deleted_state", + "description": "blob_soft_deleted_state", + "typeVersion": "1.0", + "serviceType": "Azure Blob Storage", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "deleted", + "typeName": "boolean", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "deletedTime", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "remainingRetentionDays", + "typeName": "long", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ] + } + ], + "classificationDefs": [ + { + "category": "CLASSIFICATION", + "guid": "bd97460e-e5db-4701-8158-5b4062cf8a10", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604730971448, + "updateTime": 1604730971448, + "version": 1, + "name": "MICROSOFT.GOVERNMENT.CHILE.CDI_NUMBER", + "description": "Chile Identity Card Number", + "typeVersion": "1.0", + "options": { + "displayName": "Chile Identity Card Number" + }, + "attributeDefs": [], + "superTypes": [], + "entityTypes": [], + "subTypes": [] + } + ], + "entityDefs": [ + { + "category": "ENTITY", + "guid": "7c53da5d-2797-4e8a-9b89-dd9b3b26ffa8", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604730605047, + "updateTime": 1604730605047, + "version": 1, + "name": "sap_ecc_data_element", + "description": "sap_ecc_data_element", + "typeVersion": "1.0", + "serviceType": "SAP ECC", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "dataType", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "length", + "typeName": "int", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "decimalPlaces", + "typeName": "int", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + }, + { + "name": "documentation", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false + } + ], + "superTypes": [ + "Asset" + ], + "subTypes": [], + "relationshipAttributeDefs": [ + { + "name": "package", + "typeName": "sap_ecc_package", + "isOptional": false, + "cardinality": "SINGLE", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "sap_ecc_package_data_elements", + "isLegacyAttribute": false + }, + { + "name": "table_fields", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "sap_ecc_table_field_data_element", + "isLegacyAttribute": false + }, + { + "name": "domain", + "typeName": "sap_ecc_domain", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "sap_ecc_data_element_domain", + "isLegacyAttribute": false + }, + { + "name": "meanings", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": -1, + "valuesMaxCount": -1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "relationshipTypeName": "AtlasGlossarySemanticAssignment", + "isLegacyAttribute": false + } + ] + } + ], + "relationshipDefs": [ + { + "category": "RELATIONSHIP", + "guid": "6284b865-cbb3-4236-83ed-059a407f06fb", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604729078159, + "updateTime": 1604729323080, + "version": 2, + "name": "storm_topology_nodes", + "description": "storm_topology_nodes", + "typeVersion": "1.1", + "serviceType": "storm", + "lastModifiedTS": "2", + "attributeDefs": [], + "relationshipCategory": "ASSOCIATION", + "endDef1": { + "type": "storm_topology", + "name": "nodes", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": true + }, + "endDef2": { + "type": "storm_node", + "name": "topolgies", + "isContainer": false, + "cardinality": "SET", + "isLegacyAttribute": false + } + } + ] + } + } + }, + "title": "Type_List", + "operationId": "Type_List" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json new file mode 100644 index 000000000000..124002c241bf --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "type": "enum" + }, + "responses": { + "200": { + "body": { + "enumDefs": [ + { + "category": "ENUM", + "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728877305, + "updateTime": 1604728877305, + "version": 1, + "name": "glossary_term_status_value", + "description": "glossary_term_status_value", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "elementDefs": [ + { + "value": "Approved", + "ordinal": 0 + }, + { + "value": "Alert", + "ordinal": 1 + }, + { + "value": "Expired", + "ordinal": 2 + }, + { + "value": "Draft", + "ordinal": 3 + } + ] + }, + { + "category": "ENUM", + "guid": "c694edf1-6f9e-4b60-b832-23e8d6187675", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1604728832692, + "updateTime": 1604728905525, + "version": 2, + "name": "AtlasGlossaryTermRelationshipStatus", + "description": "TermRelationshipStatus defines how reliable the relationship is between two glossary terms", + "typeVersion": "1.1", + "serviceType": "atlas_core", + "lastModifiedTS": "2", + "elementDefs": [ + { + "value": "DRAFT", + "description": "DRAFT means the relationship is under development.", + "ordinal": 0 + }, + { + "value": "ACTIVE", + "description": "ACTIVE means the relationship is validated and in use.", + "ordinal": 1 + }, + { + "value": "DEPRECATED", + "description": "DEPRECATED means the the relationship is being phased out.", + "ordinal": 2 + }, + { + "value": "OBSOLETE", + "description": "OBSOLETE means that the relationship should not be used anymore.", + "ordinal": 3 + }, + { + "value": "OTHER", + "description": "OTHER means that there is another status.", + "ordinal": 99 + } + ] + } + ], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [] + } + } + }, + "title": "Type_ListEnumDefs", + "operationId": "Type_ListEnumDefs" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json new file mode 100644 index 000000000000..288c815d8a88 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListHeaders.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "includeTermTemplate": true + }, + "responses": { + "200": { + "body": [ + { + "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", + "name": "hive_principal_type", + "category": "ENUM" + }, + { + "guid": "e5030e81-da05-4571-84f1-265ce20fa6d9", + "name": "AtlasGlossaryTermRelationshipStatus", + "category": "ENUM" + }, + { + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "name": "MS KPI", + "category": "TERM_TEMPLATE" + } + ] + } + }, + "title": "Type_ListHeaders", + "operationId": "Type_ListHeaders" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json new file mode 100644 index 000000000000..1ca2c36f9cad --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "type": "term_template" + }, + "responses": { + "200": { + "body": { + "enumDefs": [], + "structDefs": [], + "classificationDefs": [], + "entityDefs": [], + "relationshipDefs": [], + "termTemplateDefs": [ + { + "category": "TERM_TEMPLATE", + "guid": "d776af9c-985c-4168-abb2-477523dbfc70", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", + "createTime": 1606300465443, + "updateTime": 1606300465443, + "version": 1, + "name": "MS KPI", + "description": "This is the description", + "typeVersion": "1.0", + "lastModifiedTS": "1", + "attributeDefs": [ + { + "name": "date", + "typeName": "date", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "single choice", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "multi choice", + "typeName": "array", + "isOptional": true, + "cardinality": "SET", + "valuesMinCount": 0, + "valuesMaxCount": 2147483647, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "options": { + "isDisabled": "false" + } + }, + { + "name": "plain string", + "typeName": "string", + "isOptional": true, + "cardinality": "SINGLE", + "valuesMinCount": 0, + "valuesMaxCount": 1, + "isUnique": false, + "isIndexable": false, + "includeInNotification": false, + "defaultValue": "this is a default value", + "options": { + "isDisabled": "false" + } + } + ] + } + ] + } + } + }, + "title": "Type_ListTermTemplateDefs", + "operationId": "Type_ListTermTemplateDefs" +} From 7f6f2e4e1c27bb473a57f03570e94591ac4ab3e5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 15 Nov 2023 16:06:38 +0800 Subject: [PATCH 009/132] update --- .../Azure.Analytics.Purview.DataMap/routes.tsp | 12 ++++++------ .../2023-09-01/examples/Discovery_AutoComplete.json | 4 +++- .../stable/2023-09-01/examples/Discovery_Query.json | 4 +++- .../2023-09-01/examples/Discovery_Query_And.json | 4 +++- .../examples/Discovery_Query_AndOrNested.json | 4 +++- .../examples/Discovery_Query_AssetType.json | 4 +++- .../examples/Discovery_Query_Attribute.json | 4 +++- .../Discovery_Query_BusinessMetadataAttribute.json | 4 +++- .../examples/Discovery_Query_Classification.json | 4 +++- .../examples/Discovery_Query_Collection.json | 4 +++- .../2023-09-01/examples/Discovery_Query_Facet.json | 4 +++- .../examples/Discovery_Query_FileExtension.json | 4 +++- .../examples/Discovery_Query_GlossaryTerm.json | 4 +++- .../2023-09-01/examples/Discovery_Query_Id.json | 4 +++- .../2023-09-01/examples/Discovery_Query_Not.json | 4 +++- .../examples/Discovery_Query_ObjectType.json | 4 +++- .../Discovery_Query_PaginationContinuationPage.json | 4 +++- .../Discovery_Query_PaginationFirstPage.json | 4 +++- .../examples/Discovery_Query_PaginationLastPage.json | 4 +++- .../examples/Discovery_Query_SystemTime.json | 4 +++- .../examples/Discovery_Query_Taxonomy.json | 4 +++- .../examples/Discovery_Query_TermAssignment.json | 4 +++- .../2023-09-01/examples/Discovery_Query_Type.json | 4 +++- .../2023-09-01/examples/Discovery_Suggest.json | 4 +++- .../examples/Entity_AddClassifications.json | 4 +++- .../Entity_AddClassificationsByUniqueAttribute.json | 4 +++- .../examples/Entity_AddLabelsByUniqueAttribute.json | 4 +++- .../examples/Entity_BulkCreateOrUpdate.json | 4 +++- .../2023-09-01/examples/Entity_BulkDelete.json | 4 +++- .../examples/Entity_BulkSetClassifications.json | 4 +++- .../stable/2023-09-01/examples/Entity_Delete.json | 4 +++- .../examples/Entity_DeleteByUniqueAttribute.json | 4 +++- .../stable/2023-09-01/examples/Entity_Get.json | 4 +++- .../examples/Entity_GetByUniqueAttributes.json | 4 +++- .../examples/Entity_GetClassification.json | 4 +++- .../examples/Entity_GetClassifications.json | 4 +++- .../stable/2023-09-01/examples/Entity_GetHeader.json | 4 +++- .../Entity_GetSampleBusinessMetadataTemplate.json | 4 +++- .../examples/Entity_ImportBusinessMetadata.json | 4 +++- .../2023-09-01/examples/Entity_ListByGuids.json | 4 +++- .../examples/Entity_ListByUniqueAttributes.json | 4 +++- .../examples/Entity_MoveEntitiesToCollection.json | 4 +++- .../Entity_PartialUpdateAttributeByGuid.json | 4 +++- .../Entity_PartialUpdateByUniqueAttributes.json | 8 +++++--- .../examples/Entity_RemoveBusinessMetadata.json | 4 +++- .../examples/Entity_RemoveClassification.json | 4 +++- ...Entity_RemoveClassificationByUniqueAttribute.json | 4 +++- .../Entity_RemoveLabelsByUniqueAttribute.json | 4 +++- .../examples/Entity_SetLabelsByUniqueAttribute.json | 4 +++- .../examples/Entity_UpdateClassifications.json | 4 +++- ...ntity_UpdateClassificationsByUniqueAttribute.json | 4 +++- .../examples/Glossary_AssignTermToEntities.json | 4 +++- .../stable/2023-09-01/examples/Glossary_Create.json | 4 +++- .../examples/Glossary_CreateCategories.json | 4 +++- .../2023-09-01/examples/Glossary_CreateCategory.json | 4 +++- .../2023-09-01/examples/Glossary_CreateTerm.json | 4 +++- .../2023-09-01/examples/Glossary_CreateTerms.json | 4 +++- .../stable/2023-09-01/examples/Glossary_Delete.json | 4 +++- .../2023-09-01/examples/Glossary_DeleteCategory.json | 4 +++- .../2023-09-01/examples/Glossary_DeleteTerm.json | 4 +++- .../stable/2023-09-01/examples/Glossary_Get.json | 4 +++- .../2023-09-01/examples/Glossary_GetCategory.json | 4 +++- .../2023-09-01/examples/Glossary_GetDetailed.json | 4 +++- .../stable/2023-09-01/examples/Glossary_GetTerm.json | 4 +++- .../stable/2023-09-01/examples/Glossary_List.json | 4 +++- .../2023-09-01/examples/Glossary_ListCategories.json | 4 +++- .../examples/Glossary_ListCategoriesHeaders.json | 4 +++- .../examples/Glossary_ListCategoryTerms.json | 4 +++- .../Glossary_ListEntitiesAssignedWithTerm.json | 4 +++- .../examples/Glossary_ListRelatedCategories.json | 4 +++- .../examples/Glossary_ListRelatedTerms.json | 4 +++- .../examples/Glossary_ListTermHeaders.json | 4 +++- .../2023-09-01/examples/Glossary_ListTerms.json | 4 +++- .../2023-09-01/examples/Glossary_PartialUpdate.json | 4 +++- .../examples/Glossary_PartialUpdateCategory.json | 4 +++- .../examples/Glossary_PartialUpdateTerm.json | 4 +++- .../stable/2023-09-01/examples/Glossary_Update.json | 4 +++- .../2023-09-01/examples/Glossary_UpdateCategory.json | 4 +++- .../2023-09-01/examples/Glossary_UpdateTerm.json | 4 +++- .../stable/2023-09-01/examples/Lineage_Get.json | 4 +++- .../examples/Lineage_GetByUniqueAttribute.json | 4 +++- .../2023-09-01/examples/Lineage_GetNextPage.json | 4 +++- .../2023-09-01/examples/Relationship_Create.json | 4 +++- .../2023-09-01/examples/Relationship_Delete.json | 4 +++- .../stable/2023-09-01/examples/Relationship_Get.json | 4 +++- .../2023-09-01/examples/Relationship_Update.json | 4 +++- 86 files changed, 263 insertions(+), 93 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 71a7de1fb237..4ffee065c755 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -7,7 +7,7 @@ using TypeSpec.Http; namespace PurviewDataMap; -interface EntityOperations { +interface Entity { @doc(""" Create or update an entity. Existing entity is matched using its unique guid if @@ -792,7 +792,7 @@ be changed to other unique attributes) >; } -interface GlossaryOperations { +interface Glossary { @doc(""" Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories @@ -1394,7 +1394,7 @@ to get pagination result. >; } -interface DiscoveryOperations { +interface Discovery { @doc("Get data using search.") @route("/search/query") @post @@ -1432,7 +1432,7 @@ interface DiscoveryOperations { >; } -interface LineageOperations { +interface Lineage { @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get @@ -1522,7 +1522,7 @@ be changed to other unique attributes) >; } -interface RelationshipOperations { +interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post @@ -1582,7 +1582,7 @@ be created. >; } -interface TypeOperations { +interface TypeDef{ @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 6f9992091ded..2c6462c735ab 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -34,5 +34,7 @@ ] } } - } + }, + "title": "Discovery_AutoComplete", + "operationId": "Discovery_AutoComplete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 01a3c24a0366..24ef568e34e7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -103,5 +103,7 @@ ] } } - } + }, + "title": "Discovery_Query", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index 510076af8094..858d8fec1f54 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -74,5 +74,7 @@ ] } } - } + }, + "title": "Discovery_Query_And", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index a18f77f11ea4..2175edbbaa01 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_AndOrNested", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index 6f134d2cbc92..15afdce1337f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -134,5 +134,7 @@ ] } } - } + }, + "title": "Discovery_Query_AssetType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 33e68dd2cc70..3baee531460e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_Attribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 49a647d73822..1920ea21bd36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -48,5 +48,7 @@ ] } } - } + }, + "title": "Discovery_Query_BusinessMetadataAttribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 1652e3eb3967..6b1c6113741e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -63,5 +63,7 @@ ] } } - } + }, + "title": "Discovery_Query_Classification", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 8d51d3b6a9c9..6c10f84bbc17 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -62,5 +62,7 @@ ] } } - } + }, + "title": "Discovery_Query_Collection", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index d68b074a230f..4180c50799e1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -144,5 +144,7 @@ ] } } - } + }, + "title": "Discovery_Query_Facet", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 9c2aed22a521..7687c14e90fb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Discovery_Query_FileExtension", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 15d04904849c..bc25305cc75f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -90,5 +90,7 @@ } } } - } + }, + "title": "Discovery_Query_GlossaryTerm", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index a239b38b5c50..7c4e797a0be8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Discovery_Query_Id", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 004b8283ffc2..4b861a28b2fb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Query_Not", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index a75ed71cd1e4..c741d8fb1bc2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -71,5 +71,7 @@ ] } } - } + }, + "title": "Discovery_Query_ObjectType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index 99220e6552d4..1946af0bda97 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -105,5 +105,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationContinuationPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 9de3ad93b2b7..37cbd7af29b0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationFirstPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 7320000e5082..9d4d92d9a531 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationLastPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index bde144d66d3f..705f0bfdf7ff 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -49,5 +49,7 @@ ] } } - } + }, + "title": "Discovery_Query_SystemTime", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index 6b05a5985854..f7aac26f09f1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Discovery_Query_Taxonomy", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 576c69a243c5..5f02b441bfb6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -53,5 +53,7 @@ ] } } - } + }, + "title": "Discovery_Query_TermAssignment", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index f78c96dd68ac..473133d7d26f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Discovery_Query_Type", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index f0886ed0c690..95ec0ed6f307 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Suggest", + "operationId": "Discovery_Suggest" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 6aa11763de71..3bdb3c19b4a9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassifications", + "operationId": "Entity_AddClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index e82bbe57a2f3..9ceb5785ba20 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationsByUniqueAttribute", + "operationId": "Entity_AddClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 8d60d206619e..3a2bc5a3f537 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddLabelsByUniqueAttribute", + "operationId": "Entity_AddLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index 779992eff9ba..ad389111aaac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -100,5 +100,7 @@ } } } - } + }, + "title": "Entity_BulkCreateOrUpdate", + "operationId": "Entity_BulkCreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json index 067d745f66c1..3b8c27b9b5fc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json @@ -31,5 +31,7 @@ } } } - } + }, + "title": "Entity_BulkDelete", + "operationId": "Entity_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index 907bbe9c1e97..ea7c077e8df3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -35,5 +35,7 @@ "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" ] } - } + }, + "title": "Entity_BulkSetClassifications", + "operationId": "Entity_BulkSetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json index 029021e09916..9e6ab2104d44 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json @@ -23,5 +23,7 @@ } } } - } + }, + "title": "Entity_Delete", + "operationId": "Entity_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json index 34948b6504ab..3df1ba7cee96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json @@ -29,5 +29,7 @@ } } } - } + }, + "title": "Entity_DeleteByUniqueAttribute", + "operationId": "Entity_DeleteByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 918d06e41adc..2acf46b04d68 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -57,5 +57,7 @@ } } } - } + }, + "title": "Entity_Get", + "operationId": "Entity_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 1985ed6cb10e..113dab2d668f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -31,5 +31,7 @@ "referredEntities": {} } } - } + }, + "title": "Entity_GetByUniqueAttributes", + "operationId": "Entity_GetByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json index 1d976b1e21e0..968a4d7e0fcc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json @@ -13,5 +13,7 @@ "entityStatus": "ACTIVE" } } - } + }, + "title": "Entity_GetClassification", + "operationId": "Entity_GetClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json index 8f89220119d7..ae0d81292c04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json @@ -18,5 +18,7 @@ "sortType": "NONE" } } - } + }, + "title": "Entity_GetClassifications", + "operationId": "Entity_GetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json index c9ae29bce60d..029a55bbbb96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json @@ -24,5 +24,7 @@ "typeName": "azure_storage_account" } } - } + }, + "title": "Entity_GetHeader", + "operationId": "Entity_GetHeader" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index b25d5b0cc239..1e6900e014eb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -6,5 +6,7 @@ "200": { "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" } - } + }, + "title": "Entity_GetSampleBusinessMetadataTemplate", + "operationId": "Entity_GetSampleBusinessMetadataTemplate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 37325e736386..8dec58efba8a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -16,5 +16,7 @@ ] } } - } + }, + "title": "Entity_ImportBusinessMetadata", + "operationId": "Entity_ImportBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index 8d8754364eed..ed6951961940 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -110,5 +110,7 @@ ] } } - } + }, + "title": "Entity_ListByGuids", + "operationId": "Entity_ListByGuids" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index 16c42a58932e..c4ce33dd6345 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -46,5 +46,7 @@ ] } } - } + }, + "title": "Entity_ListByUniqueAttributes", + "operationId": "Entity_ListByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index 42e6555a9f4e..3ba4742d9a49 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -41,5 +41,7 @@ } } } - } + }, + "title": "Entity_MoveEntitiesToCollection", + "operationId": "Entity_MoveEntitiesToCollection" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json index 343a0b2ecb25..4320bdb7e9a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateAttributeByGuid", + "operationId": "Entity_PartialUpdateAttributeByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index a38dc403ff1d..50f18d78fe73 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -5,7 +5,7 @@ "attr:qualifiedName": "https://exampleaccount.core.windows.net", "atlasEntityWithExtInfo": { "entity": { - "createTime": 1.605766397985E12, + "createTime": 1605766397985.0, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "relationshipAttributes": { @@ -13,7 +13,7 @@ "meanings": [] }, "status": "ACTIVE", - "updateTime": 1.605766397985E12, + "updateTime": 1605766397985.0, "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "lastModifiedTS": "1", "version": 0.0, @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateByUniqueAttributes", + "operationId": "Entity_PartialUpdateByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9292ad587d04..9e2de7361e36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessMetadata", + "operationId": "Entity_RemoveBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json index 0967940bc811..408744950b01 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json @@ -6,5 +6,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassification", + "operationId": "Entity_RemoveClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json index 4d2cc9927070..75717c4f59ad 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json @@ -7,5 +7,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassificationByUniqueAttribute", + "operationId": "Entity_RemoveClassificationByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 8479ed0cfe43..3ae4c0b565f8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveLabelsByUniqueAttribute", + "operationId": "Entity_RemoveLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index b2132f45f70b..9ffba096b022 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_SetLabelsByUniqueAttribute", + "operationId": "Entity_SetLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index d558a272e7ea..bdf3ce57c20f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassifications", + "operationId": "Entity_UpdateClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index e82bbe57a2f3..acc71465ee0d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassificationsByUniqueAttribute", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 5ff085189499..f5805466ff13 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -18,5 +18,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_AssignTermToEntities", + "operationId": "Glossary_AssignTermToEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index a1ec9e6bee07..2af15856d99f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -26,5 +26,7 @@ "updateTime": 1672892675688 } } - } + }, + "title": "Glossary_Create", + "operationId": "Glossary_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 17a515af1f09..5e56de8fc2a1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -41,5 +41,7 @@ } ] } - } + }, + "title": "Glossary_CreateCategories", + "operationId": "Glossary_CreateCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index 7f31caaea342..cee2e98178e0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Glossary_CreateCategory", + "operationId": "Glossary_CreateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index efd7d2d547b2..d9ff8a381e4e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -72,5 +72,7 @@ } } } - } + }, + "title": "Glossary_CreateTerm", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index ddd48b3a0782..1c74cfa028c0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -87,5 +87,7 @@ } ] } - } + }, + "title": "Glossary_CreateTerms", + "operationId": "Glossary_CreateTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 70b4059decdd..66d0c8e21a8d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_Delete", + "operationId": "Glossary_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index 678b949d55e5..814f4a434f6f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteCategory", + "operationId": "Glossary_DeleteCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index 32fd415f64d5..edfc59de8017 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteTerm", + "operationId": "Glossary_DeleteTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 1eb2a13b1f0b..1f99715ebf1e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Glossary_Get", + "operationId": "Glossary_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 2329430d0e4d..230d037dad82 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -35,5 +35,7 @@ ] } } - } + }, + "title": "Glossary_GetCategory", + "operationId": "Glossary_GetCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index f5aea38d5f1d..d302e7e999a8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -225,5 +225,7 @@ } } } - } + }, + "title": "Glossary_GetDetailed", + "operationId": "Glossary_GetDetailed" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index d1bf7157bbed..9b89e65e50f1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -80,5 +80,7 @@ ] } } - } + }, + "title": "Glossary_GetTerm", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json index f8bc74ada7f4..c454ce6b68f7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json @@ -55,5 +55,7 @@ } ] } - } + }, + "title": "Glossary_List", + "operationId": "Glossary_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index aabcc66dc2d0..ca06ec508a72 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -68,5 +68,7 @@ } ] } - } + }, + "title": "Glossary_ListCategories", + "operationId": "Glossary_ListCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index 277c967f7f0b..ebd4d7c6acc9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -28,5 +28,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoriesHeaders", + "operationId": "Glossary_ListCategoriesHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index 7fe35d8dd8f2..091df398e96c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -16,5 +16,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoryTerms", + "operationId": "Glossary_ListCategoryTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index ebfed3c2de40..d2be6d8d0f3c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -53,5 +53,7 @@ } ] } - } + }, + "title": "Glossary_ListEntitiesAssignedWithTerm", + "operationId": "Glossary_ListEntitiesAssignedWithTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index 7523745867a5..ddd15b9191e1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedCategories", + "operationId": "Glossary_ListRelatedCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index ca90bb6d08d7..33619369a434 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedTerms", + "operationId": "Glossary_ListRelatedTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 1375aa567f2b..24dbbdef0dfd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -21,5 +21,7 @@ } ] } - } + }, + "title": "Glossary_ListTermHeaders", + "operationId": "Glossary_ListTermHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index 214bbd4c4f76..ddf242126dcd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -99,5 +99,7 @@ } ] } - } + }, + "title": "Glossary_ListTerms", + "operationId": "Glossary_ListTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index 4df90166a6b6..6b1d846fd25e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdate", + "operationId": "Glossary_PartialUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index 11516593b6bd..b1b3b5eb05b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateCategory", + "operationId": "Glossary_PartialUpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index 572d692fa4b6..e2bc0df64883 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateTerm", + "operationId": "Glossary_PartialUpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index ac2868693994..4eabcf439a58 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -92,5 +92,7 @@ ] } } - } + }, + "title": "Glossary_Update", + "operationId": "Glossary_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index fb8c92c94fd5..a195f431da37 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -59,5 +59,7 @@ ] } } - } + }, + "title": "Glossary_UpdateCategory", + "operationId": "Glossary_UpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 065bba39f639..4fb70086784b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Glossary_UpdateTerm", + "operationId": "Glossary_UpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json index 122a1804289c..a08de217b1c0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json @@ -20,5 +20,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_Get", + "operationId": "Lineage_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json index 4b9886deec69..ab738e50995b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json @@ -59,5 +59,7 @@ } } } - } + }, + "title": "Lineage_GetByUniqueAttribute", + "operationId": "Lineage_GetByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json index 66f7aac1fb7a..778a391f5b59 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json @@ -21,5 +21,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_GetNextPage", + "operationId": "Lineage_GetNextPage" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 8122eee5cd3a..883d47b5986c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -54,5 +54,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Create", + "operationId": "Relationship_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json index 291912c8ccac..c6e4848b9952 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Relationship_Delete", + "operationId": "Relationship_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json index 7a9054f95285..182684f354bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json @@ -35,5 +35,7 @@ } } } - } + }, + "title": "Relationship_Get", + "operationId": "Relationship_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 3664c81a3ec7..6287df03708b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -55,5 +55,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Update", + "operationId": "Relationship_Update" } From 8c6b39d7012f182f003358a6c7a28f8d9d62e15e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 17 Nov 2023 14:50:20 +0800 Subject: [PATCH 010/132] update --- .../Azure.Analytics.Purview.DataMap/main.tsp | 2 + .../models.tsp | 37 +- .../routes.tsp | 390 +++++++++++++----- 3 files changed, 324 insertions(+), 105 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 59fbf96d117e..0eb3c286ff37 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -16,6 +16,7 @@ using TypeSpec.Versioning; endpoint: string, } ) + @doc(""" Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. @@ -33,6 +34,7 @@ enum ApiVersions { "2023-09-01", } +#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("The Azure Active Directory OAuth2 Flow") model AADToken is OAuth2Auth<[ { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 960d05243a28..fefbb5332d1b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -205,10 +205,12 @@ model AtlasEntityWithExtInfo { entity?: AtlasEntity; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("An instance of an entity - like hive_table, hive_database.") model AtlasEntity { ...AtlasStruct; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc("Business attributes") businessAttributes?: Record; @@ -249,6 +251,7 @@ model AtlasEntity { @doc("Determines if there's a proxy.") proxy?: boolean; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc("The attributes of relationship.") relationshipAttributes?: Record; @@ -306,17 +309,19 @@ model TimeBoundary { timeZone?: string; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. """) model AtlasStruct { + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc("The attributes of the struct.") attributes?: Record; @doc("The name of the type.") typeName?: string; - + #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("ETag for concurrency control.") lastModifiedTS?: string; } @@ -452,11 +457,14 @@ exists only when associated with an entity. entityGuids?: string[]; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("REST serialization friendly list.") model AtlasClassifications { ...PList; } +#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Paginated-list, for returning search results.") model PList { @doc("An array of objects.") @@ -573,6 +581,7 @@ model AtlasRelatedTermHeader { termGuid?: string; } +#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("The glossary base object.") model AtlasGlossaryBaseObject { ...AtlasBaseModelObject; @@ -591,7 +600,7 @@ model AtlasGlossaryBaseObject { @doc("The short version of description.") shortDescription?: string; - + @doc("ETag for concurrency control.") lastModifiedTS?: string; @@ -643,6 +652,7 @@ model AtlasGlossaryHeader { relationGuid?: string; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The glossary term.") model AtlasGlossaryTerm { ...AtlasGlossaryBaseObject; @@ -674,6 +684,7 @@ model AtlasGlossaryTerm { @doc("The dictionary of contacts for terms. Key could be Expert or Steward.") contacts?: Record; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc(""" The custom attributes of the term, which is map>. The @@ -746,6 +757,7 @@ model PurviewObjectId { @doc("Resouce Id") resourceId?: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc("Dictionary of ") properties?: Record; } @@ -758,6 +770,7 @@ model AtlasObjectId { @doc("The name of the type.") typeName?: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc("The unique attributes of the object.") uniqueAttributes?: Record; } @@ -854,12 +867,15 @@ batch, and will return new token in each response unless there's no more data. @doc("The filter for the search. See examples for the usage of supported filters.") filter?: unknown; + @doc("The facets for search. See examples for the usage of supported facets.") facets?: SearchFacetItem[]; + @doc("The taxonomy setting for search.") taxonomySetting?: SearchRequestTaxonomySetting; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The content of a search facet result item.") model SearchFacetItem { @@ -869,6 +885,7 @@ model SearchFacetItem { @doc("The name of the facet item.") facet?: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Any object") sort?: unknown; } @@ -889,11 +906,11 @@ The total number of search results (not the number of documents in a single page). """) @projectedName("json", "@search.count") - SearchCount?: int32; + searchCount?: int32; @doc("'True' if the '@search.count' is an approximate value and vise versa.") @projectedName("json", "@search.count.approximate") - SearchCountApproximate?: boolean; + searchCountApproximate?: boolean; @doc("The token used to get next batch of data. Absent if there's no more data.") continuationToken?: string; @@ -904,7 +921,7 @@ contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. """) @projectedName("json", "@search.facets") - SearchFacets?: SearchFacetResultValue; + searchFacets?: SearchFacetResultValue; @doc("Search result value") value?: SearchResultValue[]; @@ -1091,6 +1108,7 @@ Expert or Steward for a glossary term. contactType?: string; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The query of suggest request.") model SuggestRequest { @doc(""" @@ -1124,14 +1142,14 @@ The search score calculated by the search engine. The results are ordered by search score by default. """) @projectedName("json", "@search.score") - SearchScore?: float32; + searchScore?: float32; @doc(""" The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark. """) @projectedName("json", "@search.text") - SearchText?: string; + searchText?: string; @doc(""" The object type of the record. Object type is the top-level property to @@ -1200,6 +1218,7 @@ AtlasGlossaryCategory. longDescription?: string; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The query of autocomplete request.") model AutoCompleteRequest { @doc(""" @@ -1233,6 +1252,7 @@ model AutoCompleteResultValue { queryPlusText?: string; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The lineage information.") model AtlasLineageInfo { @doc("The GUID of the base entity.") @@ -1241,6 +1261,7 @@ model AtlasLineageInfo { @doc("The GUID entity map.") guidEntityMap?: Record; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc("The entity count in specific direction.") widthCounts?: Record>; @@ -1392,6 +1413,7 @@ model AtlasAttributeDef { valuesMinCount?: int32; } +#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("class that captures details of a constraint.") model AtlasConstraintDef { @doc("The parameters of the constraint definition.") @@ -1401,6 +1423,7 @@ model AtlasConstraintDef { type?: string; } +#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("Base class that captures common-attributes for all types.") model AtlasBaseTypeDef { @doc("The enum of type category.") diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 4ffee065c755..608668556075 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -4,10 +4,51 @@ import "./models.tsp"; using TypeSpec.Rest; using TypeSpec.Http; - +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; +using Azure.Core.Traits.Private; namespace PurviewDataMap; + +@doc("The ApiVersion query parameter.") +model ApiVersionParameter { + @query("api-version") + @minLength(1) + @doc("The API version to use for this operation.") + apiVersion: string; +} + +@doc("Operation for Atlas service") +op AtlasOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse, + Traits extends TypeSpec.Reflection.Model = {}, + TErrorResponse = ErrorResponse +>( + ...TraitProperties< + Traits & VersionParameterTrait, + TraitLocation.ApiVersionParameter + >, + ...TParams, +): TResponse | TErrorResponse; + +@doc("Operation for Atlas service") +op DataMapBaseOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse, + Traits extends TypeSpec.Reflection.Model = {}, + TErrorResponse = ErrorResponse +>( + ...TraitProperties< + Traits & VersionParameterTrait, + TraitLocation.ApiVersionParameter + >, + ...TParams, +): TResponse | TErrorResponse; + interface Entity { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Create or update an entity. Existing entity is matched using its unique guid if @@ -19,7 +60,7 @@ For each contact type, the maximum number of contacts is 20. """) @route("/atlas/v2/entity") @post - createOrUpdate is Azure.Core.Foundations.Operation< + createOrUpdate is AtlasOperation< { @doc(""" Used to define the update behavior for business attributes when updating @@ -42,10 +83,11 @@ need to move an entity to another collection. EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List entities in bulk identified by its GUIDs.") @route("/atlas/v2/entity/bulk") @get - listByGuids is Azure.Core.Foundations.Operation< + listByGuids is AtlasOperation< { @doc("An array of GUIDs of entities to list.") @query({format: "multi"}) @@ -62,6 +104,7 @@ need to move an entity to another collection. AtlasEntitiesWithExtInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Create or update entities in bulk. Existing entity is matched using its unique @@ -74,7 +117,7 @@ is 20. """) @route("/atlas/v2/entity/bulk") @post - bulkCreateOrUpdate is Azure.Core.Foundations.Operation< + bulkCreateOrUpdate is AtlasOperation< { @doc(""" The collection where entities will be moved to. Only specify a value if you @@ -97,13 +140,14 @@ entities. EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Delete a list of entities in bulk identified by their GUIDs or unique attributes. """) @route("/atlas/v2/entity/bulk") @delete - bulkDelete is Azure.Core.Foundations.Operation< + bulkDelete is AtlasOperation< { @doc("An array of GUIDs of entities to delete.") @query({format: "multi"}) @@ -112,10 +156,11 @@ attributes. EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is Azure.Core.Foundations.Operation< + addClassification is AtlasOperation< { @doc("The request to associate a classification to multiple entities.") @body @@ -124,10 +169,11 @@ attributes. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get complete definition of an entity given its GUID.") @route("/atlas/v2/entity/guid/{guid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -144,6 +190,7 @@ attributes. AtlasEntityWithExtInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Update entity partially - create or update entity attribute identified by its GUID. @@ -155,7 +202,7 @@ possible. """) @route("/atlas/v2/entity/guid/{guid}") @put - partialUpdateAttributeByGuid is Azure.Core.Foundations.Operation< + partialUpdateAttributeByGuid is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -165,6 +212,7 @@ possible. @query name: string; + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The value of the attribute.") @body body: unknown; @@ -172,10 +220,11 @@ possible. EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete an entity identified by its GUID.") @route("/atlas/v2/entity/guid/{guid}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -184,10 +233,11 @@ possible. EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get classification for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @get - getClassification is Azure.Core.Foundations.Operation< + getClassification is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -200,10 +250,11 @@ possible. AtlasClassification >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a given classification from an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @delete - removeClassification is Azure.Core.Foundations.Operation< + removeClassification is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -216,10 +267,11 @@ possible. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List classifications for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @get - getClassifications is Azure.Core.Foundations.Operation< + getClassifications is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -228,10 +280,12 @@ possible. AtlasClassifications >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Add classifications to an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @post - addClassifications is Azure.Core.Foundations.Operation< + addClassifications is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -244,10 +298,12 @@ possible. void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update classifications to an existing entity represented by a guid.") @route("/atlas/v2/entity/guid/{guid}/classifications") @put - updateClassifications is Azure.Core.Foundations.Operation< + updateClassifications is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -260,6 +316,7 @@ possible. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get complete definition of an entity given its type and unique attribute. @@ -278,7 +335,7 @@ GET """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @get - getByUniqueAttributes is Azure.Core.Foundations.Operation< + getByUniqueAttributes is AtlasOperation< { @doc("The name of the type.") @path @@ -302,6 +359,7 @@ be changed to other unique attributes) AtlasEntityWithExtInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: @@ -322,7 +380,7 @@ PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @put - partialUpdateByUniqueAttributes is Azure.Core.Foundations.Operation< + partialUpdateByUniqueAttributes is AtlasOperation< { @doc("The name of the type.") @path @@ -342,6 +400,7 @@ be changed to other unique attributes) EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Delete an entity identified by its type and unique attributes. In addition to @@ -358,7 +417,7 @@ DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @delete - deleteByUniqueAttribute is Azure.Core.Foundations.Operation< + deleteByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -374,13 +433,14 @@ be changed to other unique attributes) EntityMutationResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Delete a given classification from an entity identified by its type and unique attributes. """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") @delete - removeClassificationByUniqueAttribute is Azure.Core.Foundations.Operation< + removeClassificationByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -400,10 +460,12 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Add classification to the entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @post - addClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + addClassificationsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -423,10 +485,12 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update classification on an entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @put - updateClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + updateClassificationsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -446,10 +510,11 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Set classifications on entities in bulk.") @route("/atlas/v2/entity/bulk/setClassifications") @post - bulkSetClassifications is Azure.Core.Foundations.Operation< + bulkSetClassifications is AtlasOperation< { @doc("Atlas entity headers.") @body @@ -458,6 +523,8 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is Atlas API behavior" @doc(""" Bulk API to retrieve list of entities identified by its unique attributes. In @@ -480,7 +547,7 @@ at least one unique attribute must be provided. """) @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") @get - listByUniqueAttributes is Azure.Core.Foundations.Operation< + listByUniqueAttributes is AtlasOperation< { @doc("The name of the type.") @path @@ -505,10 +572,11 @@ example. qualifiedName can be changed to other unique attributes) AtlasEntitiesWithExtInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get entity header given its GUID.") @route("/atlas/v2/entity/guid/{guid}/header") @get - getHeader is Azure.Core.Foundations.Operation< + getHeader is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -517,23 +585,28 @@ example. qualifiedName can be changed to other unique attributes) AtlasEntityHeader >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Remove business metadata from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @delete - removeBusinessMetadata is Azure.Core.Foundations.Operation< + removeBusinessMetadata is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata payload") @body businessMetadata: Record; }, void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Add business metadata to an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @post - addOrUpdateBusinessMetadata is Azure.Core.Foundations.Operation< + addOrUpdateBusinessMetadata is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -546,15 +619,17 @@ default is false. @query isOverwrite: boolean; @doc("BusinessMetadata payload") + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @body businessMetadata: Record; }, void >; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @delete - removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + removeBusinessMetadataAttributes is AtlasOperation< { @doc("BusinessMetadata name") @path @@ -564,16 +639,18 @@ default is false. @path guid: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata attribute payload") @body businessMetadataAttributes: Record; }, void >; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @post - addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + addOrUpdateBusinessMetadataAttributes is AtlasOperation< { @doc("BusinessMetadata name") @path @@ -583,15 +660,17 @@ default is false. @path guid: string; @doc("Business metadata attribute payload") + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @body businessMetadataAttributes: Record; }, void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get - getSampleBusinessMetadataTemplate is Azure.Core.Foundations.Operation< + getSampleBusinessMetadataTemplate is AtlasOperation< { @doc("Accept header") @header @@ -600,10 +679,11 @@ default is false. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Upload the file for creating Business Metadata in BULK") @route("/atlas/v2/entity/businessmetadata/import") @post - importBusinessMetadata is Azure.Core.Foundations.Operation< + importBusinessMetadata is AtlasOperation< { @doc("InputStream of file") @body @@ -612,10 +692,12 @@ default is false. BulkImportResponse >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @delete - removeLabels is Azure.Core.Foundations.Operation< + removeLabels is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -628,10 +710,12 @@ default is false. void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Set labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @post - setLabels is Azure.Core.Foundations.Operation< + setLabels is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -644,10 +728,12 @@ default is false. void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Add given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @put - addLabel is Azure.Core.Foundations.Operation< + addLabel is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -660,6 +746,8 @@ default is false. void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Delete given labels to a given entity identified by its type and unique attribute. @@ -677,7 +765,7 @@ this: DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @delete - removeLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + removeLabelsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -697,6 +785,8 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Set labels to a given entity identified by its type and unique attributes. @@ -716,7 +806,7 @@ request would look something like this: POST """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @post - setLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + setLabelsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -736,6 +826,8 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Add given labels to a given entity identified by its type and unique attributes. @@ -755,7 +847,7 @@ request would look something like this: PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @put - addLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + addLabelsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -778,7 +870,7 @@ be changed to other unique attributes) @doc("Move existing entities to the target collection.") @route("/entity/moveTo") @post - moveEntitiesToCollection is Azure.Core.Foundations.Operation< + moveEntitiesToCollection is DataMapBaseOperation< { @doc("The collection where entities will be moved to.") @query @@ -793,6 +885,7 @@ be changed to other unique attributes) } interface Glossary { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories @@ -805,7 +898,7 @@ and """) @route("/atlas/v2/glossary") @get - list is Azure.Core.Foundations.Operation< + list is AtlasOperation< { @doc("The page size - by default there is no paging.") @query @@ -826,10 +919,12 @@ and void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is Azure.Core.Foundations.Operation< + create is AtlasOperation< { @doc(""" Glossary definition, terms & categories can be anchored to a glossary. @@ -842,10 +937,12 @@ the anchor attribute when creating the Term/Category. AtlasGlossary >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create glossary category in bulk.") @route("/atlas/v2/glossary/categories") @post - createCategories is Azure.Core.Foundations.Operation< + createCategories is AtlasOperation< { @doc("An array of glossary category definitions to be created.") @body @@ -854,10 +951,11 @@ the anchor attribute when creating the Term/Category. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a glossary category.") @route("/atlas/v2/glossary/category") @post - createCategory is Azure.Core.Foundations.Operation< + createCategory is AtlasOperation< { @doc(""" The glossary category definition. A category must be anchored to a Glossary @@ -871,10 +969,11 @@ can also be defined during creation. AtlasGlossaryCategory >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get specific glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @get - getCategory is Azure.Core.Foundations.Operation< + getCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -883,10 +982,11 @@ can also be defined during creation. AtlasGlossaryCategory >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @put - updateCategory is Azure.Core.Foundations.Operation< + updateCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -899,10 +999,11 @@ can also be defined during creation. AtlasGlossaryCategory >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a glossary category.") @route("/atlas/v2/glossary/category/{categoryGuid}") @delete - deleteCategory is Azure.Core.Foundations.Operation< + deleteCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -911,18 +1012,22 @@ can also be defined during creation. void >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category. """) @route("/atlas/v2/glossary/category/{categoryGuid}/partial") @put - partialUpdateCategory is Azure.Core.Foundations.Operation< + partialUpdateCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path categoryGuid: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" A map containing keys as attribute names and values as corresponding attribute values for partial update. @@ -933,13 +1038,14 @@ values for partial update. AtlasGlossaryCategory >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/category/{categoryGuid}/related") @get - listRelatedCategories is Azure.Core.Foundations.Operation< + listRelatedCategories is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -960,10 +1066,11 @@ parameters are currently not being enabled and won't work even they are passed. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get all terms associated with the specific category.") @route("/atlas/v2/glossary/category/{categoryGuid}/terms") @get - listCategoryTerms is Azure.Core.Foundations.Operation< + listCategoryTerms is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -984,10 +1091,11 @@ parameters are currently not being enabled and won't work even they are passed. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a glossary term.") @route("/atlas/v2/glossary/term") @post - createTerm is Azure.Core.Foundations.Operation< + createTerm is AtlasOperation< { @doc("Whether include term hierarchy") @query @@ -1004,10 +1112,11 @@ Optionally it can be categorized as well. AtlasGlossaryTerm >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get a specific glossary term by its GUID. ") @route("/atlas/v2/glossary/term/{termGuid}") @get - getTerm is Azure.Core.Foundations.Operation< + getTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1016,10 +1125,11 @@ Optionally it can be categorized as well. AtlasGlossaryTerm >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary term by its GUID.") @route("/atlas/v2/glossary/term/{termGuid}") @put - updateTerm is Azure.Core.Foundations.Operation< + updateTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1036,10 +1146,11 @@ Optionally it can be categorized as well. AtlasGlossaryTerm >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a glossary term.") @route("/atlas/v2/glossary/term/{termGuid}") @delete - deleteTerm is Azure.Core.Foundations.Operation< + deleteTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1048,13 +1159,15 @@ Optionally it can be categorized as well. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term. """) @route("/atlas/v2/glossary/term/{termGuid}/partial") @put - partialUpdateTerm is Azure.Core.Foundations.Operation< + partialUpdateTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1064,6 +1177,7 @@ shortDescription, longDescription, abbreviation, usage and status for term. @query includeTermHierarchy: boolean; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" A map containing keys as attribute names and values as corresponding attribute values to be updated. @@ -1074,10 +1188,12 @@ values to be updated. AtlasGlossaryTerm >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create glossary terms in bulk.") @route("/atlas/v2/glossary/terms") @post - createTerms is Azure.Core.Foundations.Operation< + createTerms is AtlasOperation< { @doc("Whether include term hierarchy") @query @@ -1090,13 +1206,14 @@ values to be updated. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @get - listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< + listEntitiesAssignedWithTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1117,6 +1234,8 @@ limit/offset to get pagination result. void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. @@ -1127,7 +1246,7 @@ is an alternative to assign a term to multiple entities. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @post - assignTermToEntities is Azure.Core.Foundations.Operation< + assignTermToEntities is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1140,10 +1259,12 @@ is an alternative to assign a term to multiple entities. void >; + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete the term assignment for the given list of related objects.") @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @delete - deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< + deleteTermAssignmentFromEntities is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1156,13 +1277,14 @@ is an alternative to assign a term to multiple entities. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/terms/{termGuid}/related") @get - listRelatedTerms is Azure.Core.Foundations.Operation< + listRelatedTerms is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1183,10 +1305,11 @@ parameters are currently not being enabled and won't work even they are passed. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get a specific Glossary by its GUID.") @route("/atlas/v2/glossary/{glossaryGuid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1195,10 +1318,11 @@ parameters are currently not being enabled and won't work even they are passed. AtlasGlossary >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary.") @route("/atlas/v2/glossary/{glossaryGuid}") @put - update is Azure.Core.Foundations.Operation< + update is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1215,13 +1339,14 @@ parameters are currently not being enabled and won't work even they are passed. AtlasGlossary >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories. """) @route("/atlas/v2/glossary/{glossaryGuid}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1230,13 +1355,14 @@ separate delete terms and categories. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories") @get - listCategories is Azure.Core.Foundations.Operation< + listCategories is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1257,13 +1383,14 @@ limit/offset to get pagination result. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") @get - listCategoriesHeaders is Azure.Core.Foundations.Operation< + listCategoriesHeaders is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1284,6 +1411,7 @@ limit/offset to get pagination result. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get a specific glossary with detailed information. This API is not recommend. @@ -1298,7 +1426,7 @@ Recommend to fetch terms/categories details separately using """) @route("/atlas/v2/glossary/{glossaryGuid}/detailed") @get - getDetailed is Azure.Core.Foundations.Operation< + getDetailed is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1307,6 +1435,7 @@ Recommend to fetch terms/categories details separately using AtlasGlossaryExtInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. @@ -1319,7 +1448,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. """) @route("/atlas/v2/glossary/{glossaryGuid}/partial") @put - partialUpdate is Azure.Core.Foundations.Operation< + partialUpdate is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1329,6 +1458,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. @query ignoreTermsAndCategories: boolean; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" A map containing keys as attribute names and values as corresponding attribute values. @@ -1339,13 +1469,14 @@ values. AtlasGlossary >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms") @get - listTerms is Azure.Core.Foundations.Operation< + listTerms is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1366,13 +1497,14 @@ pagination result. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") @get - listTermHeaders is Azure.Core.Foundations.Operation< + listTermHeaders is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1398,7 +1530,7 @@ interface Discovery { @doc("Get data using search.") @route("/search/query") @post - query is Azure.Core.Foundations.Operation< + query is DataMapBaseOperation< { @doc("An object specifying the search criteria.") @body @@ -1410,7 +1542,7 @@ interface Discovery { @doc("Get search suggestions by query criteria.") @route("/search/suggest") @post - suggest is Azure.Core.Foundations.Operation< + suggest is DataMapBaseOperation< { @doc("An object specifying the suggest criteria.") @body @@ -1422,7 +1554,7 @@ interface Discovery { @doc("Get auto complete options.") @route("/search/autocomplete") @post - autoComplete is Azure.Core.Foundations.Operation< + autoComplete is DataMapBaseOperation< { @doc("An object specifying the autocomplete criteria.") @body @@ -1433,10 +1565,11 @@ interface Discovery { } interface Lineage { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1456,7 +1589,7 @@ interface Lineage { @doc("Return immediate next page lineage info about entity with pagination") @route("/lineage/{guid}/next/") @get - getNextPage is Azure.Core.Foundations.Operation< + getNextPage is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1477,6 +1610,7 @@ interface Lineage { AtlasLineageInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Return lineage info about entity. @@ -1497,7 +1631,7 @@ GET """) @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") @get - getByUniqueAttribute is Azure.Core.Foundations.Operation< + getByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -1523,10 +1657,11 @@ be changed to other unique attributes) } interface Relationship { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is Azure.Core.Foundations.Operation< + create is AtlasOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1538,10 +1673,11 @@ be created. AtlasRelationship >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is Azure.Core.Foundations.Operation< + update is AtlasOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1553,10 +1689,11 @@ be created. AtlasRelationship >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get relationship information between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1569,10 +1706,11 @@ be created. AtlasRelationshipWithExtInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a relationship between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1582,11 +1720,48 @@ be created. >; } +// @doc("Guid") +// @resource("guid") +// model Guid { +// @key("guid") +// @visibility("read") +// @doc("guid") +// guid: string; +// } + +// @doc("Name") +// @resource("name") +// model Name { +// @key("name") +// @visibility("read") +// @doc("name") +// name: string; +// } + + + +// alias ReadByNameOperations = Azure.Core.ResourceOperations; +// alias ReadByGuidOperations = Azure.Core.ResourceOperations; +// interface Test{ +// @doc("Get the term template definition for the given GUID.") +// @route("/test/termtemplatedef/guid/{guid}") +// @get +// get_TermTemplateDefByGuid is AtlasOperation< +// { +// @doc("Ddd") +// @path +// guid: string; +// }, +// TermTemplateDef +// >; +// } + interface TypeDef{ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get - getBusinessMetadataDefByGuid is Azure.Core.Foundations.Operation< + getBusinessMetadataDefByGuid is AtlasOperation< { @doc("businessMetadata guid") @path @@ -1595,10 +1770,11 @@ interface TypeDef{ AtlasBusinessMetadataDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition by it's name (unique).") @route("/atlas/v2/types/businessmetadatadef/name/{name}") @get - getBusinessMetadataDefByName is Azure.Core.Foundations.Operation< + getBusinessMetadataDefByName is AtlasOperation< { @doc("businessMetadata name") @path @@ -1607,10 +1783,11 @@ interface TypeDef{ AtlasBusinessMetadataDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the classification definition for the given GUID.") @route("/atlas/v2/types/classificationdef/guid/{guid}") @get - getClassificationDefByGuid is Azure.Core.Foundations.Operation< + getClassificationDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the classification.") @path @@ -1619,10 +1796,11 @@ interface TypeDef{ AtlasClassificationDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the classification definition by its name (unique).") @route("/atlas/v2/types/classificationdef/name/{name}") @get - getClassificationDefByName is Azure.Core.Foundations.Operation< + getClassificationDefByName is AtlasOperation< { @doc("The name of the classification.") @path @@ -1631,10 +1809,11 @@ interface TypeDef{ AtlasClassificationDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the Entity definition for the given GUID.") @route("/atlas/v2/types/entitydef/guid/{guid}") @get - getEntityDefByGuid is Azure.Core.Foundations.Operation< + getEntityDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1643,10 +1822,11 @@ interface TypeDef{ AtlasEntityDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the entity definition by its name (unique).") @route("/atlas/v2/types/entitydef/name/{name}") @get - getEntityDefByName is Azure.Core.Foundations.Operation< + getEntityDefByName is AtlasOperation< { @doc("The name of the entity.") @path @@ -1655,10 +1835,11 @@ interface TypeDef{ AtlasEntityDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the enum definition for the given GUID.") @route("/atlas/v2/types/enumdef/guid/{guid}") @get - getEnumDefByGuid is Azure.Core.Foundations.Operation< + getEnumDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the enum.") @path @@ -1667,10 +1848,11 @@ interface TypeDef{ AtlasEnumDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the enum definition by its name (unique).") @route("/atlas/v2/types/enumdef/name/{name}") @get - getEnumDefByName is Azure.Core.Foundations.Operation< + getEnumDefByName is AtlasOperation< { @doc("The name of the enum.") @path @@ -1679,10 +1861,11 @@ interface TypeDef{ AtlasEnumDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the relationship definition for the given GUID.") @route("/atlas/v2/types/relationshipdef/guid/{guid}") @get - getRelationshipDefByGuid is Azure.Core.Foundations.Operation< + getRelationshipDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1691,10 +1874,11 @@ interface TypeDef{ AtlasRelationshipDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the relationship definition by its name (unique).") @route("/atlas/v2/types/relationshipdef/name/{name}") @get - getRelationshipDefByName is Azure.Core.Foundations.Operation< + getRelationshipDefByName is AtlasOperation< { @doc("The name of the relationship.") @path @@ -1703,10 +1887,11 @@ interface TypeDef{ AtlasRelationshipDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the struct definition for the given GUID.") @route("/atlas/v2/types/structdef/guid/{guid}") @get - getStructDefByGuid is Azure.Core.Foundations.Operation< + getStructDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the struct.") @path @@ -1715,10 +1900,11 @@ interface TypeDef{ AtlasStructDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the struct definition by its name (unique).") @route("/atlas/v2/types/structdef/name/{name}") @get - getStructDefByName is Azure.Core.Foundations.Operation< + getStructDefByName is AtlasOperation< { @doc("The name of the struct.") @path @@ -1727,10 +1913,11 @@ interface TypeDef{ AtlasStructDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the type definition for the given GUID.") @route("/atlas/v2/types/typedef/guid/{guid}") @get - getByGuid is Azure.Core.Foundations.Operation< + getByGuid is AtlasOperation< { @doc("The globally unique identifier of the type.") @path @@ -1739,10 +1926,11 @@ interface TypeDef{ AtlasTypeDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the type definition by its name (unique).") @route("/atlas/v2/types/typedef/name/{name}") @get - getByName is Azure.Core.Foundations.Operation< + getByName is AtlasOperation< { @doc("The name of the type.") @path @@ -1751,10 +1939,11 @@ interface TypeDef{ AtlasTypeDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete API for type identified by its name.") @route("/atlas/v2/types/typedef/name/{name}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The name of the type.") @path @@ -1763,10 +1952,11 @@ interface TypeDef{ void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions in bulk.") @route("/atlas/v2/types/typedefs") @get - list is Azure.Core.Foundations.Operation< + list is AtlasOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -1782,7 +1972,8 @@ when search filter type=term_template }, AtlasTypesDef >; - + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Create all atlas type definitions in bulk, only new definitions will be created. @@ -1790,7 +1981,7 @@ Any changes to the existing definitions will be discarded. """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is Azure.Core.Foundations.Operation< + bulkCreate is AtlasOperation< { @doc("A composite wrapper object with corresponding lists of the type definition.") @body @@ -1799,13 +1990,14 @@ Any changes to the existing definitions will be discarded. AtlasTypesDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Update all types in bulk, changes detected in the type definitions would be persisted. """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is Azure.Core.Foundations.Operation< + bulkUpdate is AtlasOperation< { @doc("A composite object that captures all type definition changes.") @body @@ -1814,10 +2006,11 @@ persisted. AtlasTypesDef >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is Azure.Core.Foundations.Operation< + bulkDelete is AtlasOperation< { @doc("A composite object that captures all types to be deleted") @body @@ -1826,10 +2019,11 @@ persisted. void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions returned as a list of minimal information header.") @route("/atlas/v2/types/typedefs/headers") @get - listHeaders is Azure.Core.Foundations.Operation< + listHeaders is AtlasOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -1849,7 +2043,7 @@ when search filter type=term_template @doc("Get the term template definition for the given GUID.") @route("/types/termtemplatedef/guid/{guid}") @get - getTermTemplateDefByGuid is Azure.Core.Foundations.Operation< + getTermTemplateDefByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the term template.") @path @@ -1861,7 +2055,7 @@ when search filter type=term_template @doc("Get the term template definition by its name (unique).") @route("/types/termtemplatedef/name/{name}") @get - getTermTemplateDefByName is Azure.Core.Foundations.Operation< + getTermTemplateDefByName is DataMapBaseOperation< { @doc("The name of the term template.") @path From ae10d957c0173b647980a92d05db264580dd5582 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 17 Nov 2023 23:46:57 +0800 Subject: [PATCH 011/132] update --- .../models.tsp | 12 ++++++--- .../routes.tsp | 26 ++++++++++++------- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index fefbb5332d1b..999d65a3f402 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -1,5 +1,5 @@ -import "@typespec/rest"; import "@typespec/http"; +import "@typespec/rest"; using TypeSpec.Rest; using TypeSpec.Http; @@ -1444,8 +1444,10 @@ model AtlasBaseTypeDef { @doc("The GUID of the type definition.") guid?: string; + @key("name") + @visibility("read") @doc("The name of the type definition.") - name?: string; + name: string; @doc("The options for the type definition.") options?: Record; @@ -1885,7 +1887,9 @@ model AtlasTypesDef { termTemplateDefs?: TermTemplateDef[]; } -@doc("term template definition for glossary term.") +@doc("Term template definition for glossary term.") +@resource("name") +@resource("guid") model TermTemplateDef { ...AtlasStructDef; } @@ -1900,4 +1904,4 @@ model AtlasTypeDefHeader { @doc("The name of the type definition.") name?: string; -} \ No newline at end of file +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 608668556075..c0606b8b4661 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -19,6 +19,15 @@ model ApiVersionParameter { apiVersion: string; } +@doc("The path for name.") +@resource("name") +model NameInPath { + @key("name") + @visibility("read") + @doc("name") + name: string; +} + @doc("Operation for Atlas service") op AtlasOperation< TParams extends TypeSpec.Reflection.Model, @@ -33,7 +42,7 @@ op AtlasOperation< ...TParams, ): TResponse | TErrorResponse; -@doc("Operation for Atlas service") +@doc("Operation for DataMap service") op DataMapBaseOperation< TParams extends TypeSpec.Reflection.Model, TResponse, @@ -46,6 +55,8 @@ op DataMapBaseOperation< >, ...TParams, ): TResponse | TErrorResponse; + +alias DataMapResourceOperations = Azure.Core.ResourceOperations; interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2051,16 +2062,11 @@ when search filter type=term_template }, TermTemplateDef >; + + #suppress "@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops" "Need to put types API under the same interface" @doc("Get the term template definition by its name (unique).") - @route("/types/termtemplatedef/name/{name}") + @route("/types/termtemplatedef") @get - getTermTemplateDefByName is DataMapBaseOperation< - { - @doc("The name of the term template.") - @path - name: string; - }, - TermTemplateDef - >; + getTermTemplateDefByName is DataMapResourceOperations.ResourceRead; } From 2b34456c81dabc9bbca46070703decad17e50570 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Mon, 20 Nov 2023 14:14:49 +0800 Subject: [PATCH 012/132] Update routes.tsp --- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index c0606b8b4661..9fca0554f3dd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -95,6 +95,7 @@ need to move an entity to another collection. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" @doc("List entities in bulk identified by its GUIDs.") @route("/atlas/v2/entity/bulk") @get @@ -151,6 +152,8 @@ entities. EntityMutationResponse >; + + #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Delete a list of entities in bulk identified by their GUIDs or unique @@ -637,6 +640,7 @@ default is false. >; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @delete @@ -656,7 +660,8 @@ default is false. }, void >; - + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") From ee8979e43398b47c8d7db3bb3fd767428ff9db6b Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 21 Nov 2023 14:01:46 +0800 Subject: [PATCH 013/132] update --- .../models.tsp | 215 +++++++++++++++++- .../routes.tsp | 8 +- 2 files changed, 215 insertions(+), 8 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 999d65a3f402..9fec6af387cd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -845,6 +845,7 @@ model AtlasGlossaryExtInfo { termInfo?: Record; } +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The search query of advanced search request.") model SearchRequest { @doc("The keywords applied to all searchable fields.") @@ -862,6 +863,7 @@ batch, and will return new token in each response unless there's no more data. """) continuationToken?: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "This is a flexible property" @doc("The sort order of search results, can specify multiple fields.") orderby?: unknown[]; @@ -885,7 +887,7 @@ model SearchFacetItem { @doc("The name of the facet item.") facet?: string; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("Any object") sort?: unknown; } @@ -1108,7 +1110,7 @@ Expert or Steward for a glossary term. contactType?: string; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The query of suggest request.") model SuggestRequest { @doc(""" @@ -1218,7 +1220,7 @@ AtlasGlossaryCategory. longDescription?: string; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The query of autocomplete request.") model AutoCompleteRequest { @doc(""" @@ -1905,3 +1907,210 @@ model AtlasTypeDefHeader { @doc("The name of the type definition.") name?: string; } + +@discriminator("kind") +@doc("Base model for search filter") +model SearchFilter { + +} + + +@doc("And filter for search") +model AndFilter extends SearchFilter { + @doc("And filter for search") + kind: "AndFilter"; + @doc("List of filters") + @projectedName("json", "and") + andFilters : SearchFilter[]; +} + +@doc("Not filter for search") +model NotFilter extends SearchFilter { + @doc("Not filter for search") + kind: "NotFilter"; + + @doc("Not filter") + @projectedName("json", "not") + notFilters : SearchFilter; +} + +@doc("Or filter for search") +model OrFilter extends SearchFilter { + @doc("Or filter for search") + kind: "OrFilter"; + @doc("List of filters") + @projectedName("json", "or") + orFilters : SearchFilter[]; +} + +@doc("Asset type filter for search") +model AssetTypeFilter extends SearchFilter { + @doc("Asset type filter for search") + kind: "AssetTypeFilter"; + @doc("Asset type name") + assetType: string; +} + +@doc("Attribute filter for search") +model AttributeFilter extends SearchFilter { + @doc("Attribute filter for search") + kind: "AttributeFilter"; + + @doc("Attribute name") + attributeName: string; + @doc("Operator") + operator: string; + + @doc("Attribute value") + attributeValue: string; +} + +@doc("Classification type filter for search") +model ClassificationFilter extends SearchFilter { + @doc("Classification type filter for search") + kind: "ClassificationFilter"; + @doc("Classification name") + classificationName: string; + @doc("Whether to include sub classifications") + includeSubClassifications?: boolean; +} + +@doc("Collection id filter for search") +model CollectionIdFilter extends SearchFilter { + @doc("Collection id filter for search") + kind: "CollectionIdFilter"; + @doc("Collection id") + collectionId: string; +} + +@doc("Contact filter for search") +model ContactFilter extends SearchFilter { + @doc("Contact filter for search") + kind: "ContactFilter"; + @doc("Contact type") + contactType: string; + @doc("Contact Id") + contactId: string; +} + +@doc("Domain id filter for search") +model DomainIdFilter extends SearchFilter { + @doc("Domain id filter for search") + kind: "DomainIdFilter"; + @doc("Domain id") + domainId: string; +} + +@doc("Exists filter for search") +model ExistsFilter extends SearchFilter { + @doc("Exists filter for search") + kind: "ExistsFilter"; + @projectedName("json", "exists") + @doc("Field") + field: string; +} + +@doc("File extension filter for search") +model FileExtensionFilter extends SearchFilter { + @doc("File extension filter for search") + kind: "FileExtensionFilter"; + @doc("File extension") + fileExtension: string; +} + +@doc("Label filter for search") +model LabelFilter extends SearchFilter { + @doc("Label filter for search") + kind: "LabelFilter"; + @doc("Label") + label: string; + @doc("Whether to include sub labels") + includeSubLabels?: boolean; +} + + +@doc("Label filter for search") +model ObjectTypeFilter extends SearchFilter { + @doc("Label filter for search") + kind: "ObjectTypeFilter"; + @doc("Object type") + objectType: string; +} + +@doc("Path filter for search") +model PathFilter extends SearchFilter { + @doc("Path filter for search") + kind: "PathFilter"; + @doc("Path") + path: string; + @doc("Whether the path is parent path") + isParent?: boolean; +} + +@doc("Scan info filter for search") +model ScanInfoFilter extends SearchFilter { + @doc("Scan info filter for search") + kind: "ScanInfoFilter"; + @doc("Data source name") + dataSourceName?: string; + @doc("Scan name") + scanName: string; +} + +@doc("Glossary filter for search") +model GlossaryFilter extends SearchFilter { + @doc("Glossary filter for search") + kind: "GlossaryFilter"; + @doc("Glossary type. Either AtlasGlossary or AtlasGlossaryType") + glossaryType: string; +} + +@doc("Id filter for search") +model IdFilter extends SearchFilter { + @doc("Id filter for search") + kind: "IdFilter"; + @doc("Id value") + id: string; +} + +@doc("Type filter for search") +model TypeFilter extends SearchFilter { + @doc("Type filter for search") + kind: "TypeFilter"; + @doc("Type name") + typeName: string; + @doc("Whether to include sub types") + includeSubTypes?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" +@doc("Create time filter for search") +model CreateTimeFilter extends SearchFilter { + @doc("Create time filter for search") + kind: "CreateTimeFilter"; + @doc(""" +Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example +{ + "operator": "lt", + "timeThreshold": 1545580800000 +} +to represent the time filter +""") + createTime: unknown; +} + +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" +@doc("Update time filter for search") +model UpdateTimeFilter extends SearchFilter { + @doc("Update time filter for search") + kind: "UpdateTimeFilter"; + @doc(""" +Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example +{ + "operator": "lt", + "timeThreshold": 1545580800000 +} +to represent the time filter +""") + updateTime: unknown; +} \ No newline at end of file diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 9fca0554f3dd..05f83d98b494 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1030,7 +1030,7 @@ can also be defined during creation. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category. @@ -1043,7 +1043,6 @@ updating shortDescription and longDescription for category. @path categoryGuid: string; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" A map containing keys as attribute names and values as corresponding attribute values for partial update. @@ -1176,7 +1175,7 @@ Optionally it can be categorized as well. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term. @@ -1193,7 +1192,6 @@ shortDescription, longDescription, abbreviation, usage and status for term. @query includeTermHierarchy: boolean; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" A map containing keys as attribute names and values as corresponding attribute values to be updated. @@ -1452,6 +1450,7 @@ Recommend to fetch terms/categories details separately using >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. @@ -1474,7 +1473,6 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. @query ignoreTermsAndCategories: boolean; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" A map containing keys as attribute names and values as corresponding attribute values. From eef5e2bbd24d8f14c1d0931c48af5c2b65ea473a Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 21 Nov 2023 15:03:59 +0800 Subject: [PATCH 014/132] Update routes.tsp --- .../routes.tsp | 200 +++++++++--------- 1 file changed, 96 insertions(+), 104 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 05f83d98b494..33d857746b26 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -28,20 +28,6 @@ model NameInPath { name: string; } -@doc("Operation for Atlas service") -op AtlasOperation< - TParams extends TypeSpec.Reflection.Model, - TResponse, - Traits extends TypeSpec.Reflection.Model = {}, - TErrorResponse = ErrorResponse ->( - ...TraitProperties< - Traits & VersionParameterTrait, - TraitLocation.ApiVersionParameter - >, - ...TParams, -): TResponse | TErrorResponse; - @doc("Operation for DataMap service") op DataMapBaseOperation< TParams extends TypeSpec.Reflection.Model, @@ -71,7 +57,7 @@ For each contact type, the maximum number of contacts is 20. """) @route("/atlas/v2/entity") @post - createOrUpdate is AtlasOperation< + createOrUpdate is DataMapBaseOperation< { @doc(""" Used to define the update behavior for business attributes when updating @@ -99,7 +85,7 @@ need to move an entity to another collection. @doc("List entities in bulk identified by its GUIDs.") @route("/atlas/v2/entity/bulk") @get - listByGuids is AtlasOperation< + listByGuids is DataMapBaseOperation< { @doc("An array of GUIDs of entities to list.") @query({format: "multi"}) @@ -129,7 +115,7 @@ is 20. """) @route("/atlas/v2/entity/bulk") @post - bulkCreateOrUpdate is AtlasOperation< + bulkCreateOrUpdate is DataMapBaseOperation< { @doc(""" The collection where entities will be moved to. Only specify a value if you @@ -161,7 +147,7 @@ attributes. """) @route("/atlas/v2/entity/bulk") @delete - bulkDelete is AtlasOperation< + bulkDelete is DataMapBaseOperation< { @doc("An array of GUIDs of entities to delete.") @query({format: "multi"}) @@ -174,7 +160,7 @@ attributes. @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is AtlasOperation< + addClassification is DataMapBaseOperation< { @doc("The request to associate a classification to multiple entities.") @body @@ -187,7 +173,7 @@ attributes. @doc("Get complete definition of an entity given its GUID.") @route("/atlas/v2/entity/guid/{guid}") @get - get is AtlasOperation< + get is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -216,7 +202,7 @@ possible. """) @route("/atlas/v2/entity/guid/{guid}") @put - partialUpdateAttributeByGuid is AtlasOperation< + partialUpdateAttributeByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -238,7 +224,7 @@ possible. @doc("Delete an entity identified by its GUID.") @route("/atlas/v2/entity/guid/{guid}") @delete - delete is AtlasOperation< + delete is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -251,7 +237,7 @@ possible. @doc("Get classification for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @get - getClassification is AtlasOperation< + getClassification is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -268,7 +254,7 @@ possible. @doc("Delete a given classification from an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @delete - removeClassification is AtlasOperation< + removeClassification is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -285,7 +271,7 @@ possible. @doc("List classifications for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @get - getClassifications is AtlasOperation< + getClassifications is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -299,7 +285,7 @@ possible. @doc("Add classifications to an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @post - addClassifications is AtlasOperation< + addClassifications is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -317,7 +303,7 @@ possible. @doc("Update classifications to an existing entity represented by a guid.") @route("/atlas/v2/entity/guid/{guid}/classifications") @put - updateClassifications is AtlasOperation< + updateClassifications is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -349,7 +335,7 @@ GET """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @get - getByUniqueAttributes is AtlasOperation< + getByUniqueAttributes is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -394,7 +380,7 @@ PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @put - partialUpdateByUniqueAttributes is AtlasOperation< + partialUpdateByUniqueAttributes is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -431,7 +417,7 @@ DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @delete - deleteByUniqueAttribute is AtlasOperation< + deleteByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -454,7 +440,7 @@ attributes. """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") @delete - removeClassificationByUniqueAttribute is AtlasOperation< + removeClassificationByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -479,7 +465,7 @@ be changed to other unique attributes) @doc("Add classification to the entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @post - addClassificationsByUniqueAttribute is AtlasOperation< + addClassificationsByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -504,7 +490,7 @@ be changed to other unique attributes) @doc("Update classification on an entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @put - updateClassificationsByUniqueAttribute is AtlasOperation< + updateClassificationsByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -528,7 +514,7 @@ be changed to other unique attributes) @doc("Set classifications on entities in bulk.") @route("/atlas/v2/entity/bulk/setClassifications") @post - bulkSetClassifications is AtlasOperation< + bulkSetClassifications is DataMapBaseOperation< { @doc("Atlas entity headers.") @body @@ -561,7 +547,7 @@ at least one unique attribute must be provided. """) @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") @get - listByUniqueAttributes is AtlasOperation< + listByUniqueAttributes is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -590,7 +576,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Get entity header given its GUID.") @route("/atlas/v2/entity/guid/{guid}/header") @get - getHeader is AtlasOperation< + getHeader is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -603,7 +589,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Remove business metadata from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @delete - removeBusinessMetadata is AtlasOperation< + removeBusinessMetadata is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -620,7 +606,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Add business metadata to an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @post - addOrUpdateBusinessMetadata is AtlasOperation< + addOrUpdateBusinessMetadata is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -644,7 +630,7 @@ default is false. @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @delete - removeBusinessMetadataAttributes is AtlasOperation< + removeBusinessMetadataAttributes is DataMapBaseOperation< { @doc("BusinessMetadata name") @path @@ -666,7 +652,7 @@ default is false. @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @post - addOrUpdateBusinessMetadataAttributes is AtlasOperation< + addOrUpdateBusinessMetadataAttributes is DataMapBaseOperation< { @doc("BusinessMetadata name") @path @@ -686,7 +672,7 @@ default is false. @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get - getSampleBusinessMetadataTemplate is AtlasOperation< + getSampleBusinessMetadataTemplate is DataMapBaseOperation< { @doc("Accept header") @header @@ -699,7 +685,7 @@ default is false. @doc("Upload the file for creating Business Metadata in BULK") @route("/atlas/v2/entity/businessmetadata/import") @post - importBusinessMetadata is AtlasOperation< + importBusinessMetadata is DataMapBaseOperation< { @doc("InputStream of file") @body @@ -713,7 +699,7 @@ default is false. @doc("Delete given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @delete - removeLabels is AtlasOperation< + removeLabels is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -731,7 +717,7 @@ default is false. @doc("Set labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @post - setLabels is AtlasOperation< + setLabels is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -749,7 +735,7 @@ default is false. @doc("Add given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @put - addLabel is AtlasOperation< + addLabel is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -781,7 +767,7 @@ this: DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @delete - removeLabelsByUniqueAttribute is AtlasOperation< + removeLabelsByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -822,7 +808,7 @@ request would look something like this: POST """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @post - setLabelsByUniqueAttribute is AtlasOperation< + setLabelsByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -863,7 +849,7 @@ request would look something like this: PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @put - addLabelsByUniqueAttribute is AtlasOperation< + addLabelsByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -883,6 +869,7 @@ be changed to other unique attributes) void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Move existing entities to the target collection.") @route("/entity/moveTo") @post @@ -914,7 +901,7 @@ and """) @route("/atlas/v2/glossary") @get - list is AtlasOperation< + list is DataMapBaseOperation< { @doc("The page size - by default there is no paging.") @query @@ -940,7 +927,7 @@ and @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is AtlasOperation< + create is DataMapBaseOperation< { @doc(""" Glossary definition, terms & categories can be anchored to a glossary. @@ -958,7 +945,7 @@ the anchor attribute when creating the Term/Category. @doc("Create glossary category in bulk.") @route("/atlas/v2/glossary/categories") @post - createCategories is AtlasOperation< + createCategories is DataMapBaseOperation< { @doc("An array of glossary category definitions to be created.") @body @@ -971,7 +958,7 @@ the anchor attribute when creating the Term/Category. @doc("Create a glossary category.") @route("/atlas/v2/glossary/category") @post - createCategory is AtlasOperation< + createCategory is DataMapBaseOperation< { @doc(""" The glossary category definition. A category must be anchored to a Glossary @@ -989,7 +976,7 @@ can also be defined during creation. @doc("Get specific glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @get - getCategory is AtlasOperation< + getCategory is DataMapBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1002,7 +989,7 @@ can also be defined during creation. @doc("Update the given glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @put - updateCategory is AtlasOperation< + updateCategory is DataMapBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1019,7 +1006,7 @@ can also be defined during creation. @doc("Delete a glossary category.") @route("/atlas/v2/glossary/category/{categoryGuid}") @delete - deleteCategory is AtlasOperation< + deleteCategory is DataMapBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1037,7 +1024,7 @@ updating shortDescription and longDescription for category. """) @route("/atlas/v2/glossary/category/{categoryGuid}/partial") @put - partialUpdateCategory is AtlasOperation< + partialUpdateCategory is DataMapBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1060,7 +1047,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/category/{categoryGuid}/related") @get - listRelatedCategories is AtlasOperation< + listRelatedCategories is DataMapBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1085,7 +1072,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Get all terms associated with the specific category.") @route("/atlas/v2/glossary/category/{categoryGuid}/terms") @get - listCategoryTerms is AtlasOperation< + listCategoryTerms is DataMapBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1110,7 +1097,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Create a glossary term.") @route("/atlas/v2/glossary/term") @post - createTerm is AtlasOperation< + createTerm is DataMapBaseOperation< { @doc("Whether include term hierarchy") @query @@ -1131,7 +1118,7 @@ Optionally it can be categorized as well. @doc("Get a specific glossary term by its GUID. ") @route("/atlas/v2/glossary/term/{termGuid}") @get - getTerm is AtlasOperation< + getTerm is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1144,7 +1131,7 @@ Optionally it can be categorized as well. @doc("Update the given glossary term by its GUID.") @route("/atlas/v2/glossary/term/{termGuid}") @put - updateTerm is AtlasOperation< + updateTerm is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1165,7 +1152,7 @@ Optionally it can be categorized as well. @doc("Delete a glossary term.") @route("/atlas/v2/glossary/term/{termGuid}") @delete - deleteTerm is AtlasOperation< + deleteTerm is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1182,7 +1169,7 @@ shortDescription, longDescription, abbreviation, usage and status for term. """) @route("/atlas/v2/glossary/term/{termGuid}/partial") @put - partialUpdateTerm is AtlasOperation< + partialUpdateTerm is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1207,7 +1194,7 @@ values to be updated. @doc("Create glossary terms in bulk.") @route("/atlas/v2/glossary/terms") @post - createTerms is AtlasOperation< + createTerms is DataMapBaseOperation< { @doc("Whether include term hierarchy") @query @@ -1227,7 +1214,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @get - listEntitiesAssignedWithTerm is AtlasOperation< + listEntitiesAssignedWithTerm is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1260,7 +1247,7 @@ is an alternative to assign a term to multiple entities. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @post - assignTermToEntities is AtlasOperation< + assignTermToEntities is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1278,7 +1265,7 @@ is an alternative to assign a term to multiple entities. @doc("Delete the term assignment for the given list of related objects.") @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @delete - deleteTermAssignmentFromEntities is AtlasOperation< + deleteTermAssignmentFromEntities is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1298,7 +1285,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/terms/{termGuid}/related") @get - listRelatedTerms is AtlasOperation< + listRelatedTerms is DataMapBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1323,7 +1310,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Get a specific Glossary by its GUID.") @route("/atlas/v2/glossary/{glossaryGuid}") @get - get is AtlasOperation< + get is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1336,7 +1323,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Update the given glossary.") @route("/atlas/v2/glossary/{glossaryGuid}") @put - update is AtlasOperation< + update is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1360,7 +1347,7 @@ separate delete terms and categories. """) @route("/atlas/v2/glossary/{glossaryGuid}") @delete - delete is AtlasOperation< + delete is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1376,7 +1363,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories") @get - listCategories is AtlasOperation< + listCategories is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1404,7 +1391,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") @get - listCategoriesHeaders is AtlasOperation< + listCategoriesHeaders is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1440,7 +1427,7 @@ Recommend to fetch terms/categories details separately using """) @route("/atlas/v2/glossary/{glossaryGuid}/detailed") @get - getDetailed is AtlasOperation< + getDetailed is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1463,7 +1450,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. """) @route("/atlas/v2/glossary/{glossaryGuid}/partial") @put - partialUpdate is AtlasOperation< + partialUpdate is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1490,7 +1477,7 @@ pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms") @get - listTerms is AtlasOperation< + listTerms is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1518,7 +1505,7 @@ to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") @get - listTermHeaders is AtlasOperation< + listTermHeaders is DataMapBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1541,6 +1528,7 @@ to get pagination result. } interface Discovery { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get data using search.") @route("/search/query") @post @@ -1553,6 +1541,7 @@ interface Discovery { SearchResult >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get search suggestions by query criteria.") @route("/search/suggest") @post @@ -1565,6 +1554,7 @@ interface Discovery { SuggestResult >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get auto complete options.") @route("/search/autocomplete") @post @@ -1583,7 +1573,7 @@ interface Lineage { @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get - get is AtlasOperation< + get is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1600,6 +1590,7 @@ interface Lineage { AtlasLineageInfo >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Return immediate next page lineage info about entity with pagination") @route("/lineage/{guid}/next/") @get @@ -1645,7 +1636,7 @@ GET """) @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") @get - getByUniqueAttribute is AtlasOperation< + getByUniqueAttribute is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -1675,7 +1666,7 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is AtlasOperation< + create is DataMapBaseOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1691,7 +1682,7 @@ be created. @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is AtlasOperation< + update is DataMapBaseOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1707,7 +1698,7 @@ be created. @doc("Get relationship information between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @get - get is AtlasOperation< + get is DataMapBaseOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1724,7 +1715,7 @@ be created. @doc("Delete a relationship between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @delete - delete is AtlasOperation< + delete is DataMapBaseOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1760,7 +1751,7 @@ be created. // @doc("Get the term template definition for the given GUID.") // @route("/test/termtemplatedef/guid/{guid}") // @get -// get_TermTemplateDefByGuid is AtlasOperation< +// get_TermTemplateDefByGuid is DataMapBaseOperation< // { // @doc("Ddd") // @path @@ -1775,7 +1766,7 @@ interface TypeDef{ @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get - getBusinessMetadataDefByGuid is AtlasOperation< + getBusinessMetadataDefByGuid is DataMapBaseOperation< { @doc("businessMetadata guid") @path @@ -1788,7 +1779,7 @@ interface TypeDef{ @doc("Get the businessMetadata definition by it's name (unique).") @route("/atlas/v2/types/businessmetadatadef/name/{name}") @get - getBusinessMetadataDefByName is AtlasOperation< + getBusinessMetadataDefByName is DataMapBaseOperation< { @doc("businessMetadata name") @path @@ -1801,7 +1792,7 @@ interface TypeDef{ @doc("Get the classification definition for the given GUID.") @route("/atlas/v2/types/classificationdef/guid/{guid}") @get - getClassificationDefByGuid is AtlasOperation< + getClassificationDefByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the classification.") @path @@ -1814,7 +1805,7 @@ interface TypeDef{ @doc("Get the classification definition by its name (unique).") @route("/atlas/v2/types/classificationdef/name/{name}") @get - getClassificationDefByName is AtlasOperation< + getClassificationDefByName is DataMapBaseOperation< { @doc("The name of the classification.") @path @@ -1827,7 +1818,7 @@ interface TypeDef{ @doc("Get the Entity definition for the given GUID.") @route("/atlas/v2/types/entitydef/guid/{guid}") @get - getEntityDefByGuid is AtlasOperation< + getEntityDefByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1840,7 +1831,7 @@ interface TypeDef{ @doc("Get the entity definition by its name (unique).") @route("/atlas/v2/types/entitydef/name/{name}") @get - getEntityDefByName is AtlasOperation< + getEntityDefByName is DataMapBaseOperation< { @doc("The name of the entity.") @path @@ -1853,7 +1844,7 @@ interface TypeDef{ @doc("Get the enum definition for the given GUID.") @route("/atlas/v2/types/enumdef/guid/{guid}") @get - getEnumDefByGuid is AtlasOperation< + getEnumDefByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the enum.") @path @@ -1866,7 +1857,7 @@ interface TypeDef{ @doc("Get the enum definition by its name (unique).") @route("/atlas/v2/types/enumdef/name/{name}") @get - getEnumDefByName is AtlasOperation< + getEnumDefByName is DataMapBaseOperation< { @doc("The name of the enum.") @path @@ -1879,7 +1870,7 @@ interface TypeDef{ @doc("Get the relationship definition for the given GUID.") @route("/atlas/v2/types/relationshipdef/guid/{guid}") @get - getRelationshipDefByGuid is AtlasOperation< + getRelationshipDefByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1892,7 +1883,7 @@ interface TypeDef{ @doc("Get the relationship definition by its name (unique).") @route("/atlas/v2/types/relationshipdef/name/{name}") @get - getRelationshipDefByName is AtlasOperation< + getRelationshipDefByName is DataMapBaseOperation< { @doc("The name of the relationship.") @path @@ -1905,7 +1896,7 @@ interface TypeDef{ @doc("Get the struct definition for the given GUID.") @route("/atlas/v2/types/structdef/guid/{guid}") @get - getStructDefByGuid is AtlasOperation< + getStructDefByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the struct.") @path @@ -1918,7 +1909,7 @@ interface TypeDef{ @doc("Get the struct definition by its name (unique).") @route("/atlas/v2/types/structdef/name/{name}") @get - getStructDefByName is AtlasOperation< + getStructDefByName is DataMapBaseOperation< { @doc("The name of the struct.") @path @@ -1931,7 +1922,7 @@ interface TypeDef{ @doc("Get the type definition for the given GUID.") @route("/atlas/v2/types/typedef/guid/{guid}") @get - getByGuid is AtlasOperation< + getByGuid is DataMapBaseOperation< { @doc("The globally unique identifier of the type.") @path @@ -1944,7 +1935,7 @@ interface TypeDef{ @doc("Get the type definition by its name (unique).") @route("/atlas/v2/types/typedef/name/{name}") @get - getByName is AtlasOperation< + getByName is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -1957,7 +1948,7 @@ interface TypeDef{ @doc("Delete API for type identified by its name.") @route("/atlas/v2/types/typedef/name/{name}") @delete - delete is AtlasOperation< + delete is DataMapBaseOperation< { @doc("The name of the type.") @path @@ -1970,7 +1961,7 @@ interface TypeDef{ @doc("List all type definitions in bulk.") @route("/atlas/v2/types/typedefs") @get - list is AtlasOperation< + list is DataMapBaseOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -1995,7 +1986,7 @@ Any changes to the existing definitions will be discarded. """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is AtlasOperation< + bulkCreate is DataMapBaseOperation< { @doc("A composite wrapper object with corresponding lists of the type definition.") @body @@ -2011,7 +2002,7 @@ persisted. """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is AtlasOperation< + bulkUpdate is DataMapBaseOperation< { @doc("A composite object that captures all type definition changes.") @body @@ -2024,7 +2015,7 @@ persisted. @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is AtlasOperation< + bulkDelete is DataMapBaseOperation< { @doc("A composite object that captures all types to be deleted") @body @@ -2037,7 +2028,7 @@ persisted. @doc("List all type definitions returned as a list of minimal information header.") @route("/atlas/v2/types/typedefs/headers") @get - listHeaders is AtlasOperation< + listHeaders is DataMapBaseOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -2054,6 +2045,7 @@ when search filter type=term_template void >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get the term template definition for the given GUID.") @route("/types/termtemplatedef/guid/{guid}") @get From 634fb65337abcc05d87d156dda52e96d8321aac4 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 22 Nov 2023 16:51:54 +0800 Subject: [PATCH 015/132] Update tspconfig.yaml --- .../purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 2b52ec73631c..f25aed928bf1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -1,6 +1,6 @@ parameters: "service-dir": - default: "sdk/azure.analytics.purview.datamap" + default: "sdk/purview" "dependencies": "additionalDirectories": [] default: "" @@ -22,11 +22,11 @@ options: clear-output-folder: true model-namespace: false "@azure-tools/typespec-ts": - package-dir: "azure-analytics-purview-datamap-rest" + package-dir: "analytics-purview-datamap" generateMetadata: true generateTest: true packageDetails: - name: "@azure-rest/azure-analytics-purview-datamap-rest" + name: "@azure-rest/analytics-purview-datamap" description: "Azure.Analytics.Purview.DataMap Service" "@azure-tools/typespec-java": package-dir: "azure-analytics-purview-datamap" From 58d42dd03463933c013b17b9552f19b30f368d0e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 09:22:15 +0800 Subject: [PATCH 016/132] update interface name --- .../models.tsp | 2 +- .../routes.tsp | 42 ++----------------- .../2023-09-01/examples/Type_BulkCreate.json | 4 +- .../2023-09-01/examples/Type_BulkDelete.json | 4 +- .../2023-09-01/examples/Type_BulkUpdate.json | 4 +- .../2023-09-01/examples/Type_Delete.json | 4 +- .../Type_GetBusinessMetadataDefByGuid.json | 4 +- .../Type_GetBusinessMetadataDefByName.json | 4 +- .../2023-09-01/examples/Type_GetByGuid.json | 4 +- .../2023-09-01/examples/Type_GetByName.json | 4 +- .../Type_GetClassificationDefByGuid.json | 4 +- .../Type_GetClassificationDefByName.json | 4 +- .../examples/Type_GetEntityDefByGuid.json | 4 +- .../examples/Type_GetEntityDefByName.json | 4 +- .../examples/Type_GetEnumDefByGuid.json | 4 +- .../examples/Type_GetEnumDefByName.json | 4 +- .../Type_GetRelationshipDefByGuid.json | 4 +- .../Type_GetRelationshipDefByName.json | 4 +- .../examples/Type_GetStructDefByGuid.json | 4 +- .../examples/Type_GetStructDefByName.json | 4 +- .../Type_GetTermTemplateDefByGuid.json | 4 +- .../Type_GetTermTemplateDefByName.json | 4 +- .../stable/2023-09-01/examples/Type_List.json | 4 +- .../2023-09-01/examples/Type_ListHeaders.json | 4 +- 24 files changed, 70 insertions(+), 62 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 9fec6af387cd..462322b91512 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -179,7 +179,7 @@ enum RelationshipCategory { } @doc("Type") -enum Type { +enum Typedef { @doc("enum") `enum`, @doc("entity") diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 33d857746b26..5e9cdb10a279 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1725,43 +1725,7 @@ be created. >; } -// @doc("Guid") -// @resource("guid") -// model Guid { -// @key("guid") -// @visibility("read") -// @doc("guid") -// guid: string; -// } - -// @doc("Name") -// @resource("name") -// model Name { -// @key("name") -// @visibility("read") -// @doc("name") -// name: string; -// } - - - -// alias ReadByNameOperations = Azure.Core.ResourceOperations; -// alias ReadByGuidOperations = Azure.Core.ResourceOperations; -// interface Test{ -// @doc("Get the term template definition for the given GUID.") -// @route("/test/termtemplatedef/guid/{guid}") -// @get -// get_TermTemplateDefByGuid is DataMapBaseOperation< -// { -// @doc("Ddd") -// @path -// guid: string; -// }, -// TermTemplateDef -// >; -// } - -interface TypeDef{ +interface `Type`{ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @@ -1973,7 +1937,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type: Type; + type: Typedef; }, AtlasTypesDef >; @@ -2040,7 +2004,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type: Type; + type: Typedef; }, void >; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index 3c08502d3e0f..cdb16a858b47 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -67,5 +67,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_BulkCreate", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index 40e463be1ce9..eda61c210ee7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -29,5 +29,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_BulkDelete", + "operationId": "Type_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index fd37acb1ec1c..3216472dba52 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -284,5 +284,7 @@ ] } } - } + }, + "title": "Type_BulkUpdate", + "operationId": "Type_BulkUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json index d95c0728b9cb..8a364027401e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_Delete", + "operationId": "Type_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json index 5790a0df446e..34921a8239b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByGuid", + "operationId": "Type_GetBusinessMetadataDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json index 89abf18c256d..64d92fefd723 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByName", + "operationId": "Type_GetBusinessMetadataDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json index ebd1ed4902de..e94b5ad8b518 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByGuid", + "operationId": "Type_GetByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json index 77ec05812c26..804029d070e1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByName", + "operationId": "Type_GetByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json index 31f09a6d61e6..bf27840af6aa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByGuid", + "operationId": "Type_GetClassificationDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json index b7d7ed8a4f74..e7a58bf32bfb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByName", + "operationId": "Type_GetClassificationDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json index 2728fb2507c3..9c0d6ce53cb7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByGuid", + "operationId": "Type_GetEntityDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json index 0542db979369..140ba1a5b309 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByName", + "operationId": "Type_GetEntityDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json index 9c324ce8d35b..ab9e4048b0d2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByGuid", + "operationId": "Type_GetEnumDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json index 6adfee266b61..62907f8f6a69 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByName", + "operationId": "Type_GetEnumDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json index 66b6efd3f8bf..71c9a03a65d9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByGuid", + "operationId": "Type_GetRelationshipDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json index 148c7d655371..ecdafc07a934 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByName", + "operationId": "Type_GetRelationshipDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json index d2e1e0901f30..c31ae06aeeb6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByGuid", + "operationId": "Type_GetStructDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json index 6bffd4888fa2..26f8e843a6d6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByName", + "operationId": "Type_GetStructDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json index fc5c6208e066..e6c263c691e5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByGuid", + "operationId": "Type_GetTermTemplateDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json index 72f8d97172d8..d8b28d19db05 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByName", + "operationId": "Type_GetTermTemplateDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4e6b37b8b6f1..4f9be7fe0434 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -265,5 +265,7 @@ ] } } - } + }, + "title": "Type_List", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json index 99ec7d9d00b2..288c815d8a88 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json @@ -23,5 +23,7 @@ } ] } - } + }, + "title": "Type_ListHeaders", + "operationId": "Type_ListHeaders" } From 5ea5a2c4831b22f7058e189783c0c16366823589 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 15:18:08 +0800 Subject: [PATCH 017/132] update query parameter to non-requried and correct int mdoel --- .../models.tsp | 42 +++-- .../routes.tsp | 146 +++++++++--------- 2 files changed, 95 insertions(+), 93 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 462322b91512..962412fe27a3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -218,7 +218,7 @@ model AtlasEntity { classifications?: AtlasClassification[]; @doc("The created time of the record.") - createTime?: int32; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @@ -246,7 +246,7 @@ model AtlasEntity { meanings?: AtlasTermAssignmentHeader[]; @doc("Used to record the provenance of an instance of an entity or relationship.") - provenanceType?: float32; + provenanceType?: int32; @doc("Determines if there's a proxy.") proxy?: boolean; @@ -262,13 +262,13 @@ removed. status?: Status; @doc("The update time of the record.") - updateTime?: int32; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @doc("The version of the entity.") - version?: float32; + version?: int64; @doc("The dictionary of contacts for entities. Key could be Expert or Owner.") contacts?: Record; @@ -605,13 +605,13 @@ model AtlasGlossaryBaseObject { lastModifiedTS?: string; @doc("The created time of the record.") - createTime?: int32; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @doc("The update time of the record.") - updateTime?: int32; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @@ -1000,10 +1000,10 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - createTime?: int32; + createTime?: int64; @doc("The last update time of the record. The Unix epoch format.") - updateTime?: int32; + updateTime?: int64; @doc("The GUID of the record.") id?: string; @@ -1160,10 +1160,10 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - createTime?: int32; + createTime?: int64; @doc("The last update time of the record. The Unix epoch format.") - updateTime?: int32; + updateTime?: int64; @doc("The GUID of the record.") id?: string; @@ -1315,7 +1315,7 @@ model AtlasRelationship { ...AtlasStruct; @doc("The created time of the record.") - createTime?: int32; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @@ -1336,19 +1336,19 @@ model AtlasRelationship { label?: string; @doc("Used to record the provenance of an instance of an entity or relationship") - provenanceType?: float32; + provenanceType?: int32; @doc("The enum of relationship status.") status?: StatusAtlasRelationship; @doc("The update time of the record.") - updateTime?: int32; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @doc("The version of the relationship.") - version?: float32; + version?: int64; } @doc("The relationship with extended information.") @@ -1432,7 +1432,7 @@ model AtlasBaseTypeDef { category?: TypeCategory; @doc("The created time of the record.") - createTime?: int32; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @@ -1446,10 +1446,8 @@ model AtlasBaseTypeDef { @doc("The GUID of the type definition.") guid?: string; - @key("name") - @visibility("read") @doc("The name of the type definition.") - name: string; + name?: string; @doc("The options for the type definition.") options?: Record; @@ -1461,13 +1459,13 @@ model AtlasBaseTypeDef { typeVersion?: string; @doc("The update time of the record.") - updateTime?: int32; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @doc("The version of the record.") - version?: float32; + version?: int64; @doc("ETag for concurrency control.") lastModifiedTS?: string; @@ -1652,7 +1650,7 @@ model AtlasEnumElementDef { description?: string; @doc("The ordinal of the enum element definition.") - ordinal?: float32; + ordinal?: int32; @doc("The value of the enum element definition.") value?: string; @@ -1890,8 +1888,6 @@ model AtlasTypesDef { } @doc("Term template definition for glossary term.") -@resource("name") -@resource("guid") model TermTemplateDef { ...AtlasStructDef; } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 5e9cdb10a279..5599e699b047 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -64,14 +64,14 @@ Used to define the update behavior for business attributes when updating entities. """) @query - businessAttributeUpdateBehavior: BusinessAttributeUpdateBehavior; + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; @doc(""" The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. """) @query - collectionId: string; + collectionId?: string; @doc("Atlas entity with extended information.") @body @@ -93,11 +93,11 @@ need to move an entity to another collection. @doc("Whether to return minimal information for referred entities.") @query - minExtInfo: boolean; + minExtInfo?: boolean; @doc("Whether to ignore relationship attributes.") @query - ignoreRelationships: boolean; + ignoreRelationships?: boolean; }, AtlasEntitiesWithExtInfo >; @@ -122,14 +122,14 @@ The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. """) @query - collectionId: string; + collectionId?: string; @doc(""" Used to define the update behavior for business attributes when updating entities. """) @query - businessAttributeUpdateBehavior: BusinessAttributeUpdateBehavior; + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; @doc("An array of entities to create or update.") @body @@ -181,11 +181,11 @@ attributes. @doc("Whether to return minimal information for referred entities.") @query - minExtInfo: boolean; + minExtInfo?: boolean; @doc("Whether to ignore relationship attributes.") @query - ignoreRelationships: boolean; + ignoreRelationships?: boolean; }, AtlasEntityWithExtInfo >; @@ -343,18 +343,18 @@ GET @doc("Whether to return minimal information for referred entities.") @query - minExtInfo: boolean; + minExtInfo?: boolean; @doc("Whether to ignore relationship attributes.") @query - ignoreRelationships: boolean; + ignoreRelationships?: boolean; @doc(""" The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; }, AtlasEntityWithExtInfo >; @@ -391,7 +391,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; @doc("Atlas entity with extended information.") @body @@ -428,7 +428,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; }, EntityMutationResponse >; @@ -455,7 +455,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; }, void >; @@ -476,7 +476,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; @doc("An array of classification to be added.") @body @@ -501,7 +501,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; @doc("An array of classification to be updated.") @body @@ -555,11 +555,11 @@ at least one unique attribute must be provided. @doc("Whether to return minimal information for referred entities.") @query - minExtInfo: boolean; + minExtInfo?: boolean; @doc("Whether to ignore relationship attributes.") @query - ignoreRelationships: boolean; + ignoreRelationships?: boolean; @doc(""" Qualified name of an entity. E.g. to find 2 entities you can set @@ -617,7 +617,7 @@ Whether to overwrite the existing business metadata on the entity or not, default is false. """) @query - isOverwrite: boolean; + isOverwrite?: boolean; @doc("BusinessMetadata payload") #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @body businessMetadata: Record; @@ -778,7 +778,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; @doc("set of labels to be deleted") @body @@ -819,7 +819,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; @doc("set of labels to be set") @body @@ -860,7 +860,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; @doc("set of labels to be added") @body @@ -905,19 +905,19 @@ and { @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; @doc("Whether ignore terms and categories") @query - ignoreTermsAndCategories: boolean; + ignoreTermsAndCategories?: boolean; }, void >; @@ -1055,15 +1055,15 @@ parameters are currently not being enabled and won't work even they are passed. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1080,15 +1080,15 @@ parameters are currently not being enabled and won't work even they are passed. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1101,7 +1101,7 @@ parameters are currently not being enabled and won't work even they are passed. { @doc("Whether include term hierarchy") @query - includeTermHierarchy: boolean; + includeTermHierarchy?: boolean; @doc(""" The glossary term definition. A term must be anchored to a Glossary at the time @@ -1139,7 +1139,7 @@ Optionally it can be categorized as well. @doc("Whether include term hierarchy") @query - includeTermHierarchy: boolean; + includeTermHierarchy?: boolean; @doc("The glossary term to be updated.") @body @@ -1177,7 +1177,7 @@ shortDescription, longDescription, abbreviation, usage and status for term. @doc("Whether include term hierarchy") @query - includeTermHierarchy: boolean; + includeTermHierarchy?: boolean; @doc(""" A map containing keys as attribute names and values as corresponding attribute @@ -1198,7 +1198,7 @@ values to be updated. { @doc("Whether include term hierarchy") @query - includeTermHierarchy: boolean; + includeTermHierarchy?: boolean; @doc("An array of glossary term definitions to be created in bulk.") @body @@ -1222,15 +1222,15 @@ limit/offset to get pagination result. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1293,15 +1293,15 @@ parameters are currently not being enabled and won't work even they are passed. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1331,7 +1331,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Whether ignore terms and categories") @query - ignoreTermsAndCategories: boolean; + ignoreTermsAndCategories?: boolean; @doc("The glossary definition to be updated.") @body @@ -1371,15 +1371,15 @@ limit/offset to get pagination result. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1399,15 +1399,15 @@ limit/offset to get pagination result. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1458,7 +1458,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. @doc("Whether ignore terms and categories") @query - ignoreTermsAndCategories: boolean; + ignoreTermsAndCategories?: boolean; @doc(""" A map containing keys as attribute names and values as corresponding attribute @@ -1485,15 +1485,15 @@ pagination result. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1513,15 +1513,15 @@ to get pagination result. @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The sort order, ASC (default) or DESC.") @query - sort: string; + sort?: string; }, void >; @@ -1581,7 +1581,7 @@ interface Lineage { @doc("The number of hops for lineage.") @query - depth: int32; + depth?: int32; @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") @query @@ -1606,11 +1606,11 @@ interface Lineage { @doc("The offset for pagination purpose.") @query - offset: int32; + offset?: int32; @doc("The page size - by default there is no paging.") @query - limit: int32; + limit?: int32; }, AtlasLineageInfo >; @@ -1644,7 +1644,7 @@ GET @doc("The number of hops for lineage.") @query - depth: int32; + depth?: int32; @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") @query @@ -1655,7 +1655,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr: string; + attr?: string; }, AtlasLineageInfo >; @@ -1706,7 +1706,7 @@ be created. @doc("Limits whether includes extended information.") @query - extendedInfo: boolean; + extendedInfo?: boolean; }, AtlasRelationshipWithExtInfo >; @@ -1933,11 +1933,11 @@ This is always true when search filter type=term_template """) @query - includeTermTemplate: boolean; + includeTermTemplate?: boolean; @doc("Typedef name as search filter when get typedefs.") @query - type: Typedef; + type?: Typedef; }, AtlasTypesDef >; @@ -2000,11 +2000,11 @@ This is always true when search filter type=term_template """) @query - includeTermTemplate: boolean; + includeTermTemplate?: boolean; @doc("Typedef name as search filter when get typedefs.") @query - type: Typedef; + type?: Typedef; }, void >; @@ -2022,10 +2022,16 @@ when search filter type=term_template TermTemplateDef >; - - #suppress "@azure-tools/typespec-azure-core/no-explicit-routes-resource-ops" "Need to put types API under the same interface" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get the term template definition by its name (unique).") - @route("/types/termtemplatedef") + @route("/types/termtemplatedef/name/{name}") @get - getTermTemplateDefByName is DataMapResourceOperations.ResourceRead; + getTermTemplateDefByName is DataMapBaseOperation< + { + @doc("The unique name of the term template.") + @path + name: string; + }, + TermTemplateDef +>; } From a989ff1bacac0ec91079cedfd5823975f5a74588 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 16:45:51 +0800 Subject: [PATCH 018/132] correct response status code from 204 to 200 --- .../routes.tsp | 47 ++++++++++--------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 5599e699b047..2fb0b1e06fd1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -19,6 +19,13 @@ model ApiVersionParameter { apiVersion: string; } +model OkResponse { + @statusCode + status: 200; + @body + data: T; +} + @doc("The path for name.") @resource("name") model NameInPath { @@ -520,7 +527,7 @@ be changed to other unique attributes) @body entityHeaders: AtlasEntityHeaders; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -567,7 +574,7 @@ attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query - `attr_N:qualifiedName`: string; + `attr_N:qualifiedName`?: string; }, AtlasEntitiesWithExtInfo >; @@ -672,14 +679,10 @@ default is false. @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get - getSampleBusinessMetadataTemplate is DataMapBaseOperation< - { - @doc("Accept header") - @header - accept: "application/octet-stream"; - }, - void - >; + getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation<{}, { + @header contentType: "application/octet-stream"; + @body template: bytes; + }>; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Upload the file for creating Business Metadata in BULK") @@ -919,7 +922,7 @@ and @query ignoreTermsAndCategories?: boolean; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -951,7 +954,7 @@ the anchor attribute when creating the Term/Category. @body glossaryCategory: AtlasGlossaryCategory[]; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1065,7 +1068,7 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - void + OkResponse> >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1090,7 +1093,7 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1204,7 +1207,7 @@ values to be updated. @body glossaryTerm: AtlasGlossaryTerm[]; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1232,7 +1235,7 @@ limit/offset to get pagination result. @query sort?: string; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1303,7 +1306,7 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - void + OkResponse> >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1381,7 +1384,7 @@ limit/offset to get pagination result. @query sort?: string; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1409,7 +1412,7 @@ limit/offset to get pagination result. @query sort?: string; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1495,7 +1498,7 @@ pagination result. @query sort?: string; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1523,7 +1526,7 @@ to get pagination result. @query sort?: string; }, - void + OkResponse >; } @@ -2006,7 +2009,7 @@ when search filter type=term_template @query type?: Typedef; }, - void + OkResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" From 513fc8b1883014d8be6579070b8616b9c7aaff0e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 16:45:56 +0800 Subject: [PATCH 019/132] Create openapi.json --- .../stable/2023-09-01/openapi.json | 9214 +++++++++++++++++ 1 file changed, 9214 insertions(+) create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json new file mode 100644 index 000000000000..e1bf2f50f25a --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -0,0 +1,9214 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Analytics Purview Data Map", + "version": "2023-09-01", + "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/datamap/api", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "" + } + } + }, + "tags": [], + "paths": { + "/atlas/v2/entity": { + "post": { + "operationId": "Entity_CreateOrUpdate", + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" + }, + { + "name": "entity", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/bulk": { + "get": { + "operationId": "Entity_ListByGuids", + "description": "List entities in bulk identified by its GUIDs.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to list.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } + } + }, + "post": { + "operationId": "Entity_BulkCreateOrUpdate", + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" + }, + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "entities", + "in": "body", + "description": "An array of entities to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Entity_BulkDelete", + "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to delete.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } + } + } + }, + "/atlas/v2/entity/bulk/classification": { + "post": { + "operationId": "Entity_AddClassification", + "description": "Associate a classification to multiple entities in bulk.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "in": "body", + "description": "The request to associate a classification to multiple entities.", + "required": true, + "schema": { + "$ref": "#/definitions/ClassificationAssociateRequest" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "operationId": "Entity_BulkSetClassifications", + "description": "Set classifications on entities in bulk.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "entityHeaders", + "in": "body", + "description": "Atlas entity headers.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" + } + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_ListByUniqueAttributes", + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "operationId": "Entity_ImportBusinessMetadata", + "description": "Upload the file for creating Business Metadata in BULK", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "uploadedInputStream", + "in": "body", + "description": "InputStream of file", + "required": true, + "schema": { + "type": "string", + "format": "byte" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BulkImportResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import/template": { + "get": { + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "operationId": "Entity_Get", + "description": "Get complete definition of an entity given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" + } + } + }, + "put": { + "operationId": "Entity_PartialUpdateAttributeByGuid", + "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not\nsupport updating complex types like arrays, and maps.\nNull updates are not\npossible.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The value of the attribute.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_PartialUpdateAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + } + } + }, + "delete": { + "operationId": "Entity_Delete", + "description": "Delete an entity identified by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "description": "Add business metadata to an entity.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "isOverwrite", + "in": "query", + "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", + "required": false, + "type": "boolean" + }, + { + "name": "businessMetadata", + "in": "body", + "description": "BusinessMetadata payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadata", + "description": "Remove business metadata from an entity.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "businessMetadata", + "in": "body", + "description": "Business metadata payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "description": "Add or update business metadata attributes.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "bmName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "businessMetadataAttributes", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "description": "Delete business metadata attributes from an entity.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "bmName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "businessMetadataAttributes", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "operationId": "Entity_GetClassification", + "description": "Get classification for a given entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveClassification", + "description": "Delete a given classification from an existing entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "operationId": "Entity_GetClassifications", + "description": "List classifications for a given entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } + } + }, + "put": { + "operationId": "Entity_UpdateClassifications", + "description": "Update classifications to an existing entity represented by a guid.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classifications", + "in": "body", + "description": "An array of classifications to be updated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" + } + } + }, + "post": { + "operationId": "Entity_AddClassifications", + "description": "Add classifications to an existing entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classifications", + "in": "body", + "description": "An array of classifications to be added.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/header": { + "get": { + "operationId": "Entity_GetHeader", + "description": "Get entity header given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetHeader": { + "$ref": "./examples/Entity_GetHeader.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/labels": { + "put": { + "operationId": "Entity_AddLabel", + "description": "Add given labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be added", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "operationId": "Entity_SetLabels", + "description": "Set labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be set to the entity", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "Entity_RemoveLabels", + "description": "Delete given labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be deleted", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_GetByUniqueAttributes", + "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" + } + } + }, + "put": { + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "atlasEntityWithExtInfo", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_PartialUpdateByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + } + } + }, + "delete": { + "operationId": "Entity_DeleteByUniqueAttribute", + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { + "delete": { + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "put": { + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "description": "Update classification on an entity identified by its type and unique attributes.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "atlasClassificationArray", + "in": "body", + "description": "An array of classification to be updated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" + } + } + }, + "post": { + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "description": "Add classification to the entity identified by its type and unique attributes.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "atlasClassificationArray", + "in": "body", + "description": "An array of classification to be added.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { + "put": { + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be added", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } + } + }, + "post": { + "operationId": "Entity_SetLabelsByUniqueAttribute", + "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be set", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be deleted", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/glossary": { + "get": { + "operationId": "Glossary_List", + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossary" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } + } + }, + "post": { + "operationId": "Glossary_Create", + "description": "Create a glossary.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "atlasGlossary", + "in": "body", + "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}": { + "get": { + "operationId": "Glossary_Get", + "description": "Get a specific Glossary by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" + } + } + }, + "put": { + "operationId": "Glossary_Update", + "description": "Update the given glossary.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "updatedGlossary", + "in": "body", + "description": "The glossary definition to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" + } + } + }, + "delete": { + "operationId": "Glossary_Delete", + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/categories": { + "get": { + "operationId": "Glossary_ListCategories", + "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { + "get": { + "operationId": "Glossary_ListCategoriesHeaders", + "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "get": { + "operationId": "Glossary_GetDetailed", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\n\n'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET\n'/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/partial": { + "put": { + "operationId": "Glossary_PartialUpdate", + "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "partialUpdates", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/terms": { + "get": { + "operationId": "Glossary_ListTerms", + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "get": { + "operationId": "Glossary_ListTermHeaders", + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } + } + } + }, + "/atlas/v2/glossary/categories": { + "post": { + "operationId": "Glossary_CreateCategories", + "description": "Create glossary category in bulk.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryCategory", + "in": "body", + "description": "An array of glossary category definitions to be created.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" + } + } + } + }, + "/atlas/v2/glossary/category": { + "post": { + "operationId": "Glossary_CreateCategory", + "description": "Create a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "glossaryCategory", + "in": "body", + "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}": { + "get": { + "operationId": "Glossary_GetCategory", + "description": "Get specific glossary category by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" + } + } + }, + "put": { + "operationId": "Glossary_UpdateCategory", + "description": "Update the given glossary category by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "glossaryCategory", + "in": "body", + "description": "The glossary category to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteCategory", + "description": "Delete a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateCategory", + "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "partialUpdates", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/related": { + "get": { + "operationId": "Glossary_ListRelatedCategories", + "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "get": { + "operationId": "Glossary_ListCategoryTerms", + "description": "Get all terms associated with the specific category.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" + } + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "operationId": "Glossary_CreateTerm", + "description": "Create a glossary term.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "glossaryTerm", + "in": "body", + "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" + } + } + } + }, + "/atlas/v2/glossary/term/{termGuid}": { + "get": { + "operationId": "Glossary_GetTerm", + "description": "Get a specific glossary term by its GUID. ", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" + } + } + }, + "put": { + "operationId": "Glossary_UpdateTerm", + "description": "Update the given glossary term by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "glossaryTerm", + "in": "body", + "description": "The glossary term to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteTerm", + "description": "Delete a glossary term.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } + } + } + }, + "/atlas/v2/glossary/term/{termGuid}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateTerm", + "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "partialUpdates", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } + } + } + }, + "/atlas/v2/glossary/terms": { + "post": { + "operationId": "Glossary_CreateTerms", + "description": "Create glossary terms in bulk.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "glossaryTerm", + "in": "body", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } + } + } + }, + "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "get": { + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" + } + } + }, + "post": { + "operationId": "Glossary_AssignTermToEntities", + "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "relatedObjectIds", + "in": "body", + "description": "An array of related object IDs to which the term has to be associated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "description": "Delete the term assignment for the given list of related objects.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "relatedObjectIds", + "in": "body", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/terms/{termGuid}/related": { + "get": { + "operationId": "Glossary_ListRelatedTerms", + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" + } + } + } + }, + "/atlas/v2/lineage/{guid}": { + "get": { + "operationId": "Lineage_Get", + "description": "Get lineage info of the entity specified by GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } + } + } + }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Lineage_GetByUniqueAttribute", + "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/relationship": { + "put": { + "operationId": "Relationship_Update", + "description": "Update an existing relationship between entities.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "relationship", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" + } + } + }, + "post": { + "operationId": "Relationship_Create", + "description": "Create a new relationship between entities.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "relationship", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } + } + } + }, + "/atlas/v2/relationship/guid/{guid}": { + "get": { + "operationId": "Relationship_Get", + "description": "Get relationship information between entities by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + }, + { + "name": "extendedInfo", + "in": "query", + "description": "Limits whether includes extended information.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" + } + } + }, + "delete": { + "operationId": "Relationship_Delete", + "description": "Delete a relationship between entities by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByGuid", + "description": "Get the businessMetadata definition for the given guid.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "businessMetadata guid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByName", + "description": "Get the businessMetadata definition by it's name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "businessMetadata name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } + } + } + }, + "/atlas/v2/types/classificationdef/guid/{guid}": { + "get": { + "operationId": "Type_GetClassificationDefByGuid", + "description": "Get the classification definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "operationId": "Type_GetClassificationDefByName", + "description": "Get the classification definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } + } + } + }, + "/atlas/v2/types/entitydef/guid/{guid}": { + "get": { + "operationId": "Type_GetEntityDefByGuid", + "description": "Get the Entity definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/entitydef/name/{name}": { + "get": { + "operationId": "Type_GetEntityDefByName", + "description": "Get the entity definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEntityDefByName": { + "$ref": "./examples/Type_GetEntityDefByName.json" + } + } + } + }, + "/atlas/v2/types/enumdef/guid/{guid}": { + "get": { + "operationId": "Type_GetEnumDefByGuid", + "description": "Get the enum definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the enum.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/enumdef/name/{name}": { + "get": { + "operationId": "Type_GetEnumDefByName", + "description": "Get the enum definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the enum.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } + } + } + }, + "/atlas/v2/types/relationshipdef/guid/{guid}": { + "get": { + "operationId": "Type_GetRelationshipDefByGuid", + "description": "Get the relationship definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/relationshipdef/name/{name}": { + "get": { + "operationId": "Type_GetRelationshipDefByName", + "description": "Get the relationship definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } + } + } + }, + "/atlas/v2/types/structdef/guid/{guid}": { + "get": { + "operationId": "Type_GetStructDefByGuid", + "description": "Get the struct definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the struct.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetStructDefByGuid": { + "$ref": "./examples/Type_GetStructDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/structdef/name/{name}": { + "get": { + "operationId": "Type_GetStructDefByName", + "description": "Get the struct definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the struct.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } + } + } + }, + "/atlas/v2/types/typedef/guid/{guid}": { + "get": { + "operationId": "Type_GetByGuid", + "description": "Get the type definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } + } + } + }, + "/atlas/v2/types/typedef/name/{name}": { + "get": { + "operationId": "Type_GetByName", + "description": "Get the type definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" + } + } + }, + "delete": { + "operationId": "Type_Delete", + "description": "Delete API for type identified by its name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } + } + } + }, + "/atlas/v2/types/typedefs": { + "get": { + "operationId": "Type_List", + "description": "List all type definitions in bulk.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" + }, + { + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "Typedef", + "modelAsString": true, + "values": [ + { + "name": "enum", + "value": "enum", + "description": "enum" + }, + { + "name": "entity", + "value": "entity", + "description": "entity" + }, + { + "name": "classification", + "value": "classification", + "description": "classification" + }, + { + "name": "relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "struct", + "value": "struct", + "description": "struct" + }, + { + "name": "term_template", + "value": "term_template", + "description": "term template" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_List": { + "$ref": "./examples/Type_List.json" + } + } + }, + "put": { + "operationId": "Type_BulkUpdate", + "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typesDef", + "in": "body", + "description": "A composite object that captures all type definition changes.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkUpdate": { + "$ref": "./examples/Type_BulkUpdate.json" + } + } + }, + "post": { + "operationId": "Type_BulkCreate", + "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typesDef", + "in": "body", + "description": "A composite wrapper object with corresponding lists of the type definition.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + } + } + }, + "delete": { + "operationId": "Type_BulkDelete", + "description": "Delete API for all types in bulk.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "typesDef", + "in": "body", + "description": "A composite object that captures all types to be deleted", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } + } + } + }, + "/atlas/v2/types/typedefs/headers": { + "get": { + "operationId": "Type_ListHeaders", + "description": "List all type definitions returned as a list of minimal information header.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" + }, + { + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "Typedef", + "modelAsString": true, + "values": [ + { + "name": "enum", + "value": "enum", + "description": "enum" + }, + { + "name": "entity", + "value": "entity", + "description": "entity" + }, + { + "name": "classification", + "value": "classification", + "description": "classification" + }, + { + "name": "relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "struct", + "value": "struct", + "description": "struct" + }, + { + "name": "term_template", + "value": "term_template", + "description": "term template" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasTypeDefHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } + } + } + }, + "/entity/moveTo": { + "post": { + "operationId": "Entity_MoveEntitiesToCollection", + "description": "Move existing entities to the target collection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to.", + "required": true, + "type": "string" + }, + { + "name": "moveEntitiesRequest", + "in": "body", + "description": "Entity guids to be moved to target collection.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } + } + } + }, + "/lineage/{guid}/next": { + "get": { + "operationId": "Lineage_GetNextPage", + "description": "Return immediate next page lineage info about entity with pagination", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } + } + } + }, + "/search/autocomplete": { + "post": { + "operationId": "Discovery_AutoComplete", + "description": "Get auto complete options.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autoCompleteRequest", + "in": "body", + "description": "An object specifying the autocomplete criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AutoCompleteResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } + } + } + }, + "/search/query": { + "post": { + "operationId": "Discovery_Query", + "description": "Get data using search.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "searchRequest", + "in": "body", + "description": "An object specifying the search criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SearchResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_TermAssignment": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Type": { + "$ref": "./examples/Discovery_Query_Type.json" + } + } + } + }, + "/search/suggest": { + "post": { + "operationId": "Discovery_Suggest", + "description": "Get search suggestions by query criteria.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "suggestRequest", + "in": "body", + "description": "An object specifying the suggest criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" + } + } + } + }, + "/types/termtemplatedef/guid/{guid}": { + "get": { + "operationId": "Type_GetTermTemplateDefByGuid", + "description": "Get the term template definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" + } + } + } + }, + "/types/termtemplatedef/name/{name}": { + "get": { + "operationId": "Type_GetTermTemplateDefByName", + "description": "Get the term template definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The unique name of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" + } + } + } + } + }, + "definitions": { + "AADToken": { + "type": "object", + "description": "The Azure Active Directory OAuth2 Flow", + "properties": { + "type": { + "type": "string", + "description": "OAuth2 authentication", + "enum": [ + "oauth2" + ] + }, + "flows": { + "type": "array", + "description": "Supported OAuth2 flows", + "items": {} + } + }, + "required": [ + "type", + "flows" + ] + }, + "AndFilter": { + "type": "object", + "description": "And filter for search", + "properties": { + "and": { + "type": "array", + "description": "List of filters", + "items": { + "$ref": "#/definitions/SearchFilter" + }, + "x-ms-client-name": "andFilters", + "x-ms-identifiers": [] + } + }, + "required": [ + "and" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "AndFilter" + }, + "ApiVersions": { + "type": "string", + "description": "Service API versions", + "enum": [ + "2023-09-01" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "2023-09-01", + "value": "2023-09-01", + "description": "2023-09-01 service API version" + } + ] + } + }, + "AssetTypeFilter": { + "type": "object", + "description": "Asset type filter for search", + "properties": { + "assetType": { + "type": "string", + "description": "Asset type name" + } + }, + "required": [ + "assetType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "AssetTypeFilter" + }, + "AtlasAttributeDef": { + "type": "object", + "description": "class that captures details of a struct-attribute.", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + } + } + }, + "AtlasBaseModelObject": { + "type": "object", + "description": "The base model object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + } + } + }, + "AtlasBaseTypeDef": { + "type": "object", + "description": "Base class that captures common-attributes for all types.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + } + } + }, + "AtlasBusinessMetadataDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassification": { + "type": "object", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityGuid": { + "type": "string", + "description": "The GUID of the entity." + }, + "entityStatus": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "removePropagationsOnEntityDelete": { + "type": "boolean", + "description": "Determines if propagations will be removed on entity deletion." + }, + "validityPeriods": { + "type": "array", + "description": "An array of time boundaries indicating validity periods.", + "items": { + "$ref": "#/definitions/TimeBoundary" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassificationDef": { + "type": "object", + "description": "class that captures details of a classification-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + } + } + }, + "AtlasClassifications": { + "type": "object", + "description": "REST serialization friendly list.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." + } + } + }, + "AtlasConstraintDef": { + "type": "object", + "description": "class that captures details of a constraint.", + "properties": { + "params": { + "type": "object", + "description": "The parameters of the constraint definition.", + "additionalProperties": {} + }, + "type": { + "type": "string", + "description": "The type of the constraint." + } + } + }, + "AtlasEntitiesWithExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "entities": { + "type": "array", + "description": "An array of entities.", + "items": { + "$ref": "#/definitions/AtlasEntity" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntity": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "businessAttributes": { + "type": "object", + "description": "Business attributes", + "additionalProperties": {} + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "customAttributes": { + "type": "object", + "description": "Custom Attribute", + "additionalProperties": { + "type": "string" + } + }, + "guid": { + "type": "string", + "description": "The GUID of the entity." + }, + "homeId": { + "type": "string", + "description": "The home ID of the entity." + }, + "collectionId": { + "type": "string", + "description": "The collection ID of the entity.", + "readOnly": true + }, + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" + }, + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers indicating the meanings of the entity.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship." + }, + "proxy": { + "type": "boolean", + "description": "Determines if there's a proxy." + }, + "relationshipAttributes": { + "type": "object", + "description": "The attributes of relationship.", + "additionalProperties": {} + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the entity." + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactBasic" + }, + "type": "array" + } + } + } + }, + "AtlasEntityDef": { + "type": "object", + "description": "class that captures details of a entity-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntityExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + } + } + }, + "AtlasEntityHeader": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "classificationNames": { + "type": "array", + "description": "An array of classification names.", + "items": { + "type": "string" + } + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "guid": { + "type": "string", + "description": "The GUID of the record." + }, + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" + }, + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meaningNames": { + "type": "array", + "description": "An array of meanings.", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + } + } + }, + "AtlasEntityHeaders": { + "type": "object", + "description": "An instance of an entity header map.", + "properties": { + "guidHeaderMap": { + "type": "object", + "description": "The description of the guid header map,", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + } + } + }, + "AtlasEntityWithExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "entity": { + "$ref": "#/definitions/AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database." + } + } + }, + "AtlasEnumDef": { + "type": "object", + "description": "class that captures details of an enum-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEnumElementDef": { + "type": "object", + "description": "class that captures details of an enum-element.", + "properties": { + "description": { + "type": "string", + "description": "The description of the enum element definition." + }, + "ordinal": { + "type": "integer", + "format": "int32", + "description": "The ordinal of the enum element definition." + }, + "value": { + "type": "string", + "description": "The value of the enum element definition." + } + } + }, + "AtlasExtraTypeDef": { + "type": "object", + "description": "Extra properties for a type.", + "properties": { + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n
    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasGlossary": { + "type": "object", + "description": "The glossary object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + } + } + }, + "AtlasGlossaryBaseObject": { + "type": "object", + "description": "The glossary base object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + } + } + }, + "AtlasGlossaryCategory": { + "type": "object", + "description": "The glossary category.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "childrenCategories": { + "type": "array", + "description": "An array of children categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "parentCategory": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader", + "description": "The header of the related category." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasGlossaryExtInfo": { + "type": "object", + "description": "The extended information of glossary.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + }, + "categoryInfo": { + "type": "object", + "description": "The glossary category information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "termInfo": { + "type": "object", + "description": "The glossary term information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + } + }, + "AtlasGlossaryHeader": { + "type": "object", + "description": "The glossary header with basic information.", + "properties": { + "displayText": { + "type": "string", + "description": "The display text." + }, + "glossaryGuid": { + "type": "string", + "description": "The GUID of the glossary." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + } + }, + "AtlasGlossaryTerm": { + "type": "object", + "description": "The glossary term.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "abbreviation": { + "type": "string", + "description": "The abbreviation of the term." + }, + "templateName": { + "type": "array", + "description": "The name of the template.", + "items": {} + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "antonyms": { + "type": "array", + "description": "An array of related term headers as antonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/TermStatus", + "description": "Status of the AtlasGlossaryTerm" + }, + "nickName": { + "type": "string", + "description": "The nick name of the term." + }, + "hierarchyInfo": { + "type": "array", + "description": "The hierarchy information of the term.", + "items": { + "$ref": "#/definitions/PurviewObjectId" + }, + "x-ms-identifiers": [] + }, + "resources": { + "type": "array", + "description": "An array of resource link for term", + "items": { + "$ref": "#/definitions/ResourceLink" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactBasic" + }, + "type": "array" + } + }, + "attributes": { + "type": "object", + "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + }, + "assignedEntities": { + "type": "array", + "description": "An array of related object IDs.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + }, + "categories": { + "type": "array", + "description": "An array of term categorization headers.", + "items": { + "$ref": "#/definitions/AtlasTermCategorizationHeader" + }, + "x-ms-identifiers": [] + }, + "classifies": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "examples": { + "type": "array", + "description": "An array of examples.", + "items": { + "type": "string" + } + }, + "isA": { + "type": "array", + "description": "An array of related term headers indicating the is-a relationship.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "preferredTerms": { + "type": "array", + "description": "An array of preferred related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "preferredToTerms": { + "type": "array", + "description": "An array of related term headers that are preferred to.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "replacedBy": { + "type": "array", + "description": "An array of related term headers that are replaced by.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "replacementTerms": { + "type": "array", + "description": "An array of related term headers for replacement.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "seeAlso": { + "type": "array", + "description": "An array of related term headers for see also.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "synonyms": { + "type": "array", + "description": "An array of related term headers as synonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "translatedTerms": { + "type": "array", + "description": "An array of translated related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "translationTerms": { + "type": "array", + "description": "An array of related term headers for translation.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the term." + }, + "validValues": { + "type": "array", + "description": "An array of related term headers as valid values.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "validValuesFor": { + "type": "array", + "description": "An array of related term headers as valid values for other records.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasLineageInfo": { + "type": "object", + "description": "The lineage information.", + "properties": { + "baseEntityGuid": { + "type": "string", + "description": "The GUID of the base entity." + }, + "guidEntityMap": { + "type": "object", + "description": "The GUID entity map.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "widthCounts": { + "type": "object", + "description": "The entity count in specific direction.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + }, + "lineageDepth": { + "type": "integer", + "format": "int32", + "description": "The depth of lineage." + }, + "lineageWidth": { + "type": "integer", + "format": "int32", + "description": "The width of lineage." + }, + "childrenCount": { + "type": "integer", + "format": "int32", + "description": "The number of children node." + }, + "lineageDirection": { + "$ref": "#/definitions/LineageDirection", + "description": "The enum of lineage direction." + }, + "parentRelations": { + "type": "array", + "description": "An array of parentRelations relations.", + "items": { + "$ref": "#/definitions/ParentRelation" + }, + "x-ms-identifiers": [] + }, + "relations": { + "type": "array", + "description": "An array of lineage relations.", + "items": { + "$ref": "#/definitions/LineageRelation" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasObjectId": { + "type": "object", + "description": "Reference to an object-instance of a type - like entity.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + } + } + }, + "AtlasRelatedCategoryHeader": { + "type": "object", + "description": "The header of the related category.", + "properties": { + "categoryGuid": { + "type": "string", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the category header." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "parentCategoryGuid": { + "type": "string", + "description": "The GUID of the parent category." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + } + }, + "AtlasRelatedObjectId": { + "type": "object", + "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "entityStatus": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "relationshipType": { + "type": "string", + "description": "Relationship type" + }, + "relationshipAttributes": { + "$ref": "#/definitions/AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." + }, + "relationshipGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "relationshipStatus": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." + } + } + }, + "AtlasRelatedTermHeader": { + "type": "object", + "description": "The header of the related term.", + "properties": { + "description": { + "type": "string", + "description": "The description of the related term." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + } + }, + "AtlasRelationship": { + "type": "object", + "description": "Atlas relationship instance.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "end1": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "end2": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "guid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "homeId": { + "type": "string", + "description": "The home ID of the relationship." + }, + "label": { + "type": "string", + "description": "The label of the relationship." + }, + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship" + }, + "status": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the relationship." + } + } + }, + "AtlasRelationshipAttributeDef": { + "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." + } + } + }, + "AtlasRelationshipDef": { + "type": "object", + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

\nAs with\nother typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\n

\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\n

\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed.
\nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required
\nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\n

\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\n

\nEntityDef A might have attributes attr1,attr2,attr3\n
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef\nAtoB might define 2 ends
\n\n

\n   end1:  type A, name attr7\n   end2: \ntype B, name attr8
\n\n

\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n

\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + } + } + }, + "AtlasRelationshipEndDef": { + "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "single-valued attribute or multi-valued attribute." + }, + "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." + } + } + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "description": "The relationship with extended information.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "relationship": { + "$ref": "#/definitions/AtlasRelationship", + "description": "Atlas relationship instance." + } + } + }, + "AtlasStruct": { + "type": "object", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + } + } + }, + "AtlasStructDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasTermAssignmentHeader": { + "type": "object", + "description": "The header for term assignment.", + "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", + "description": "The status of terms assignment." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + } + }, + "AtlasTermAssignmentStatus": { + "type": "string", + "description": "Status for term assignment", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true, + "values": [ + { + "name": "DISCOVERED", + "value": "DISCOVERED", + "description": "The status is discorverred." + }, + { + "name": "PROPOSED", + "value": "PROPOSED", + "description": "The status is proposed." + }, + { + "name": "IMPORTED", + "value": "IMPORTED", + "description": "The status is imported." + }, + { + "name": "VALIDATED", + "value": "VALIDATED", + "description": "The status is validated." + }, + { + "name": "DEPRECATED", + "value": "DEPRECATED", + "description": "The status is deprecated." + }, + { + "name": "OBSOLETE", + "value": "OBSOLETE", + "description": "The status is obsolete." + }, + { + "name": "OTHER", + "value": "OTHER", + "description": "Other status." + } + ] + } + }, + "AtlasTermCategorizationHeader": { + "type": "object", + "description": "The basic information for term categorization.", + "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", + "description": "The status of term relationship." + } + } + }, + "AtlasTermRelationshipStatus": { + "type": "string", + "description": "Status for atlas term relationship", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true, + "values": [ + { + "name": "DRAFT", + "value": "DRAFT", + "description": "draft" + }, + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "DEPRECATED", + "value": "DEPRECATED", + "description": "deprecated" + }, + { + "name": "OBSOLETE", + "value": "OBSOLETE", + "description": "obsolete" + }, + { + "name": "OTHER", + "value": "OTHER", + "description": "other" + } + ] + } + }, + "AtlasTypeDef": { + "type": "object", + "description": "The definitions of type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasTypeDefHeader": { + "type": "object", + "description": "The basic information of the type definition.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + } + }, + "AtlasTypesDef": { + "type": "object", + "description": "The definitions of types.", + "properties": { + "businessMetadataDefs": { + "type": "array", + "description": "businessMetadataDefs", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + }, + "x-ms-identifiers": [] + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + }, + "x-ms-identifiers": [] + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + }, + "x-ms-identifiers": [] + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + }, + "x-ms-identifiers": [] + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + }, + "x-ms-identifiers": [] + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + }, + "x-ms-identifiers": [] + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AttributeFilter": { + "type": "object", + "description": "Attribute filter for search", + "properties": { + "attributeName": { + "type": "string", + "description": "Attribute name" + }, + "operator": { + "type": "string", + "description": "Operator" + }, + "attributeValue": { + "type": "string", + "description": "Attribute value" + } + }, + "required": [ + "attributeName", + "operator", + "attributeValue" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "AttributeFilter" + }, + "AutoCompleteRequest": { + "type": "object", + "description": "The query of autocomplete request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the autocomplete request." + } + } + }, + "AutoCompleteResult": { + "type": "object", + "description": "The result of the autocomplete request.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + }, + "x-ms-identifiers": [] + } + } + }, + "AutoCompleteResultValue": { + "type": "object", + "description": "The value item of the autocomplete suggest.", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + } + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "BulkImportResponse": { + "type": "object", + "description": "example", + "properties": { + "failedImportInfoList": { + "type": "array", + "description": "failed importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + }, + "successImportInfoList": { + "type": "array", + "description": "successful importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + } + } + }, + "BusinessAttributeUpdateBehavior": { + "type": "string", + "description": "Enum for business attribute update behavior", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + "Cardinality": { + "type": "string", + "description": "Cardinality", + "enum": [ + "SINGLE", + "LIST", + "SET" + ], + "x-ms-enum": { + "name": "Cardinality", + "modelAsString": true, + "values": [ + { + "name": "SINGLE", + "value": "SINGLE", + "description": "single" + }, + { + "name": "LIST", + "value": "LIST", + "description": "list" + }, + { + "name": "SET", + "value": "SET", + "description": "set" + } + ] + } + }, + "ClassificationAssociateRequest": { + "type": "object", + "description": "The request for classification association.", + "properties": { + "classification": { + "$ref": "#/definitions/AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." + }, + "entityGuids": { + "type": "array", + "description": "The GUID of the entity.", + "items": { + "type": "string" + } + } + } + }, + "ClassificationFilter": { + "type": "object", + "description": "Classification type filter for search", + "properties": { + "classificationName": { + "type": "string", + "description": "Classification name" + }, + "includeSubClassifications": { + "type": "boolean", + "description": "Whether to include sub classifications" + } + }, + "required": [ + "classificationName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ClassificationFilter" + }, + "CollectionIdFilter": { + "type": "object", + "description": "Collection id filter for search", + "properties": { + "collectionId": { + "type": "string", + "description": "Collection id" + } + }, + "required": [ + "collectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "CollectionIdFilter" + }, + "ContactBasic": { + "type": "object", + "description": "ContactBasic", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, + "ContactFilter": { + "type": "object", + "description": "Contact filter for search", + "properties": { + "contactType": { + "type": "string", + "description": "Contact type" + }, + "contactId": { + "type": "string", + "description": "Contact Id" + } + }, + "required": [ + "contactType", + "contactId" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ContactFilter" + }, + "ContactSearchResultValue": { + "type": "object", + "description": "The contact in the search and suggest result.", + "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\nExpert or Steward for a glossary term." + } + } + }, + "CreateTimeFilter": { + "type": "object", + "description": "Create time filter for search", + "properties": { + "createTime": { + "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n} \nto represent the time filter" + } + }, + "required": [ + "createTime" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "CreateTimeFilter" + }, + "DateFormat": { + "type": "object", + "description": "The date format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "An array of available locales.", + "items": { + "type": "string" + } + }, + "calendar": { + "type": "number", + "format": "float", + "description": "Calendar" + }, + "dateInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "dateTimeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "instance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "lenient": { + "type": "boolean", + "description": "Determines the leniency of the date format." + }, + "numberFormat": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "timeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "timeZone": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + } + } + }, + "Direction": { + "type": "string", + "description": "Direction", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + }, + "DomainIdFilter": { + "type": "object", + "description": "Domain id filter for search", + "properties": { + "domainId": { + "type": "string", + "description": "Domain id" + } + }, + "required": [ + "domainId" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "DomainIdFilter" + }, + "EntityMutationResponse": { + "type": "object", + "description": "The mutation response of entity.", + "properties": { + "guidAssignments": { + "type": "object", + "description": "A map of GUID assignments with entities.", + "additionalProperties": { + "type": "string" + } + }, + "mutatedEntities": { + "type": "object", + "description": "The entity headers of mutated entities.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "partialUpdatedEntities": { + "type": "array", + "description": "An array of entity headers that partially updated.", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "An error response from the service", + "properties": { + "requestId": { + "type": "string", + "description": "The request ID." + }, + "errorCode": { + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "ExistsFilter": { + "type": "object", + "description": "Exists filter for search", + "properties": { + "exists": { + "type": "string", + "description": "Field", + "x-ms-client-name": "field" + } + }, + "required": [ + "exists" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ExistsFilter" + }, + "FileExtensionFilter": { + "type": "object", + "description": "File extension filter for search", + "properties": { + "fileExtension": { + "type": "string", + "description": "File extension" + } + }, + "required": [ + "fileExtension" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "FileExtensionFilter" + }, + "GlossaryFilter": { + "type": "object", + "description": "Glossary filter for search", + "properties": { + "glossaryType": { + "type": "string", + "description": "Glossary type. Either AtlasGlossary or AtlasGlossaryType" + } + }, + "required": [ + "glossaryType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "GlossaryFilter" + }, + "IdFilter": { + "type": "object", + "description": "Id filter for search", + "properties": { + "id": { + "type": "string", + "description": "Id value" + } + }, + "required": [ + "id" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "IdFilter" + }, + "ImportInfo": { + "type": "object", + "description": "ImportInfo", + "properties": { + "childObjectName": { + "type": "string", + "description": "childObjectName" + }, + "importStatus": { + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "type": "string", + "description": "parentObjectName" + }, + "remarks": { + "type": "string", + "description": "remarks" + } + } + }, + "ImportStatus": { + "type": "string", + "description": "Status for import", + "enum": [ + "SUCCESS", + "FAILED" + ], + "x-ms-enum": { + "name": "ImportStatus", + "modelAsString": true, + "values": [ + { + "name": "SUCCESS", + "value": "SUCCESS", + "description": "Success" + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Failed" + } + ] + } + }, + "LabelFilter": { + "type": "object", + "description": "Label filter for search", + "properties": { + "label": { + "type": "string", + "description": "Label" + }, + "includeSubLabels": { + "type": "boolean", + "description": "Whether to include sub labels" + } + }, + "required": [ + "label" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "LabelFilter" + }, + "LineageDirection": { + "type": "string", + "description": "Lineage direction", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + } + ] + } + }, + "LineageRelation": { + "type": "object", + "description": "The lineage relation with GUID of the from and to entity.", + "properties": { + "fromEntityId": { + "type": "string", + "description": "The GUID of from-entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "toEntityId": { + "type": "string", + "description": "The GUID of to-entity." + } + } + }, + "MoveEntitiesRequest": { + "type": "object", + "description": "MoveEntitiesRequest", + "properties": { + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } + } + } + }, + "NameInPath": { + "type": "object", + "description": "The path for name.", + "properties": { + "name": { + "type": "string", + "description": "name", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "NotFilter": { + "type": "object", + "description": "Not filter for search", + "properties": { + "not": { + "$ref": "#/definitions/SearchFilter", + "description": "Not filter", + "x-ms-client-name": "notFilters" + } + }, + "required": [ + "not" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "NotFilter" + }, + "NumberFormat": { + "type": "object", + "description": "The number format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "The number format.", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string", + "description": "The currency." + }, + "currencyInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "groupingUsed": { + "type": "boolean", + "description": "Determines if grouping is used." + }, + "instance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "integerInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "maximumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of fraction digits." + }, + "maximumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of integer digits." + }, + "minimumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of fraction digits." + }, + "minimumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of integer digits." + }, + "numberInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "parseIntegerOnly": { + "type": "boolean", + "description": "Determines if only integer is parsed." + }, + "percentInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "roundingMode": { + "$ref": "#/definitions/RoundingMode", + "description": "The enum of rounding mode." + } + } + }, + "ObjectTypeFilter": { + "type": "object", + "description": "Label filter for search", + "properties": { + "objectType": { + "type": "string", + "description": "Object type" + } + }, + "required": [ + "objectType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ObjectTypeFilter" + }, + "OrFilter": { + "type": "object", + "description": "Or filter for search", + "properties": { + "or": { + "type": "array", + "description": "List of filters", + "items": { + "$ref": "#/definitions/SearchFilter" + }, + "x-ms-client-name": "orFilters", + "x-ms-identifiers": [] + } + }, + "required": [ + "or" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "OrFilter" + }, + "PList": { + "type": "object", + "description": "Paginated-list, for returning search results.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." + } + } + }, + "ParentRelation": { + "type": "object", + "description": "The lineage parents relation with GUID of the parent entity and to child entity.", + "properties": { + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + } + }, + "PathFilter": { + "type": "object", + "description": "Path filter for search", + "properties": { + "path": { + "type": "string", + "description": "Path" + }, + "isParent": { + "type": "boolean", + "description": "Whether the path is parent path" + } + }, + "required": [ + "path" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "PathFilter" + }, + "PurviewObjectId": { + "type": "object", + "description": "PurviewObjectId", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "name": { + "type": "string", + "description": "Name" + }, + "displayText": { + "type": "string", + "description": "Display text" + }, + "itemPath": { + "type": "string", + "description": "Item path" + }, + "resourceId": { + "type": "string", + "description": "Resouce Id" + }, + "properties": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": {} + } + } + }, + "RelationshipCategory": { + "type": "string", + "description": "Relationship Category", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true, + "values": [ + { + "name": "ASSOCIATION", + "value": "ASSOCIATION", + "description": "association" + }, + { + "name": "AGGREGATION", + "value": "AGGREGATION", + "description": "aggregation" + }, + { + "name": "COMPOSITION", + "value": "COMPOSITION", + "description": "composition" + } + ] + } + }, + "ResourceLink": { + "type": "object", + "description": "ResourceLink", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } + } + }, + "RoundingMode": { + "type": "string", + "description": "Rounding Mode", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true, + "values": [ + { + "name": "UP", + "value": "UP", + "description": "up" + }, + { + "name": "DOWN", + "value": "DOWN", + "description": "down" + }, + { + "name": "CEILING", + "value": "CEILING", + "description": "ceiling" + }, + { + "name": "FLOOR", + "value": "FLOOR", + "description": "floor" + }, + { + "name": "HALF_UP", + "value": "HALF_UP", + "description": "half up" + }, + { + "name": "HALF_DOWN", + "value": "HALF_DOWN", + "description": "half down" + }, + { + "name": "HALF_EVEN", + "value": "HALF_EVEN", + "description": "half even" + }, + { + "name": "UNNECESSARY", + "value": "UNNECESSARY", + "description": "unnecessary" + } + ] + } + }, + "ScanInfoFilter": { + "type": "object", + "description": "Scan info filter for search", + "properties": { + "dataSourceName": { + "type": "string", + "description": "Data source name" + }, + "scanName": { + "type": "string", + "description": "Scan name" + } + }, + "required": [ + "scanName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ScanInfoFilter" + }, + "SearchFacetItem": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "description": "Any object" + } + } + }, + "SearchFacetItemValue": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + } + }, + "SearchFacetResultValue": { + "type": "object", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "properties": { + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "assetType": { + "type": "array", + "description": "Asset type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "classification": { + "type": "array", + "description": "Classiciation", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "term": { + "type": "array", + "description": "Term", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactId": { + "type": "array", + "description": "Contact id", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactType": { + "type": "array", + "description": "Contact type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "label": { + "type": "array", + "description": "Label", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "glossaryType": { + "type": "array", + "description": "Glossary type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termStatus": { + "type": "array", + "description": "Term status", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termTemplate": { + "type": "array", + "description": "Term template", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + } + } + }, + "SearchFilter": { + "type": "object", + "description": "Base model for search filter", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for SearchFilter." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "properties": { + "id": { + "type": "array", + "description": "Id", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "description": "Qualified name", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Descirption", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "type": "string" + } + } + } + }, + "SearchRequest": { + "type": "object", + "description": "The search query of advanced search request.", + "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\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchRequestTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, + "SearchRequestTaxonomySetting": { + "type": "object", + "description": "Taxonomy setting for search request", + "properties": { + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, + "SearchResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "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", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + } + }, + "SearchResultValue": { + "type": "object", + "description": "The value item of the search result.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "x-ms-client-name": "searchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" + }, + "x-ms-identifiers": [] + }, + "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\nAtlasGlossaryCategory." + }, + "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." + } + } + }, + "SortType": { + "type": "string", + "description": "Type for sorting", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "No sorting order" + }, + { + "name": "ASC", + "value": "ASC", + "description": "Use ascending order for sorting" + }, + { + "name": "DESC", + "value": "DESC", + "description": "Use descending order for sorting" + } + ] + } + }, + "Status": { + "type": "string", + "description": "Status - can be active or deleted", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "DELETED", + "value": "DELETED", + "description": "The status is deleted." + } + ] + } + }, + "StatusAtlasRelationship": { + "type": "string", + "description": "Status for atlas relationship", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "StatusAtlasRelationship", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "DELETED", + "value": "DELETED", + "description": "deleted" + } + ] + } + }, + "SuggestRequest": { + "type": "object", + "description": "The query of suggest request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the search." + } + } + }, + "SuggestResult": { + "type": "object", + "description": "The result item of the search suggest.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + } + }, + "SuggestResultValue": { + "type": "object", + "description": "The value item of the search suggest.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", + "x-ms-client-name": "searchText" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" + }, + "x-ms-identifiers": [] + }, + "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\nAtlasGlossaryCategory." + }, + "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." + } + } + }, + "TermSearchResultValue": { + "type": "object", + "description": "The context.", + "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." + } + } + }, + "TermStatus": { + "type": "string", + "description": "Status for term", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "Draft", + "description": "draft" + }, + { + "name": "Approved", + "value": "Approved", + "description": "approved" + }, + { + "name": "Alert", + "value": "Alert", + "description": "alert" + }, + { + "name": "Expired", + "value": "Expired", + "description": "expired" + } + ] + } + }, + "TermTemplateDef": { + "type": "object", + "description": "Term template definition for glossary term.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "TimeBoundary": { + "type": "object", + "description": "Captures time-boundary details", + "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." + } + } + }, + "TimeZone": { + "type": "object", + "description": "The timezone information.", + "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", + "description": "The timezone information." + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + } + }, + "TypeCategory": { + "type": "string", + "description": "Type Category", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "PRIMITIVE", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "OBJECT_ID_TYPE", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "ENUM", + "value": "ENUM", + "description": "enum" + }, + { + "name": "STRUCT", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "CLASSIFICATION", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "ENTITY", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "ARRAY", + "value": "ARRAY", + "description": "array" + }, + { + "name": "MAP", + "value": "MAP", + "description": "map" + }, + { + "name": "RELATIONSHIP", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TERM_TEMPLATE", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } + }, + "TypeFilter": { + "type": "object", + "description": "Type filter for search", + "properties": { + "typeName": { + "type": "string", + "description": "Type name" + }, + "includeSubTypes": { + "type": "boolean", + "description": "Whether to include sub types" + } + }, + "required": [ + "typeName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "TypeFilter" + }, + "Typedef": { + "type": "string", + "description": "Type", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "Typedef", + "modelAsString": true, + "values": [ + { + "name": "enum", + "value": "enum", + "description": "enum" + }, + { + "name": "entity", + "value": "entity", + "description": "entity" + }, + { + "name": "classification", + "value": "classification", + "description": "classification" + }, + { + "name": "relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "struct", + "value": "struct", + "description": "struct" + }, + { + "name": "term_template", + "value": "term_template", + "description": "term template" + } + ] + } + }, + "UpdateTimeFilter": { + "type": "object", + "description": "Update time filter for search", + "properties": { + "updateTime": { + "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n} \nto represent the time filter" + } + }, + "required": [ + "updateTime" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "UpdateTimeFilter" + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} From 6db5a14d0b04b51b49d1b232d4f3efd3a9a39e53 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 17:22:15 +0800 Subject: [PATCH 020/132] update typo --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 962412fe27a3..ca2c86a8ceda 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -26,7 +26,7 @@ enum Status { @doc("Status for term assignment") enum AtlasTermAssignmentStatus { - @doc("The status is discorverred.") + @doc("The status is discovered.") DISCOVERED, @doc("The status is proposed.") PROPOSED, @@ -754,7 +754,7 @@ model PurviewObjectId { @doc("Item path") itemPath?: string; - @doc("Resouce Id") + @doc("Resource Id") resourceId?: string; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @@ -941,7 +941,7 @@ model SearchFacetResultValue { @doc("Asset type") assetType?: SearchFacetItemValue[]; - @doc("Classiciation") + @doc("Classification") classification?: SearchFacetItemValue[]; @doc("Term") @@ -1076,7 +1076,7 @@ model SearchHighlights { @doc("Name") name?: string[]; - @doc("Descirption") + @doc("Description") description?: string[]; @doc("Entity type") From 4121d4b6366ba9c76b9b1308d553e710fac4464f Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 17:22:26 +0800 Subject: [PATCH 021/132] Update openapi.json --- .../stable/2023-09-01/openapi.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index e1bf2f50f25a..da0c4a53cd4b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -6829,7 +6829,7 @@ { "name": "DISCOVERED", "value": "DISCOVERED", - "description": "The status is discorverred." + "description": "The status is discovered." }, { "name": "PROPOSED", @@ -8100,7 +8100,7 @@ }, "resourceId": { "type": "string", - "description": "Resouce Id" + "description": "Resource Id" }, "properties": { "type": "object", @@ -8291,7 +8291,7 @@ }, "classification": { "type": "array", - "description": "Classiciation", + "description": "Classification", "items": { "$ref": "#/definitions/SearchFacetItemValue" }, @@ -8396,7 +8396,7 @@ }, "description": { "type": "array", - "description": "Descirption", + "description": "Description", "items": { "type": "string" } From 95e6b6d187f822a4b0f566f9d65cf88b1e892a52 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 23 Nov 2023 23:49:07 +0800 Subject: [PATCH 022/132] update --- .../routes.tsp | 37 +++++++++++++------ .../stable/2023-09-01/openapi.json | 11 +++--- 2 files changed, 32 insertions(+), 16 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 2fb0b1e06fd1..bc8e4e859e12 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -19,13 +19,6 @@ model ApiVersionParameter { apiVersion: string; } -model OkResponse { - @statusCode - status: 200; - @body - data: T; -} - @doc("The path for name.") @resource("name") model NameInPath { @@ -35,6 +28,13 @@ model NameInPath { name: string; } +model OkResponse { + @statusCode + status: 200; + @body + data: T; +} + @doc("Operation for DataMap service") op DataMapBaseOperation< TParams extends TypeSpec.Reflection.Model, @@ -48,8 +48,20 @@ op DataMapBaseOperation< >, ...TParams, ): TResponse | TErrorResponse; - -alias DataMapResourceOperations = Azure.Core.ResourceOperations; + + +op DataMapImportOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse extends TypeSpec.Reflection.Model, + Traits extends TypeSpec.Reflection.Model = {}, + TraitContexts extends TraitContext = TraitContext.Undefined +> is DataMapBaseOperation< +TParams & TraitProperties, +TResponse & TraitProperties, +Traits +>; + +//alias DataMapResourceOperations = Azure.Core.ResourceOperations; interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -684,15 +696,18 @@ default is false. @body template: bytes; }>; + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Upload the file for creating Business Metadata in BULK") @route("/atlas/v2/entity/businessmetadata/import") @post - importBusinessMetadata is DataMapBaseOperation< + importBusinessMetadata is DataMapImportOperation< { @doc("InputStream of file") - @body uploadedInputStream: bytes; + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; }, BulkImportResponse >; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index da0c4a53cd4b..a238efc93418 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -431,19 +431,20 @@ "post": { "operationId": "Entity_ImportBusinessMetadata", "description": "Upload the file for creating Business Metadata in BULK", + "consumes": [ + "multipart/form-data" + ], "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "name": "uploadedInputStream", - "in": "body", + "in": "formData", "description": "InputStream of file", "required": true, - "schema": { - "type": "string", - "format": "byte" - } + "type": "string", + "format": "byte" } ], "responses": { From fdd86c87cf09070ee83e15b33306a6b25034c3ae Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 09:59:33 +0800 Subject: [PATCH 023/132] update examples --- ...tity_AddClassificationToEntityByGuids.json | 2 +- .../2023-09-01/Entity_AddCustomAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../examples/2023-09-01/Entity_Create.json | 2 +- .../Entity_RemoveBusinessAttribute.json | 2 +- .../examples/2023-09-01/Entity_Update.json | 2 +- .../Glossary_CreateTermWithTemplate.json | 2 +- .../Glossary_GetTermWithoutAssets.json | 2 +- ...sary_RemoveTermAssignmentFromEntities.json | 2 +- .../Type_BulkCreateBusinessMetadataDefs.json | 2 +- .../2023-09-01/Type_ListEnumDefs.json | 2 +- .../2023-09-01/Type_ListTermTemplateDefs.json | 2 +- ...tity_AddClassificationToEntityByGuids.json | 4 +- .../examples/Entity_AddCustomAttribute.json | 4 +- ...Entity_Label.json => Entity_AddLabel.json} | 4 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 4 +- .../2023-09-01/examples/Entity_Create.json | 4 +- .../Entity_RemoveBusinessAttribute.json | 4 +- .../examples/Entity_RemoveLabels.json | 15 ++++++ .../2023-09-01/examples/Entity_SetLabels.json | 15 ++++++ .../2023-09-01/examples/Entity_Update.json | 4 +- .../Glossary_CreateTermWithTemplate.json | 4 +- .../Glossary_GetTermWithoutAssets.json | 4 +- ...sary_RemoveTermAssignmentFromEntities.json | 4 +- .../Type_BulkCreateBusinessMetadataDefs.json | 4 +- .../examples/Type_ListEnumDefs.json | 4 +- .../examples/Type_ListTermTemplateDefs.json | 4 +- .../stable/2023-09-01/openapi.json | 46 +++++++++++++++++++ 28 files changed, 127 insertions(+), 25 deletions(-) rename specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/{Entity_Label.json => Entity_AddLabel.json} (73%) create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json index d45c65f6681f..6a2b6f529636 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json @@ -17,5 +17,5 @@ "204": {} }, "title": "Entity_AddClassificationToEntityByGuids", - "operationId": "Entity_AddClassificationToEntityByGuids" + "operationId": "Entity_AddClassification" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json index 20c7d135e2c9..38d275e09fc6 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json @@ -53,5 +53,5 @@ } }, "title": "Entity_AddCustomAttribute", - "operationId": "Entity_AddCustomAttribute" + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json index 972e4811601d..e4ec69c6db39 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -11,5 +11,5 @@ "204": {} }, "title": "Entity_AddOrUpdate_BusinessAttribute", - "operationId": "Entity_AddOrUpdate_BusinessAttribute" + "operationId": "Entity_AddOrUpdateBusinessMetadata" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json index 29c4fdc0657d..a8c29d541e8f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json @@ -58,5 +58,5 @@ } }, "title": "Entity_Create", - "operationId": "Entity_Create" + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json index befe2788c6a8..b192524000a1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -11,5 +11,5 @@ "204": {} }, "title": "Entity_RemoveBusinessAttribute", - "operationId": "Entity_RemoveBusinessAttribute" + "operationId": "Entity_RemoveBusinessMetadataAttributes" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json index fc3eb1207d16..8a73eb79a419 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json @@ -57,5 +57,5 @@ } }, "title": "Entity_Update", - "operationId": "Entity_Update" + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json index a9367908ade4..635adc6d11ad 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json @@ -49,5 +49,5 @@ } }, "title": "Glossary_CreateTermWithTemplate", - "operationId": "Glossary_CreateTermWithTemplate" + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json index bdf443c37c65..e6bcb016215a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json @@ -62,5 +62,5 @@ } }, "title": "Glossary_GetTermWithoutAssets", - "operationId": "Glossary_GetTermWithoutAssets" + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json index 29c16783845a..46c653fe9fb3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json @@ -13,5 +13,5 @@ "204": {} }, "title": "Glossary_RemoveTermAssignmentFromEntities", - "operationId": "Glossary_RemoveTermAssignmentFromEntities" + "operationId": "Glossary_DeleteTermAssignmentFromEntities" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json index 187d6e01ac31..9ae93573b207 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json @@ -73,5 +73,5 @@ } }, "title": "Type_BulkCreateBusinessMetadataDefs", - "operationId": "Type_BulkCreateBusinessMetadataDefs" + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json index 124002c241bf..c4118ef9957a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json @@ -88,5 +88,5 @@ } }, "title": "Type_ListEnumDefs", - "operationId": "Type_ListEnumDefs" + "operationId": "Type_List" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json index 1ca2c36f9cad..c9a13ccd7758 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json @@ -89,5 +89,5 @@ } }, "title": "Type_ListTermTemplateDefs", - "operationId": "Type_ListTermTemplateDefs" + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index c955f4586918..6a2b6f529636 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationToEntityByGuids", + "operationId": "Entity_AddClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 5fafde7ea05e..38d275e09fc6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -51,5 +51,7 @@ } } } - } + }, + "title": "Entity_AddCustomAttribute", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json similarity index 73% rename from specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json rename to specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json index 62668d54234d..6c8c8ccf153d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Label.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddLabel", + "operationId": "Entity_AddLabel" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 6335668124ae..e4ec69c6db39 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddOrUpdate_BusinessAttribute", + "operationId": "Entity_AddOrUpdateBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index b4946962b191..a8c29d541e8f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -56,5 +56,7 @@ } } } - } + }, + "title": "Entity_Create", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 6335668124ae..b192524000a1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessAttribute", + "operationId": "Entity_RemoveBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json new file mode 100644 index 000000000000..743f676c786b --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveLabels", + "operationId": "Entity_RemoveLabels" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json new file mode 100644 index 000000000000..e2b2c2eb6344 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_SetLabels", + "operationId": "Entity_SetLabels" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 56799529f337..8a73eb79a419 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -55,5 +55,7 @@ } } } - } + }, + "title": "Entity_Update", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index c9b7795a1b04..635adc6d11ad 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -47,5 +47,7 @@ } } } - } + }, + "title": "Glossary_CreateTermWithTemplate", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index c0dcc7655580..e6bcb016215a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Glossary_GetTermWithoutAssets", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index ca978c5df1fc..46c653fe9fb3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -11,5 +11,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_RemoveTermAssignmentFromEntities", + "operationId": "Glossary_DeleteTermAssignmentFromEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 66e7d50e8570..9ae93573b207 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -71,5 +71,7 @@ ] } } - } + }, + "title": "Type_BulkCreateBusinessMetadataDefs", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index 0c3b2d78f851..c4118ef9957a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -86,5 +86,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_ListEnumDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index 26902f2461c6..c9a13ccd7758 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -87,5 +87,7 @@ ] } } - } + }, + "title": "Type_ListTermTemplateDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index a238efc93418..0b178e133e49 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -122,6 +122,17 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + }, + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + } } } }, @@ -324,6 +335,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } } } }, @@ -686,6 +702,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + } } }, "delete": { @@ -818,6 +839,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" + } } } }, @@ -2637,6 +2663,9 @@ "x-ms-examples": { "Glossary_CreateTerm": { "$ref": "./examples/Glossary_CreateTerm.json" + }, + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" } } } @@ -2674,6 +2703,9 @@ "x-ms-examples": { "Glossary_GetTerm": { "$ref": "./examples/Glossary_GetTerm.json" + }, + "Glossary_GetTermWithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" } } }, @@ -3012,6 +3044,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } } } }, @@ -4032,6 +4069,12 @@ "x-ms-examples": { "Type_List": { "$ref": "./examples/Type_List.json" + }, + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" } } }, @@ -4106,6 +4149,9 @@ "x-ms-examples": { "Type_BulkCreate": { "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" } } }, From 5d0106227cd42b38227d27309d63032d132eda71 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 10:46:26 +0800 Subject: [PATCH 024/132] update examples --- .../2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../examples/2023-09-01/Entity_RemoveBusinessAttribute.json | 2 +- .../examples/2023-09-01/Entity_RemoveBusinessMetadata.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json index e4ec69c6db39..a9c7501cbcd1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "body": { + "businessMetadata": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json index b192524000a1..78ff0dd0dde3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "body": { + "businessMetadata": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json index 9e2de7361e36..d02050e64adf 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": { + "businessMetadata": { "myBizMetadata1": { "bizAttr1": "myBizMetaData1.bizAttr1" } From b5528e627db5ac00974d50eaaf07d4c3c18ab802 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 11:07:40 +0800 Subject: [PATCH 025/132] update --- .../routes.tsp | 205 ++++++++++-------- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../Entity_RemoveBusinessAttribute.json | 2 +- .../Entity_RemoveBusinessMetadata.json | 2 +- .../stable/2023-09-01/openapi.json | 28 ++- 5 files changed, 136 insertions(+), 103 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index bc8e4e859e12..5639575b257f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -13,6 +13,14 @@ namespace PurviewDataMap; @doc("The ApiVersion query parameter.") model ApiVersionParameter { + @query("api-version") + @minLength(1) + @doc("The API version to use for this operation.") + apiVersion?: string; +} + +@doc("The ApiVersion query parameter for DataMap service.") +model DataMapApiVersionParameter { @query("api-version") @minLength(1) @doc("The API version to use for this operation.") @@ -35,6 +43,21 @@ model OkResponse { data: T; } +@doc("Operation for Atlas service") +op AtlasBaseOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse, + Traits extends TypeSpec.Reflection.Model = {}, + TErrorResponse = ErrorResponse +>( + ...TraitProperties< + Traits & VersionParameterTrait, + TraitLocation.ApiVersionParameter + >, + ...TParams, +): TResponse | TErrorResponse; + + @doc("Operation for DataMap service") op DataMapBaseOperation< TParams extends TypeSpec.Reflection.Model, @@ -43,20 +66,20 @@ op DataMapBaseOperation< TErrorResponse = ErrorResponse >( ...TraitProperties< - Traits & VersionParameterTrait, + Traits & VersionParameterTrait, TraitLocation.ApiVersionParameter >, ...TParams, ): TResponse | TErrorResponse; -op DataMapImportOperation< +op AtlasImportOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, Traits extends TypeSpec.Reflection.Model = {}, TraitContexts extends TraitContext = TraitContext.Undefined -> is DataMapBaseOperation< -TParams & TraitProperties, +> is AtlasBaseOperation< +TParams, TResponse & TraitProperties, Traits >; @@ -76,7 +99,7 @@ For each contact type, the maximum number of contacts is 20. """) @route("/atlas/v2/entity") @post - createOrUpdate is DataMapBaseOperation< + createOrUpdate is AtlasBaseOperation< { @doc(""" Used to define the update behavior for business attributes when updating @@ -104,7 +127,7 @@ need to move an entity to another collection. @doc("List entities in bulk identified by its GUIDs.") @route("/atlas/v2/entity/bulk") @get - listByGuids is DataMapBaseOperation< + listByGuids is AtlasBaseOperation< { @doc("An array of GUIDs of entities to list.") @query({format: "multi"}) @@ -134,7 +157,7 @@ is 20. """) @route("/atlas/v2/entity/bulk") @post - bulkCreateOrUpdate is DataMapBaseOperation< + bulkCreateOrUpdate is AtlasBaseOperation< { @doc(""" The collection where entities will be moved to. Only specify a value if you @@ -166,7 +189,7 @@ attributes. """) @route("/atlas/v2/entity/bulk") @delete - bulkDelete is DataMapBaseOperation< + bulkDelete is AtlasBaseOperation< { @doc("An array of GUIDs of entities to delete.") @query({format: "multi"}) @@ -179,7 +202,7 @@ attributes. @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is DataMapBaseOperation< + addClassification is AtlasBaseOperation< { @doc("The request to associate a classification to multiple entities.") @body @@ -192,7 +215,7 @@ attributes. @doc("Get complete definition of an entity given its GUID.") @route("/atlas/v2/entity/guid/{guid}") @get - get is DataMapBaseOperation< + get is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -221,7 +244,7 @@ possible. """) @route("/atlas/v2/entity/guid/{guid}") @put - partialUpdateAttributeByGuid is DataMapBaseOperation< + partialUpdateAttributeByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -243,7 +266,7 @@ possible. @doc("Delete an entity identified by its GUID.") @route("/atlas/v2/entity/guid/{guid}") @delete - delete is DataMapBaseOperation< + delete is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -256,7 +279,7 @@ possible. @doc("Get classification for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @get - getClassification is DataMapBaseOperation< + getClassification is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -273,7 +296,7 @@ possible. @doc("Delete a given classification from an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @delete - removeClassification is DataMapBaseOperation< + removeClassification is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -290,7 +313,7 @@ possible. @doc("List classifications for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @get - getClassifications is DataMapBaseOperation< + getClassifications is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -304,7 +327,7 @@ possible. @doc("Add classifications to an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @post - addClassifications is DataMapBaseOperation< + addClassifications is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -322,7 +345,7 @@ possible. @doc("Update classifications to an existing entity represented by a guid.") @route("/atlas/v2/entity/guid/{guid}/classifications") @put - updateClassifications is DataMapBaseOperation< + updateClassifications is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -354,7 +377,7 @@ GET """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @get - getByUniqueAttributes is DataMapBaseOperation< + getByUniqueAttributes is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -399,7 +422,7 @@ PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @put - partialUpdateByUniqueAttributes is DataMapBaseOperation< + partialUpdateByUniqueAttributes is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -436,7 +459,7 @@ DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @delete - deleteByUniqueAttribute is DataMapBaseOperation< + deleteByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -459,7 +482,7 @@ attributes. """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") @delete - removeClassificationByUniqueAttribute is DataMapBaseOperation< + removeClassificationByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -484,7 +507,7 @@ be changed to other unique attributes) @doc("Add classification to the entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @post - addClassificationsByUniqueAttribute is DataMapBaseOperation< + addClassificationsByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -509,7 +532,7 @@ be changed to other unique attributes) @doc("Update classification on an entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @put - updateClassificationsByUniqueAttribute is DataMapBaseOperation< + updateClassificationsByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -533,7 +556,7 @@ be changed to other unique attributes) @doc("Set classifications on entities in bulk.") @route("/atlas/v2/entity/bulk/setClassifications") @post - bulkSetClassifications is DataMapBaseOperation< + bulkSetClassifications is AtlasBaseOperation< { @doc("Atlas entity headers.") @body @@ -566,7 +589,7 @@ at least one unique attribute must be provided. """) @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") @get - listByUniqueAttributes is DataMapBaseOperation< + listByUniqueAttributes is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -595,7 +618,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Get entity header given its GUID.") @route("/atlas/v2/entity/guid/{guid}/header") @get - getHeader is DataMapBaseOperation< + getHeader is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -608,7 +631,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Remove business metadata from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @delete - removeBusinessMetadata is DataMapBaseOperation< + removeBusinessMetadata is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -625,7 +648,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Add business metadata to an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @post - addOrUpdateBusinessMetadata is DataMapBaseOperation< + addOrUpdateBusinessMetadata is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -649,7 +672,7 @@ default is false. @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @delete - removeBusinessMetadataAttributes is DataMapBaseOperation< + removeBusinessMetadataAttributes is AtlasBaseOperation< { @doc("BusinessMetadata name") @path @@ -671,7 +694,7 @@ default is false. @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @post - addOrUpdateBusinessMetadataAttributes is DataMapBaseOperation< + addOrUpdateBusinessMetadataAttributes is AtlasBaseOperation< { @doc("BusinessMetadata name") @path @@ -701,7 +724,7 @@ default is false. @doc("Upload the file for creating Business Metadata in BULK") @route("/atlas/v2/entity/businessmetadata/import") @post - importBusinessMetadata is DataMapImportOperation< + importBusinessMetadata is AtlasImportOperation< { @doc("InputStream of file") uploadedInputStream: bytes; @@ -717,7 +740,7 @@ default is false. @doc("Delete given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @delete - removeLabels is DataMapBaseOperation< + removeLabels is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -735,7 +758,7 @@ default is false. @doc("Set labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @post - setLabels is DataMapBaseOperation< + setLabels is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -753,7 +776,7 @@ default is false. @doc("Add given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @put - addLabel is DataMapBaseOperation< + addLabel is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -785,7 +808,7 @@ this: DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @delete - removeLabelsByUniqueAttribute is DataMapBaseOperation< + removeLabelsByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -826,7 +849,7 @@ request would look something like this: POST """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @post - setLabelsByUniqueAttribute is DataMapBaseOperation< + setLabelsByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -867,7 +890,7 @@ request would look something like this: PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @put - addLabelsByUniqueAttribute is DataMapBaseOperation< + addLabelsByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -919,7 +942,7 @@ and """) @route("/atlas/v2/glossary") @get - list is DataMapBaseOperation< + list is AtlasBaseOperation< { @doc("The page size - by default there is no paging.") @query @@ -945,7 +968,7 @@ and @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is DataMapBaseOperation< + create is AtlasBaseOperation< { @doc(""" Glossary definition, terms & categories can be anchored to a glossary. @@ -963,7 +986,7 @@ the anchor attribute when creating the Term/Category. @doc("Create glossary category in bulk.") @route("/atlas/v2/glossary/categories") @post - createCategories is DataMapBaseOperation< + createCategories is AtlasBaseOperation< { @doc("An array of glossary category definitions to be created.") @body @@ -976,7 +999,7 @@ the anchor attribute when creating the Term/Category. @doc("Create a glossary category.") @route("/atlas/v2/glossary/category") @post - createCategory is DataMapBaseOperation< + createCategory is AtlasBaseOperation< { @doc(""" The glossary category definition. A category must be anchored to a Glossary @@ -994,7 +1017,7 @@ can also be defined during creation. @doc("Get specific glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @get - getCategory is DataMapBaseOperation< + getCategory is AtlasBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1007,7 +1030,7 @@ can also be defined during creation. @doc("Update the given glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @put - updateCategory is DataMapBaseOperation< + updateCategory is AtlasBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1024,7 +1047,7 @@ can also be defined during creation. @doc("Delete a glossary category.") @route("/atlas/v2/glossary/category/{categoryGuid}") @delete - deleteCategory is DataMapBaseOperation< + deleteCategory is AtlasBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1042,7 +1065,7 @@ updating shortDescription and longDescription for category. """) @route("/atlas/v2/glossary/category/{categoryGuid}/partial") @put - partialUpdateCategory is DataMapBaseOperation< + partialUpdateCategory is AtlasBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1065,7 +1088,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/category/{categoryGuid}/related") @get - listRelatedCategories is DataMapBaseOperation< + listRelatedCategories is AtlasBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1090,7 +1113,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Get all terms associated with the specific category.") @route("/atlas/v2/glossary/category/{categoryGuid}/terms") @get - listCategoryTerms is DataMapBaseOperation< + listCategoryTerms is AtlasBaseOperation< { @doc("The globally unique identifier of the category.") @path @@ -1115,7 +1138,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Create a glossary term.") @route("/atlas/v2/glossary/term") @post - createTerm is DataMapBaseOperation< + createTerm is AtlasBaseOperation< { @doc("Whether include term hierarchy") @query @@ -1136,7 +1159,7 @@ Optionally it can be categorized as well. @doc("Get a specific glossary term by its GUID. ") @route("/atlas/v2/glossary/term/{termGuid}") @get - getTerm is DataMapBaseOperation< + getTerm is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1149,7 +1172,7 @@ Optionally it can be categorized as well. @doc("Update the given glossary term by its GUID.") @route("/atlas/v2/glossary/term/{termGuid}") @put - updateTerm is DataMapBaseOperation< + updateTerm is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1170,7 +1193,7 @@ Optionally it can be categorized as well. @doc("Delete a glossary term.") @route("/atlas/v2/glossary/term/{termGuid}") @delete - deleteTerm is DataMapBaseOperation< + deleteTerm is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1187,7 +1210,7 @@ shortDescription, longDescription, abbreviation, usage and status for term. """) @route("/atlas/v2/glossary/term/{termGuid}/partial") @put - partialUpdateTerm is DataMapBaseOperation< + partialUpdateTerm is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1212,7 +1235,7 @@ values to be updated. @doc("Create glossary terms in bulk.") @route("/atlas/v2/glossary/terms") @post - createTerms is DataMapBaseOperation< + createTerms is AtlasBaseOperation< { @doc("Whether include term hierarchy") @query @@ -1232,7 +1255,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @get - listEntitiesAssignedWithTerm is DataMapBaseOperation< + listEntitiesAssignedWithTerm is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1265,7 +1288,7 @@ is an alternative to assign a term to multiple entities. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @post - assignTermToEntities is DataMapBaseOperation< + assignTermToEntities is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1283,7 +1306,7 @@ is an alternative to assign a term to multiple entities. @doc("Delete the term assignment for the given list of related objects.") @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @delete - deleteTermAssignmentFromEntities is DataMapBaseOperation< + deleteTermAssignmentFromEntities is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1303,7 +1326,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/terms/{termGuid}/related") @get - listRelatedTerms is DataMapBaseOperation< + listRelatedTerms is AtlasBaseOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1328,7 +1351,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Get a specific Glossary by its GUID.") @route("/atlas/v2/glossary/{glossaryGuid}") @get - get is DataMapBaseOperation< + get is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1341,7 +1364,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Update the given glossary.") @route("/atlas/v2/glossary/{glossaryGuid}") @put - update is DataMapBaseOperation< + update is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1365,7 +1388,7 @@ separate delete terms and categories. """) @route("/atlas/v2/glossary/{glossaryGuid}") @delete - delete is DataMapBaseOperation< + delete is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1381,7 +1404,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories") @get - listCategories is DataMapBaseOperation< + listCategories is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1409,7 +1432,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") @get - listCategoriesHeaders is DataMapBaseOperation< + listCategoriesHeaders is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1445,7 +1468,7 @@ Recommend to fetch terms/categories details separately using """) @route("/atlas/v2/glossary/{glossaryGuid}/detailed") @get - getDetailed is DataMapBaseOperation< + getDetailed is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1468,7 +1491,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. """) @route("/atlas/v2/glossary/{glossaryGuid}/partial") @put - partialUpdate is DataMapBaseOperation< + partialUpdate is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1495,7 +1518,7 @@ pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms") @get - listTerms is DataMapBaseOperation< + listTerms is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1523,7 +1546,7 @@ to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") @get - listTermHeaders is DataMapBaseOperation< + listTermHeaders is AtlasBaseOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1654,7 +1677,7 @@ GET """) @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") @get - getByUniqueAttribute is DataMapBaseOperation< + getByUniqueAttribute is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -1684,7 +1707,7 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is DataMapBaseOperation< + create is AtlasBaseOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1700,7 +1723,7 @@ be created. @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is DataMapBaseOperation< + update is AtlasBaseOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1716,7 +1739,7 @@ be created. @doc("Get relationship information between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @get - get is DataMapBaseOperation< + get is AtlasBaseOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1733,7 +1756,7 @@ be created. @doc("Delete a relationship between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @delete - delete is DataMapBaseOperation< + delete is AtlasBaseOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1748,7 +1771,7 @@ interface `Type`{ @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get - getBusinessMetadataDefByGuid is DataMapBaseOperation< + getBusinessMetadataDefByGuid is AtlasBaseOperation< { @doc("businessMetadata guid") @path @@ -1761,7 +1784,7 @@ interface `Type`{ @doc("Get the businessMetadata definition by it's name (unique).") @route("/atlas/v2/types/businessmetadatadef/name/{name}") @get - getBusinessMetadataDefByName is DataMapBaseOperation< + getBusinessMetadataDefByName is AtlasBaseOperation< { @doc("businessMetadata name") @path @@ -1774,7 +1797,7 @@ interface `Type`{ @doc("Get the classification definition for the given GUID.") @route("/atlas/v2/types/classificationdef/guid/{guid}") @get - getClassificationDefByGuid is DataMapBaseOperation< + getClassificationDefByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the classification.") @path @@ -1787,7 +1810,7 @@ interface `Type`{ @doc("Get the classification definition by its name (unique).") @route("/atlas/v2/types/classificationdef/name/{name}") @get - getClassificationDefByName is DataMapBaseOperation< + getClassificationDefByName is AtlasBaseOperation< { @doc("The name of the classification.") @path @@ -1800,7 +1823,7 @@ interface `Type`{ @doc("Get the Entity definition for the given GUID.") @route("/atlas/v2/types/entitydef/guid/{guid}") @get - getEntityDefByGuid is DataMapBaseOperation< + getEntityDefByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1813,7 +1836,7 @@ interface `Type`{ @doc("Get the entity definition by its name (unique).") @route("/atlas/v2/types/entitydef/name/{name}") @get - getEntityDefByName is DataMapBaseOperation< + getEntityDefByName is AtlasBaseOperation< { @doc("The name of the entity.") @path @@ -1826,7 +1849,7 @@ interface `Type`{ @doc("Get the enum definition for the given GUID.") @route("/atlas/v2/types/enumdef/guid/{guid}") @get - getEnumDefByGuid is DataMapBaseOperation< + getEnumDefByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the enum.") @path @@ -1839,7 +1862,7 @@ interface `Type`{ @doc("Get the enum definition by its name (unique).") @route("/atlas/v2/types/enumdef/name/{name}") @get - getEnumDefByName is DataMapBaseOperation< + getEnumDefByName is AtlasBaseOperation< { @doc("The name of the enum.") @path @@ -1852,7 +1875,7 @@ interface `Type`{ @doc("Get the relationship definition for the given GUID.") @route("/atlas/v2/types/relationshipdef/guid/{guid}") @get - getRelationshipDefByGuid is DataMapBaseOperation< + getRelationshipDefByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1865,7 +1888,7 @@ interface `Type`{ @doc("Get the relationship definition by its name (unique).") @route("/atlas/v2/types/relationshipdef/name/{name}") @get - getRelationshipDefByName is DataMapBaseOperation< + getRelationshipDefByName is AtlasBaseOperation< { @doc("The name of the relationship.") @path @@ -1878,7 +1901,7 @@ interface `Type`{ @doc("Get the struct definition for the given GUID.") @route("/atlas/v2/types/structdef/guid/{guid}") @get - getStructDefByGuid is DataMapBaseOperation< + getStructDefByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the struct.") @path @@ -1891,7 +1914,7 @@ interface `Type`{ @doc("Get the struct definition by its name (unique).") @route("/atlas/v2/types/structdef/name/{name}") @get - getStructDefByName is DataMapBaseOperation< + getStructDefByName is AtlasBaseOperation< { @doc("The name of the struct.") @path @@ -1904,7 +1927,7 @@ interface `Type`{ @doc("Get the type definition for the given GUID.") @route("/atlas/v2/types/typedef/guid/{guid}") @get - getByGuid is DataMapBaseOperation< + getByGuid is AtlasBaseOperation< { @doc("The globally unique identifier of the type.") @path @@ -1917,7 +1940,7 @@ interface `Type`{ @doc("Get the type definition by its name (unique).") @route("/atlas/v2/types/typedef/name/{name}") @get - getByName is DataMapBaseOperation< + getByName is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -1930,7 +1953,7 @@ interface `Type`{ @doc("Delete API for type identified by its name.") @route("/atlas/v2/types/typedef/name/{name}") @delete - delete is DataMapBaseOperation< + delete is AtlasBaseOperation< { @doc("The name of the type.") @path @@ -1943,7 +1966,7 @@ interface `Type`{ @doc("List all type definitions in bulk.") @route("/atlas/v2/types/typedefs") @get - list is DataMapBaseOperation< + list is AtlasBaseOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -1968,7 +1991,7 @@ Any changes to the existing definitions will be discarded. """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is DataMapBaseOperation< + bulkCreate is AtlasBaseOperation< { @doc("A composite wrapper object with corresponding lists of the type definition.") @body @@ -1984,7 +2007,7 @@ persisted. """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is DataMapBaseOperation< + bulkUpdate is AtlasBaseOperation< { @doc("A composite object that captures all type definition changes.") @body @@ -1997,7 +2020,7 @@ persisted. @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is DataMapBaseOperation< + bulkDelete is AtlasBaseOperation< { @doc("A composite object that captures all types to be deleted") @body @@ -2010,7 +2033,7 @@ persisted. @doc("List all type definitions returned as a list of minimal information header.") @route("/atlas/v2/types/typedefs/headers") @get - listHeaders is DataMapBaseOperation< + listHeaders is AtlasBaseOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index e4ec69c6db39..a9c7501cbcd1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "body": { + "businessMetadata": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index b192524000a1..78ff0dd0dde3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "body": { + "businessMetadata": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9e2de7361e36..d02050e64adf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": { + "businessMetadata": { "myBizMetadata1": { "bizAttr1": "myBizMetaData1.bizAttr1" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 0b178e133e49..a1f905be1d1d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -3125,7 +3125,7 @@ "description": "Get lineage info of the entity specified by GUID.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "guid", @@ -4288,7 +4288,7 @@ "description": "Move existing entities to the target collection.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "collectionId", @@ -4334,7 +4334,7 @@ "description": "Return immediate next page lineage info about entity with pagination", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "guid", @@ -4420,7 +4420,7 @@ "description": "Get auto complete options.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "autoCompleteRequest", @@ -4459,7 +4459,7 @@ "description": "Get data using search.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "searchRequest", @@ -4558,7 +4558,7 @@ "description": "Get search suggestions by query criteria.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "suggestRequest", @@ -4597,7 +4597,7 @@ "description": "Get the term template definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "guid", @@ -4634,7 +4634,7 @@ "description": "Get the term template definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataMapApiVersionParameter" }, { "name": "name", @@ -9241,7 +9241,7 @@ "name": "api-version", "in": "query", "description": "The API version to use for this operation.", - "required": true, + "required": false, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", @@ -9256,6 +9256,16 @@ "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" + }, + "DataMapApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } From d266093950d73199b108a64ab42523cbcf2dcda9 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 11:29:01 +0800 Subject: [PATCH 026/132] update examples --- .../{Entity_Label.json => Entity_AddLabel.json} | 4 ++-- ...ntity_GetSampleBusinessMetadataTemplate.json | 3 ++- .../2023-09-01/Entity_RemoveLabels.json | 15 +++++++++++++++ .../examples/2023-09-01/Entity_SetLabels.json | 15 +++++++++++++++ .../Azure.Analytics.Purview.DataMap/routes.tsp | 2 +- ...ntity_GetSampleBusinessMetadataTemplate.json | 3 ++- .../stable/2023-09-01/openapi.json | 17 ++++++++++++++++- .../stable/2023-09-01/purviewdatamap.json | 6 +++--- 8 files changed, 56 insertions(+), 9 deletions(-) rename specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/{Entity_Label.json => Entity_AddLabel.json} (75%) create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json similarity index 75% rename from specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json rename to specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json index bb9ce5b59ba5..6c8c8ccf153d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Label.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json @@ -10,6 +10,6 @@ "responses": { "204": {} }, - "title": "Entity_Label", - "operationId": "Entity_Label" + "title": "Entity_AddLabel", + "operationId": "Entity_AddLabel" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json index 1e6900e014eb..34f5b284ae4b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,6 +1,7 @@ { "parameters": { - "Endpoint": "{Endpoint}" + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json new file mode 100644 index 000000000000..743f676c786b --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_RemoveLabels", + "operationId": "Entity_RemoveLabels" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json new file mode 100644 index 000000000000..e2b2c2eb6344 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "body": [ + "label1", + "label2" + ] + }, + "responses": { + "204": {} + }, + "title": "Entity_SetLabels", + "operationId": "Entity_SetLabels" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 5639575b257f..696c5e3e112f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1614,7 +1614,7 @@ interface Lineage { @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get - get is DataMapBaseOperation< + get is AtlasBaseOperation< { @doc("The globally unique identifier of the entity.") @path diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index 1e6900e014eb..34f5b284ae4b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,6 +1,7 @@ { "parameters": { - "Endpoint": "{Endpoint}" + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index a1f905be1d1d..c8c04c0f1f6a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -1132,6 +1132,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_AddLabel.json" + } } }, "post": { @@ -1171,6 +1176,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_SetLabels": { + "$ref": "./examples/Entity_SetLabels.json" + } } }, "delete": { @@ -1210,6 +1220,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_RemoveLabels.json" + } } } }, @@ -3125,7 +3140,7 @@ "description": "Get lineage info of the entity specified by GUID.", "parameters": [ { - "$ref": "#/parameters/DataMapApiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "guid", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 9a893b74e1d1..1d73f5fa7507 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1229,7 +1229,7 @@ ], "x-ms-examples": { "Entity_RemoveLabels": { - "$ref": "./examples/Entity_Label.json" + "$ref": "./examples/Entity_RemoveLabels.json" } }, "parameters": [ @@ -1273,7 +1273,7 @@ ], "x-ms-examples": { "Entity_SetLabel": { - "$ref": "./examples/Entity_Label.json" + "$ref": "./examples/Entity_SetLabels.json" } }, "parameters": [ @@ -1317,7 +1317,7 @@ ], "x-ms-examples": { "Entity_AddLabel": { - "$ref": "./examples/Entity_Label.json" + "$ref": "./examples/Entity_AddLabel.json" } }, "parameters": [ From d02dab7ca535fc39fe31e2b94839c8d4c5d5d2ee Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 11:42:19 +0800 Subject: [PATCH 027/132] update --- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../2023-09-01/Entity_RemoveBusinessAttribute.json | 2 +- .../examples/Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../examples/Entity_RemoveBusinessAttribute.json | 2 +- .../stable/2023-09-01/openapi.json | 10 +++++----- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json index a9c7501cbcd1..1b7b1a51ab41 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -11,5 +11,5 @@ "204": {} }, "title": "Entity_AddOrUpdate_BusinessAttribute", - "operationId": "Entity_AddOrUpdateBusinessMetadata" + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json index 78ff0dd0dde3..d6f0c4b6c41d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "businessMetadata": { + "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index a9c7501cbcd1..1b7b1a51ab41 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -11,5 +11,5 @@ "204": {} }, "title": "Entity_AddOrUpdate_BusinessAttribute", - "operationId": "Entity_AddOrUpdateBusinessMetadata" + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 78ff0dd0dde3..d6f0c4b6c41d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "businessMetadata": { + "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index c8c04c0f1f6a..92b0b844b7ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -702,11 +702,6 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } } }, "delete": { @@ -795,6 +790,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + } } }, "delete": { From cd0aa2bf32f0d9ae293c007248bef0c25c015be3 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 11:44:27 +0800 Subject: [PATCH 028/132] update example --- .../2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../examples/Entity_AddOrUpdate_BusinessAttribute.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json index 1b7b1a51ab41..5070f91d5d4f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "businessMetadata": { + "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 1b7b1a51ab41..5070f91d5d4f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "bmName": "myBizMetaData1", - "businessMetadata": { + "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } }, From e4dabe07f0ae2b6f5e58e63f3052a6cd47a4768c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 14:38:13 +0800 Subject: [PATCH 029/132] update businessMetadata --- .../Entity_AddOrUpdate_BusinessMetadata.json | 16 ++++++++++++++++ .../Azure.Analytics.Purview.DataMap/routes.tsp | 4 ++-- .../Entity_AddOrUpdate_BusinessMetadata.json | 16 ++++++++++++++++ .../stable/2023-09-01/openapi.json | 15 +++++++++++++-- 4 files changed, 47 insertions(+), 4 deletions(-) create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json new file mode 100644 index 000000000000..312894c87299 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "businessMetadata": { + "myBizMetadata1": { + "bizAttr1": "myBizMetaData1.bizAttr1" + } + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddOrUpdate_BusinessMetadata", + "operationId": "Entity_AddOrUpdateBusinessMetadata" +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 696c5e3e112f..41710bb41a9d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -639,7 +639,7 @@ example. qualifiedName can be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata payload") - @body businessMetadata: Record; + @body businessMetadata: Record>; }, void >; @@ -662,7 +662,7 @@ default is false. isOverwrite?: boolean; @doc("BusinessMetadata payload") #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @body businessMetadata: Record; + @body businessMetadata: Record>; }, void >; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json new file mode 100644 index 000000000000..312894c87299 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", + "businessMetadata": { + "myBizMetadata1": { + "bizAttr1": "myBizMetaData1.bizAttr1" + } + } + }, + "responses": { + "204": {} + }, + "title": "Entity_AddOrUpdate_BusinessMetadata", + "operationId": "Entity_AddOrUpdateBusinessMetadata" +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 92b0b844b7ee..33ea0dc1d2db 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -688,7 +688,10 @@ "required": true, "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } } } ], @@ -702,6 +705,11 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" + } } }, "delete": { @@ -725,7 +733,10 @@ "required": true, "schema": { "type": "object", - "additionalProperties": {} + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } } } ], From c3499c6308f75346b48b59c628b3309a2f86446b Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 15:10:52 +0800 Subject: [PATCH 030/132] Update purviewdatamap.json --- .../stable/2023-09-01/purviewdatamap.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 1d73f5fa7507..60b9ded4c853 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -6770,9 +6770,7 @@ }, "BusinessMetadataAttributes": { "type": "object", - "additionalProperties": { - "type": "object" - }, + "additionalProperties": {}, "description": "BusinessMetadataAttributes" } }, From a677c026ba876d73f2e9ab97f2ee76a93ce4ded5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 15:25:15 +0800 Subject: [PATCH 031/132] Update custom-words.txt --- custom-words.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/custom-words.txt b/custom-words.txt index 6d417cd05b14..185bb1f8b2e8 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -659,6 +659,7 @@ datalake datalakeanalytics datalakestore datamanagement +datamap datamasking datamigration datamodel From 967df058b97fe8dd1e09bc2c6d3eda3a220ad9d3 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 15:36:15 +0800 Subject: [PATCH 032/132] Update purviewdatamap.json --- .../stable/2023-09-01/purviewdatamap.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 60b9ded4c853..95991ef85127 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1011,7 +1011,7 @@ ], "x-ms-examples": { "Entity_AddOrUpdateBusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + "$ref": "./examples/Entity_AddOrUpdateBusinessMetadata.json" } }, "parameters": [ From e6c029f3eb877220e5f07a7fd87900b34a9fc87b Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 15:49:59 +0800 Subject: [PATCH 033/132] update searchoperator filter --- .../models.tsp | 30 ++++++- .../routes.tsp | 30 ++++--- .../stable/2023-09-01/openapi.json | 88 ++++++++++++++++++- 3 files changed, 131 insertions(+), 17 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index ca2c86a8ceda..0e0e959a60b9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -6,6 +6,34 @@ using TypeSpec.Http; namespace PurviewDataMap; +@doc("Search filter operator") +enum SearchFilterOperator { + @doc("eq") + eq, + @doc("ne") + ne, + @doc("gt") + gt, + @doc("lt") + lt, + @doc("ge") + ge, + @doc("le") + le, + @doc("contains") + contains, + @doc("contains_char") + contains_char, + @doc("startswith") + startswith, + @doc("prefix") + prefix, + @doc("timerange") + timerange, + @doc("exists") + exists; +} + @doc("Enum for business attribute update behavior") enum BusinessAttributeUpdateBehavior { @doc("Ignore the business attribute payload for update.") @@ -1955,7 +1983,7 @@ model AttributeFilter extends SearchFilter { @doc("Attribute name") attributeName: string; @doc("Operator") - operator: string; + operator: SearchFilterOperator; @doc("Attribute value") attributeValue: string; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 41710bb41a9d..5efd910c2541 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -72,19 +72,23 @@ op DataMapBaseOperation< ...TParams, ): TResponse | TErrorResponse; - op AtlasImportOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, Traits extends TypeSpec.Reflection.Model = {}, TraitContexts extends TraitContext = TraitContext.Undefined > is AtlasBaseOperation< -TParams, +TParams & TraitProperties, TResponse & TraitProperties, Traits >; //alias DataMapResourceOperations = Azure.Core.ResourceOperations; +alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; +}>; interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -725,14 +729,14 @@ default is false. @route("/atlas/v2/entity/businessmetadata/import") @post importBusinessMetadata is AtlasImportOperation< - { - @doc("InputStream of file") - uploadedInputStream: bytes; - @doc("The content type for the operation. Always multipart/form-data for this operation.") - @header("content-type") - contentType: "multipart/form-data"; - }, - BulkImportResponse + { + @doc("InputStream of file") + uploadedInputStream: bytes; + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; + }, + BulkImportResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1460,11 +1464,9 @@ recommend. Recommend to fetch terms/categories details separately using +GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and -'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and - - 'GET -'/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'. +GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. """) @route("/atlas/v2/glossary/{glossaryGuid}/detailed") @get diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 33ea0dc1d2db..2065988ef00e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -2060,7 +2060,7 @@ "/atlas/v2/glossary/{glossaryGuid}/detailed": { "get": { "operationId": "Glossary_GetDetailed", - "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\n\n'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET\n'/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -7227,7 +7227,7 @@ "description": "Attribute name" }, "operator": { - "type": "string", + "$ref": "#/definitions/SearchFilterOperator", "description": "Operator" }, "attributeValue": { @@ -8442,6 +8442,90 @@ "kind" ] }, + "SearchFilterOperator": { + "type": "string", + "description": "Search filter operator", + "enum": [ + "eq", + "ne", + "gt", + "lt", + "ge", + "le", + "contains", + "contains_char", + "startswith", + "prefix", + "timerange", + "exists" + ], + "x-ms-enum": { + "name": "SearchFilterOperator", + "modelAsString": true, + "values": [ + { + "name": "eq", + "value": "eq", + "description": "eq" + }, + { + "name": "ne", + "value": "ne", + "description": "ne" + }, + { + "name": "gt", + "value": "gt", + "description": "gt" + }, + { + "name": "lt", + "value": "lt", + "description": "lt" + }, + { + "name": "ge", + "value": "ge", + "description": "ge" + }, + { + "name": "le", + "value": "le", + "description": "le" + }, + { + "name": "contains", + "value": "contains", + "description": "contains" + }, + { + "name": "contains_char", + "value": "contains_char", + "description": "contains_char" + }, + { + "name": "startswith", + "value": "startswith", + "description": "startswith" + }, + { + "name": "prefix", + "value": "prefix", + "description": "prefix" + }, + { + "name": "timerange", + "value": "timerange", + "description": "timerange" + }, + { + "name": "exists", + "value": "exists", + "description": "exists" + } + ] + } + }, "SearchHighlights": { "type": "object", "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", From ba2b8e745b37e669285752ea4640d4003ea73944 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 16:00:19 +0800 Subject: [PATCH 034/132] update import examples --- .../examples/2023-09-01/Entity_ImportBusinessMetadata.json | 2 +- .../2023-09-01/examples/Entity_ImportBusinessMetadata.json | 2 +- .../stable/2023-09-01/purviewdatamap.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json index 8dec58efba8a..996488807898 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "file": "examplefile.csv" + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 8dec58efba8a..996488807898 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "file": "examplefile.csv" + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 95991ef85127..ea558592b25a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1011,7 +1011,7 @@ ], "x-ms-examples": { "Entity_AddOrUpdateBusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdateBusinessMetadata.json" + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" } }, "parameters": [ From a8660f78ea5099fd906316fee59c05a514d8af6a Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 16:32:14 +0800 Subject: [PATCH 035/132] update --- custom-words.txt | 1 + .../2023-09-01/Entity_ImportBusinessMetadata.json | 2 +- .../Azure.Analytics.Purview.DataMap/routes.tsp | 12 +++++------- .../examples/Entity_ImportBusinessMetadata.json | 2 +- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 185bb1f8b2e8..b81ba8d53696 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2867,6 +2867,7 @@ timeseries timeseriesinsights timespan timestep +timerange timezones tinyint titledatakeyvalues diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json index 996488807898..6af7d868ef02 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 5efd910c2541..d8b2783bb98e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -78,9 +78,9 @@ op AtlasImportOperation< Traits extends TypeSpec.Reflection.Model = {}, TraitContexts extends TraitContext = TraitContext.Undefined > is AtlasBaseOperation< -TParams & TraitProperties, -TResponse & TraitProperties, -Traits +TParams & TraitProperties, +TResponse & TraitProperties, +Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId >; //alias DataMapResourceOperations = Azure.Core.ResourceOperations; @@ -732,11 +732,9 @@ default is false. { @doc("InputStream of file") uploadedInputStream: bytes; - @doc("The content type for the operation. Always multipart/form-data for this operation.") - @header("content-type") - contentType: "multipart/form-data"; }, - BulkImportResponse + BulkImportResponse, + MultipartFormDataRequestHeadersTraits >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 996488807898..6af7d868ef02 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { From b6c6947a3d7df7f9de0b8819f45895b5c5864dd9 Mon Sep 17 00:00:00 2001 From: yaleiZhao <87844682+yaleiZhao@users.noreply.github.com> Date: Fri, 24 Nov 2023 16:38:18 +0800 Subject: [PATCH 036/132] Update Search Filters (#26837) --- .../models.tsp | 86 ++++++++++--------- .../stable/2023-09-01/openapi.json | 22 ++--- 2 files changed, 54 insertions(+), 54 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 0e0e959a60b9..33d42635e03f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -6,34 +6,6 @@ using TypeSpec.Http; namespace PurviewDataMap; -@doc("Search filter operator") -enum SearchFilterOperator { - @doc("eq") - eq, - @doc("ne") - ne, - @doc("gt") - gt, - @doc("lt") - lt, - @doc("ge") - ge, - @doc("le") - le, - @doc("contains") - contains, - @doc("contains_char") - contains_char, - @doc("startswith") - startswith, - @doc("prefix") - prefix, - @doc("timerange") - timerange, - @doc("exists") - exists; -} - @doc("Enum for business attribute update behavior") enum BusinessAttributeUpdateBehavior { @doc("Ignore the business attribute payload for update.") @@ -222,6 +194,32 @@ enum Typedef { term_template, } +@doc("Search Filter Operator") +enum SearchFilterOperator { + @doc("equal") + eq, + @doc("not equal") + ne, + @doc("greater than") + gt, + @doc("less than") + lt, + @doc("greater than or equal to") + ge, + @doc("less than or equal to") + le, + @doc("contains") + contains, + @doc("start with") + startswith, + @doc("prefix") + prefix, + @doc("time range") + timerange, + @doc("exists") + exists, +} + @doc(""" An instance of an entity along with extended info - like hive_table, hive_database. @@ -628,7 +626,7 @@ model AtlasGlossaryBaseObject { @doc("The short version of description.") shortDescription?: string; - + @doc("ETag for concurrency control.") lastModifiedTS?: string; @@ -1719,7 +1717,7 @@ AtoB might define 2 ends 

    end1:  type A, name attr7
-   end2: 
+   end2:
 type B, name attr8

@@ -1952,7 +1950,7 @@ model AndFilter extends SearchFilter { model NotFilter extends SearchFilter { @doc("Not filter for search") kind: "NotFilter"; - + @doc("Not filter") @projectedName("json", "not") notFilters : SearchFilter; @@ -1979,12 +1977,12 @@ model AssetTypeFilter extends SearchFilter { model AttributeFilter extends SearchFilter { @doc("Attribute filter for search") kind: "AttributeFilter"; - + @doc("Attribute name") attributeName: string; @doc("Operator") operator: SearchFilterOperator; - + @doc("Attribute value") attributeValue: string; } @@ -1999,6 +1997,14 @@ model ClassificationFilter extends SearchFilter { includeSubClassifications?: boolean; } +@doc("Classification category filter for search") +model ClassificationCategoryFilter extends SearchFilter { + @doc("Classification category filter for search") + kind: "ClassificationCategoryFilter"; + @doc("Classification category") + classificationCategory: string; +} + @doc("Collection id filter for search") model CollectionIdFilter extends SearchFilter { @doc("Collection id filter for search") @@ -2012,9 +2018,9 @@ model ContactFilter extends SearchFilter { @doc("Contact filter for search") kind: "ContactFilter"; @doc("Contact type") - contactType: string; + contactType?: string; @doc("Contact Id") - contactId: string; + contactId?: string; } @doc("Domain id filter for search") @@ -2078,7 +2084,7 @@ model ScanInfoFilter extends SearchFilter { @doc("Data source name") dataSourceName?: string; @doc("Scan name") - scanName: string; + scanName?: string; } @doc("Glossary filter for search") @@ -2117,8 +2123,8 @@ Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or u { "operator": "lt", "timeThreshold": 1545580800000 -} -to represent the time filter +} +to represent the time filter, operator must be one of gt/lt/gte/lte """) createTime: unknown; } @@ -2133,8 +2139,8 @@ Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or u { "operator": "lt", "timeThreshold": 1545580800000 -} -to represent the time filter +} +to represent the time filter, operator must be one of gt/lt/gte/lte """) updateTime: unknown; } \ No newline at end of file diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 2065988ef00e..ec3decc35510 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -8453,7 +8453,6 @@ "ge", "le", "contains", - "contains_char", "startswith", "prefix", "timerange", @@ -8466,47 +8465,42 @@ { "name": "eq", "value": "eq", - "description": "eq" + "description": "equal" }, { "name": "ne", "value": "ne", - "description": "ne" + "description": "not equal" }, { "name": "gt", "value": "gt", - "description": "gt" + "description": "greater than" }, { "name": "lt", "value": "lt", - "description": "lt" + "description": "less than" }, { "name": "ge", "value": "ge", - "description": "ge" + "description": "greater than or equal to" }, { "name": "le", "value": "le", - "description": "le" + "description": "less than or equal to" }, { "name": "contains", "value": "contains", "description": "contains" }, - { - "name": "contains_char", - "value": "contains_char", - "description": "contains_char" - }, { "name": "startswith", "value": "startswith", - "description": "startswith" + "description": "starts with" }, { "name": "prefix", @@ -8516,7 +8510,7 @@ { "name": "timerange", "value": "timerange", - "description": "timerange" + "description": "time range" }, { "name": "exists", From c518064ab54d763daa6545bd78877d1caca8cfc4 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 16:46:30 +0800 Subject: [PATCH 037/132] update --- .../Entity_ImportBusinessMetadata.json | 2 +- .../Entity_ImportBusinessMetadata.json | 2 +- .../stable/2023-09-01/openapi.json | 9381 ----------------- 3 files changed, 2 insertions(+), 9383 deletions(-) delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json index 6af7d868ef02..dd6f3a5375b8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "uploadedInputStream": "uploadedInputStreamInBytes" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 6af7d868ef02..dd6f3a5375b8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"uploadedInputStream\"; filename=\"example.csv\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "uploadedInputStream": "uploadedInputStreamInBytes" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json deleted file mode 100644 index 2065988ef00e..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ /dev/null @@ -1,9381 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Analytics Purview Data Map", - "version": "2023-09-01", - "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/datamap/api", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "AADToken": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "description": "The Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "" - } - } - }, - "tags": [], - "paths": { - "/atlas/v2/entity": { - "post": { - "operationId": "Entity_CreateOrUpdate", - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "entity", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - }, - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" - }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" - } - } - } - }, - "/atlas/v2/entity/bulk": { - "get": { - "operationId": "Entity_ListByGuids", - "description": "List entities in bulk identified by its GUIDs.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to list.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - } - }, - "post": { - "operationId": "Entity_BulkCreateOrUpdate", - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "entities", - "in": "body", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "Entity_BulkDelete", - "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to delete.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - } - } - }, - "/atlas/v2/entity/bulk/classification": { - "post": { - "operationId": "Entity_AddClassification", - "description": "Associate a classification to multiple entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "request", - "in": "body", - "description": "The request to associate a classification to multiple entities.", - "required": true, - "schema": { - "$ref": "#/definitions/ClassificationAssociateRequest" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "operationId": "Entity_BulkSetClassifications", - "description": "Set classifications on entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "entityHeaders", - "in": "body", - "description": "Atlas entity headers.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" - } - } - } - }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_ListByUniqueAttributes", - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "operationId": "Entity_ImportBusinessMetadata", - "description": "Upload the file for creating Business Metadata in BULK", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "uploadedInputStream", - "in": "formData", - "description": "InputStream of file", - "required": true, - "type": "string", - "format": "byte" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/BulkImportResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "produces": [ - "application/octet-stream", - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "file" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "operationId": "Entity_Get", - "description": "Get complete definition of an entity given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateAttributeByGuid", - "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not\nsupport updating complex types like arrays, and maps.\nNull updates are not\npossible.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The name of the attribute.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The value of the attribute.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" - } - } - }, - "delete": { - "operationId": "Entity_Delete", - "description": "Delete an entity identified by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "description": "Add business metadata to an entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "isOverwrite", - "in": "query", - "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", - "required": false, - "type": "boolean" - }, - { - "name": "businessMetadata", - "in": "body", - "description": "BusinessMetadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadata", - "description": "Remove business metadata from an entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "businessMetadata", - "in": "body", - "description": "Business metadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "description": "Add or update business metadata attributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "bmName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "businessMetadataAttributes", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "description": "Delete business metadata attributes from an entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "bmName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "businessMetadataAttributes", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { - "get": { - "operationId": "Entity_GetClassification", - "description": "Get classification for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassification" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveClassification", - "description": "Delete a given classification from an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "operationId": "Entity_GetClassifications", - "description": "List classifications for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassifications" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" - } - } - }, - "put": { - "operationId": "Entity_UpdateClassifications", - "description": "Update classifications to an existing entity represented by a guid.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classifications", - "in": "body", - "description": "An array of classifications to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassifications", - "description": "Add classifications to an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classifications", - "in": "body", - "description": "An array of classifications to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "operationId": "Entity_GetHeader", - "description": "Get entity header given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetHeader": { - "$ref": "./examples/Entity_GetHeader.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/labels": { - "put": { - "operationId": "Entity_AddLabel", - "description": "Add given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_AddLabel.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabels", - "description": "Set labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set to the entity", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabels": { - "$ref": "./examples/Entity_SetLabels.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabels", - "description": "Delete given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_RemoveLabels.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_GetByUniqueAttributes", - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateByUniqueAttributes", - "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "atlasEntityWithExtInfo", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" - } - } - }, - "delete": { - "operationId": "Entity_DeleteByUniqueAttribute", - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { - "delete": { - "operationId": "Entity_RemoveClassificationByUniqueAttribute", - "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "put": { - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "description": "Update classification on an entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "atlasClassificationArray", - "in": "body", - "description": "An array of classification to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "description": "Add classification to the entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "atlasClassificationArray", - "in": "body", - "description": "An array of classification to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "put": { - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/glossary": { - "get": { - "operationId": "Glossary_List", - "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossary" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - } - }, - "post": { - "operationId": "Glossary_Create", - "description": "Create a glossary.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "atlasGlossary", - "in": "body", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}": { - "get": { - "operationId": "Glossary_Get", - "description": "Get a specific Glossary by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } - } - }, - "put": { - "operationId": "Glossary_Update", - "description": "Update the given glossary.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "updatedGlossary", - "in": "body", - "description": "The glossary definition to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - } - }, - "delete": { - "operationId": "Glossary_Delete", - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/categories": { - "get": { - "operationId": "Glossary_ListCategories", - "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { - "get": { - "operationId": "Glossary_ListCategoriesHeaders", - "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/detailed": { - "get": { - "operationId": "Glossary_GetDetailed", - "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/partial": { - "put": { - "operationId": "Glossary_PartialUpdate", - "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "partialUpdates", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/terms": { - "get": { - "operationId": "Glossary_ListTerms", - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { - "get": { - "operationId": "Glossary_ListTermHeaders", - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/categories": { - "post": { - "operationId": "Glossary_CreateCategories", - "description": "Create glossary category in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryCategory", - "in": "body", - "description": "An array of glossary category definitions to be created.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "operationId": "Glossary_CreateCategory", - "description": "Create a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryCategory", - "in": "body", - "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}": { - "get": { - "operationId": "Glossary_GetCategory", - "description": "Get specific glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateCategory", - "description": "Update the given glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "glossaryCategory", - "in": "body", - "description": "The glossary category to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteCategory", - "description": "Delete a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateCategory", - "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "partialUpdates", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}/related": { - "get": { - "operationId": "Glossary_ListRelatedCategories", - "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}/terms": { - "get": { - "operationId": "Glossary_ListCategoryTerms", - "description": "Get all terms associated with the specific category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - } - } - }, - "/atlas/v2/glossary/term": { - "post": { - "operationId": "Glossary_CreateTerm", - "description": "Create a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "glossaryTerm", - "in": "body", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termGuid}": { - "get": { - "operationId": "Glossary_GetTerm", - "description": "Get a specific glossary term by its GUID. ", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" - }, - "Glossary_GetTermWithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateTerm", - "description": "Update the given glossary term by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "glossaryTerm", - "in": "body", - "description": "The glossary term to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTerm", - "description": "Delete a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termGuid}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateTerm", - "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "partialUpdates", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" - } - } - } - }, - "/atlas/v2/glossary/terms": { - "post": { - "operationId": "Glossary_CreateTerms", - "description": "Create glossary terms in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "glossaryTerm", - "in": "body", - "description": "An array of glossary term definitions to be created in bulk.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { - "get": { - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - } - }, - "post": { - "operationId": "Glossary_AssignTermToEntities", - "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "relatedObjectIds", - "in": "body", - "description": "An array of related object IDs to which the term has to be associated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTermAssignmentFromEntities", - "description": "Delete the term assignment for the given list of related objects.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "relatedObjectIds", - "in": "body", - "description": "An array of related object IDs from which the term has to be dissociated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termGuid}/related": { - "get": { - "operationId": "Glossary_ListRelatedTerms", - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "operationId": "Lineage_Get", - "description": "Get lineage info of the entity specified by GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" - } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Lineage_GetByUniqueAttribute", - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/relationship": { - "put": { - "operationId": "Relationship_Update", - "description": "Update an existing relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "relationship", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" - } - } - }, - "post": { - "operationId": "Relationship_Create", - "description": "Create a new relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "relationship", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - } - } - }, - "/atlas/v2/relationship/guid/{guid}": { - "get": { - "operationId": "Relationship_Get", - "description": "Get relationship information between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - }, - { - "name": "extendedInfo", - "in": "query", - "description": "Limits whether includes extended information.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - } - }, - "delete": { - "operationId": "Relationship_Delete", - "description": "Delete a relationship between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByGuid", - "description": "Get the businessMetadata definition for the given guid.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "businessMetadata guid", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByName", - "description": "Get the businessMetadata definition by it's name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "businessMetadata name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/guid/{guid}": { - "get": { - "operationId": "Type_GetClassificationDefByGuid", - "description": "Get the classification definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/name/{name}": { - "get": { - "operationId": "Type_GetClassificationDefByName", - "description": "Get the classification definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - } - } - }, - "/atlas/v2/types/entitydef/guid/{guid}": { - "get": { - "operationId": "Type_GetEntityDefByGuid", - "description": "Get the Entity definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/entitydef/name/{name}": { - "get": { - "operationId": "Type_GetEntityDefByName", - "description": "Get the entity definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByName": { - "$ref": "./examples/Type_GetEntityDefByName.json" - } - } - } - }, - "/atlas/v2/types/enumdef/guid/{guid}": { - "get": { - "operationId": "Type_GetEnumDefByGuid", - "description": "Get the enum definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/enumdef/name/{name}": { - "get": { - "operationId": "Type_GetEnumDefByName", - "description": "Get the enum definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/guid/{guid}": { - "get": { - "operationId": "Type_GetRelationshipDefByGuid", - "description": "Get the relationship definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/name/{name}": { - "get": { - "operationId": "Type_GetRelationshipDefByName", - "description": "Get the relationship definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } - } - } - }, - "/atlas/v2/types/structdef/guid/{guid}": { - "get": { - "operationId": "Type_GetStructDefByGuid", - "description": "Get the struct definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByGuid": { - "$ref": "./examples/Type_GetStructDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/structdef/name/{name}": { - "get": { - "operationId": "Type_GetStructDefByName", - "description": "Get the struct definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - } - } - }, - "/atlas/v2/types/typedef/guid/{guid}": { - "get": { - "operationId": "Type_GetByGuid", - "description": "Get the type definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - } - } - }, - "/atlas/v2/types/typedef/name/{name}": { - "get": { - "operationId": "Type_GetByName", - "description": "Get the type definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - } - }, - "delete": { - "operationId": "Type_Delete", - "description": "Delete API for type identified by its name.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" - } - } - } - }, - "/atlas/v2/types/typedefs": { - "get": { - "operationId": "Type_List", - "description": "List all type definitions in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "Typedef", - "modelAsString": true, - "values": [ - { - "name": "enum", - "value": "enum", - "description": "enum" - }, - { - "name": "entity", - "value": "entity", - "description": "entity" - }, - { - "name": "classification", - "value": "classification", - "description": "classification" - }, - { - "name": "relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "struct", - "value": "struct", - "description": "struct" - }, - { - "name": "term_template", - "value": "term_template", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - } - }, - "put": { - "operationId": "Type_BulkUpdate", - "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typesDef", - "in": "body", - "description": "A composite object that captures all type definition changes.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkUpdate": { - "$ref": "./examples/Type_BulkUpdate.json" - } - } - }, - "post": { - "operationId": "Type_BulkCreate", - "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typesDef", - "in": "body", - "description": "A composite wrapper object with corresponding lists of the type definition.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" - }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" - } - } - }, - "delete": { - "operationId": "Type_BulkDelete", - "description": "Delete API for all types in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typesDef", - "in": "body", - "description": "A composite object that captures all types to be deleted", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - } - } - }, - "/atlas/v2/types/typedefs/headers": { - "get": { - "operationId": "Type_ListHeaders", - "description": "List all type definitions returned as a list of minimal information header.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "Typedef", - "modelAsString": true, - "values": [ - { - "name": "enum", - "value": "enum", - "description": "enum" - }, - { - "name": "entity", - "value": "entity", - "description": "entity" - }, - { - "name": "classification", - "value": "classification", - "description": "classification" - }, - { - "name": "relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "struct", - "value": "struct", - "description": "struct" - }, - { - "name": "term_template", - "value": "term_template", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasTypeDefHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - } - } - }, - "/entity/moveTo": { - "post": { - "operationId": "Entity_MoveEntitiesToCollection", - "description": "Move existing entities to the target collection.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to.", - "required": true, - "type": "string" - }, - { - "name": "moveEntitiesRequest", - "in": "body", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } - } - } - }, - "/lineage/{guid}/next": { - "get": { - "operationId": "Lineage_GetNextPage", - "description": "Return immediate next page lineage info about entity with pagination", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - } - } - }, - "/search/autocomplete": { - "post": { - "operationId": "Discovery_AutoComplete", - "description": "Get auto complete options.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "autoCompleteRequest", - "in": "body", - "description": "An object specifying the autocomplete criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/AutoCompleteRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AutoCompleteResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - } - } - }, - "/search/query": { - "post": { - "operationId": "Discovery_Query", - "description": "Get data using search.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "searchRequest", - "in": "body", - "description": "An object specifying the search criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/SearchRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/SearchResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" - }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" - }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" - }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_TermAssignment": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Type": { - "$ref": "./examples/Discovery_Query_Type.json" - } - } - } - }, - "/search/suggest": { - "post": { - "operationId": "Discovery_Suggest", - "description": "Get search suggestions by query criteria.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "suggestRequest", - "in": "body", - "description": "An object specifying the suggest criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/SuggestRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/SuggestResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - } - } - }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "operationId": "Type_GetTermTemplateDefByGuid", - "description": "Get the term template definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - } - } - }, - "/types/termtemplatedef/name/{name}": { - "get": { - "operationId": "Type_GetTermTemplateDefByName", - "description": "Get the term template definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The unique name of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" - } - } - } - } - }, - "definitions": { - "AADToken": { - "type": "object", - "description": "The Azure Active Directory OAuth2 Flow", - "properties": { - "type": { - "type": "string", - "description": "OAuth2 authentication", - "enum": [ - "oauth2" - ] - }, - "flows": { - "type": "array", - "description": "Supported OAuth2 flows", - "items": {} - } - }, - "required": [ - "type", - "flows" - ] - }, - "AndFilter": { - "type": "object", - "description": "And filter for search", - "properties": { - "and": { - "type": "array", - "description": "List of filters", - "items": { - "$ref": "#/definitions/SearchFilter" - }, - "x-ms-client-name": "andFilters", - "x-ms-identifiers": [] - } - }, - "required": [ - "and" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AndFilter" - }, - "ApiVersions": { - "type": "string", - "description": "Service API versions", - "enum": [ - "2023-09-01" - ], - "x-ms-enum": { - "name": "ApiVersions", - "modelAsString": true, - "values": [ - { - "name": "2023-09-01", - "value": "2023-09-01", - "description": "2023-09-01 service API version" - } - ] - } - }, - "AssetTypeFilter": { - "type": "object", - "description": "Asset type filter for search", - "properties": { - "assetType": { - "type": "string", - "description": "Asset type name" - } - }, - "required": [ - "assetType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AssetTypeFilter" - }, - "AtlasAttributeDef": { - "type": "object", - "description": "class that captures details of a struct-attribute.", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - } - } - }, - "AtlasBaseModelObject": { - "type": "object", - "description": "The base model object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - } - } - }, - "AtlasBaseTypeDef": { - "type": "object", - "description": "Base class that captures common-attributes for all types.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassification": { - "type": "object", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityGuid": { - "type": "string", - "description": "The GUID of the entity." - }, - "entityStatus": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "removePropagationsOnEntityDelete": { - "type": "boolean", - "description": "Determines if propagations will be removed on entity deletion." - }, - "validityPeriods": { - "type": "array", - "description": "An array of time boundaries indicating validity periods.", - "items": { - "$ref": "#/definitions/TimeBoundary" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassificationDef": { - "type": "object", - "description": "class that captures details of a classification-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - } - } - }, - "AtlasClassifications": { - "type": "object", - "description": "REST serialization friendly list.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "AtlasConstraintDef": { - "type": "object", - "description": "class that captures details of a constraint.", - "properties": { - "params": { - "type": "object", - "description": "The parameters of the constraint definition.", - "additionalProperties": {} - }, - "type": { - "type": "string", - "description": "The type of the constraint." - } - } - }, - "AtlasEntitiesWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entities": { - "type": "array", - "description": "An array of entities.", - "items": { - "$ref": "#/definitions/AtlasEntity" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntity": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "businessAttributes": { - "type": "object", - "description": "Business attributes", - "additionalProperties": {} - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "customAttributes": { - "type": "object", - "description": "Custom Attribute", - "additionalProperties": { - "type": "string" - } - }, - "guid": { - "type": "string", - "description": "The GUID of the entity." - }, - "homeId": { - "type": "string", - "description": "The home ID of the entity." - }, - "collectionId": { - "type": "string", - "description": "The collection ID of the entity.", - "readOnly": true - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers indicating the meanings of the entity.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship." - }, - "proxy": { - "type": "boolean", - "description": "Determines if there's a proxy." - }, - "relationshipAttributes": { - "type": "object", - "description": "The attributes of relationship.", - "additionalProperties": {} - }, - "status": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the entity." - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactBasic" - }, - "type": "array" - } - } - } - }, - "AtlasEntityDef": { - "type": "object", - "description": "class that captures details of a entity-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntityExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - } - } - }, - "AtlasEntityHeader": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "classificationNames": { - "type": "array", - "description": "An array of classification names.", - "items": { - "type": "string" - } - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "guid": { - "type": "string", - "description": "The GUID of the record." - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meaningNames": { - "type": "array", - "description": "An array of meanings.", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - } - } - }, - "AtlasEntityHeaders": { - "type": "object", - "description": "An instance of an entity header map.", - "properties": { - "guidHeaderMap": { - "type": "object", - "description": "The description of the guid header map,", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - } - } - }, - "AtlasEntityWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entity": { - "$ref": "#/definitions/AtlasEntity", - "description": "An instance of an entity - like hive_table, hive_database." - } - } - }, - "AtlasEnumDef": { - "type": "object", - "description": "class that captures details of an enum-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEnumElementDef": { - "type": "object", - "description": "class that captures details of an enum-element.", - "properties": { - "description": { - "type": "string", - "description": "The description of the enum element definition." - }, - "ordinal": { - "type": "integer", - "format": "int32", - "description": "The ordinal of the enum element definition." - }, - "value": { - "type": "string", - "description": "The value of the enum element definition." - } - } - }, - "AtlasExtraTypeDef": { - "type": "object", - "description": "Extra properties for a type.", - "properties": { - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n
    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossary": { - "type": "object", - "description": "The glossary object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - } - } - }, - "AtlasGlossaryBaseObject": { - "type": "object", - "description": "The glossary base object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - } - } - }, - "AtlasGlossaryCategory": { - "type": "object", - "description": "The glossary category.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "childrenCategories": { - "type": "array", - "description": "An array of children categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader", - "description": "The header of the related category." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossaryExtInfo": { - "type": "object", - "description": "The extended information of glossary.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - }, - "categoryInfo": { - "type": "object", - "description": "The glossary category information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "termInfo": { - "type": "object", - "description": "The glossary term information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - } - }, - "AtlasGlossaryHeader": { - "type": "object", - "description": "The glossary header with basic information.", - "properties": { - "displayText": { - "type": "string", - "description": "The display text." - }, - "glossaryGuid": { - "type": "string", - "description": "The GUID of the glossary." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasGlossaryTerm": { - "type": "object", - "description": "The glossary term.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "abbreviation": { - "type": "string", - "description": "The abbreviation of the term." - }, - "templateName": { - "type": "array", - "description": "The name of the template.", - "items": {} - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "antonyms": { - "type": "array", - "description": "An array of related term headers as antonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/TermStatus", - "description": "Status of the AtlasGlossaryTerm" - }, - "nickName": { - "type": "string", - "description": "The nick name of the term." - }, - "hierarchyInfo": { - "type": "array", - "description": "The hierarchy information of the term.", - "items": { - "$ref": "#/definitions/PurviewObjectId" - }, - "x-ms-identifiers": [] - }, - "resources": { - "type": "array", - "description": "An array of resource link for term", - "items": { - "$ref": "#/definitions/ResourceLink" - }, - "x-ms-identifiers": [] - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactBasic" - }, - "type": "array" - } - }, - "attributes": { - "type": "object", - "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "assignedEntities": { - "type": "array", - "description": "An array of related object IDs.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - }, - "categories": { - "type": "array", - "description": "An array of term categorization headers.", - "items": { - "$ref": "#/definitions/AtlasTermCategorizationHeader" - }, - "x-ms-identifiers": [] - }, - "classifies": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "examples": { - "type": "array", - "description": "An array of examples.", - "items": { - "type": "string" - } - }, - "isA": { - "type": "array", - "description": "An array of related term headers indicating the is-a relationship.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredTerms": { - "type": "array", - "description": "An array of preferred related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredToTerms": { - "type": "array", - "description": "An array of related term headers that are preferred to.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacedBy": { - "type": "array", - "description": "An array of related term headers that are replaced by.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacementTerms": { - "type": "array", - "description": "An array of related term headers for replacement.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "seeAlso": { - "type": "array", - "description": "An array of related term headers for see also.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "synonyms": { - "type": "array", - "description": "An array of related term headers as synonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translatedTerms": { - "type": "array", - "description": "An array of translated related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translationTerms": { - "type": "array", - "description": "An array of related term headers for translation.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the term." - }, - "validValues": { - "type": "array", - "description": "An array of related term headers as valid values.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "validValuesFor": { - "type": "array", - "description": "An array of related term headers as valid values for other records.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasLineageInfo": { - "type": "object", - "description": "The lineage information.", - "properties": { - "baseEntityGuid": { - "type": "string", - "description": "The GUID of the base entity." - }, - "guidEntityMap": { - "type": "object", - "description": "The GUID entity map.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "widthCounts": { - "type": "object", - "description": "The entity count in specific direction.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "lineageDepth": { - "type": "integer", - "format": "int32", - "description": "The depth of lineage." - }, - "lineageWidth": { - "type": "integer", - "format": "int32", - "description": "The width of lineage." - }, - "childrenCount": { - "type": "integer", - "format": "int32", - "description": "The number of children node." - }, - "lineageDirection": { - "$ref": "#/definitions/LineageDirection", - "description": "The enum of lineage direction." - }, - "parentRelations": { - "type": "array", - "description": "An array of parentRelations relations.", - "items": { - "$ref": "#/definitions/ParentRelation" - }, - "x-ms-identifiers": [] - }, - "relations": { - "type": "array", - "description": "An array of lineage relations.", - "items": { - "$ref": "#/definitions/LineageRelation" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasObjectId": { - "type": "object", - "description": "Reference to an object-instance of a type - like entity.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - } - } - }, - "AtlasRelatedCategoryHeader": { - "type": "object", - "description": "The header of the related category.", - "properties": { - "categoryGuid": { - "type": "string", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the category header." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "parentCategoryGuid": { - "type": "string", - "description": "The GUID of the parent category." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasRelatedObjectId": { - "type": "object", - "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "entityStatus": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "relationshipType": { - "type": "string", - "description": "Relationship type" - }, - "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." - }, - "relationshipGuid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "relationshipStatus": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - } - } - }, - "AtlasRelatedTermHeader": { - "type": "object", - "description": "The header of the related term.", - "properties": { - "description": { - "type": "string", - "description": "The description of the related term." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "expression": { - "type": "string", - "description": "The expression of the term." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus", - "description": "The status of term relationship." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." - } - } - }, - "AtlasRelationship": { - "type": "object", - "description": "Atlas relationship instance.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "end1": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "end2": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "guid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "homeId": { - "type": "string", - "description": "The home ID of the relationship." - }, - "label": { - "type": "string", - "description": "The label of the relationship." - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship" - }, - "status": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the relationship." - } - } - }, - "AtlasRelationshipAttributeDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - }, - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." - }, - "relationshipTypeName": { - "type": "string", - "description": "The name of the relationship type." - } - } - }, - "AtlasRelationshipDef": { - "type": "object", - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

\nAs with\nother typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\n

\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\n

\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed.
\nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required
\nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\n

\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\n

\nEntityDef A might have attributes attr1,attr2,attr3\n
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef\nAtoB might define 2 ends
\n\n

\n   end1:  type A, name attr7\n   end2: \ntype B, name attr8
\n\n

\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n

\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - } - } - }, - "AtlasRelationshipEndDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality", - "description": "single-valued attribute or multi-valued attribute." - }, - "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." - } - } - }, - "AtlasRelationshipWithExtInfo": { - "type": "object", - "description": "The relationship with extended information.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entity header.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "relationship": { - "$ref": "#/definitions/AtlasRelationship", - "description": "Atlas relationship instance." - } - } - }, - "AtlasStruct": { - "type": "object", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasStructDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTermAssignmentHeader": { - "type": "object", - "description": "The header for term assignment.", - "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", - "description": "The status of terms assignment." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." - } - } - }, - "AtlasTermAssignmentStatus": { - "type": "string", - "description": "Status for term assignment", - "enum": [ - "DISCOVERED", - "PROPOSED", - "IMPORTED", - "VALIDATED", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermAssignmentStatus", - "modelAsString": true, - "values": [ - { - "name": "DISCOVERED", - "value": "DISCOVERED", - "description": "The status is discovered." - }, - { - "name": "PROPOSED", - "value": "PROPOSED", - "description": "The status is proposed." - }, - { - "name": "IMPORTED", - "value": "IMPORTED", - "description": "The status is imported." - }, - { - "name": "VALIDATED", - "value": "VALIDATED", - "description": "The status is validated." - }, - { - "name": "DEPRECATED", - "value": "DEPRECATED", - "description": "The status is deprecated." - }, - { - "name": "OBSOLETE", - "value": "OBSOLETE", - "description": "The status is obsolete." - }, - { - "name": "OTHER", - "value": "OTHER", - "description": "Other status." - } - ] - } - }, - "AtlasTermCategorizationHeader": { - "type": "object", - "description": "The basic information for term categorization.", - "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", - "description": "The status of term relationship." - } - } - }, - "AtlasTermRelationshipStatus": { - "type": "string", - "description": "Status for atlas term relationship", - "enum": [ - "DRAFT", - "ACTIVE", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermRelationshipStatus", - "modelAsString": true, - "values": [ - { - "name": "DRAFT", - "value": "DRAFT", - "description": "draft" - }, - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "DEPRECATED", - "value": "DEPRECATED", - "description": "deprecated" - }, - { - "name": "OBSOLETE", - "value": "OBSOLETE", - "description": "obsolete" - }, - { - "name": "OTHER", - "value": "OTHER", - "description": "other" - } - ] - } - }, - "AtlasTypeDef": { - "type": "object", - "description": "The definitions of type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTypeDefHeader": { - "type": "object", - "description": "The basic information of the type definition.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - } - } - }, - "AtlasTypesDef": { - "type": "object", - "description": "The definitions of types.", - "properties": { - "businessMetadataDefs": { - "type": "array", - "description": "businessMetadataDefs", - "items": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - }, - "x-ms-identifiers": [] - }, - "classificationDefs": { - "type": "array", - "description": "An array of classification definitions.", - "items": { - "$ref": "#/definitions/AtlasClassificationDef" - }, - "x-ms-identifiers": [] - }, - "entityDefs": { - "type": "array", - "description": "An array of entity definitions.", - "items": { - "$ref": "#/definitions/AtlasEntityDef" - }, - "x-ms-identifiers": [] - }, - "enumDefs": { - "type": "array", - "description": "An array of enum definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumDef" - }, - "x-ms-identifiers": [] - }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" - }, - "x-ms-identifiers": [] - }, - "structDefs": { - "type": "array", - "description": "An array of struct definitions.", - "items": { - "$ref": "#/definitions/AtlasStructDef" - }, - "x-ms-identifiers": [] - }, - "termTemplateDefs": { - "type": "array", - "description": "An array of term template definitions.", - "items": { - "$ref": "#/definitions/TermTemplateDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AttributeFilter": { - "type": "object", - "description": "Attribute filter for search", - "properties": { - "attributeName": { - "type": "string", - "description": "Attribute name" - }, - "operator": { - "$ref": "#/definitions/SearchFilterOperator", - "description": "Operator" - }, - "attributeValue": { - "type": "string", - "description": "Attribute value" - } - }, - "required": [ - "attributeName", - "operator", - "attributeValue" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AttributeFilter" - }, - "AutoCompleteRequest": { - "type": "object", - "description": "The query of autocomplete request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the autocomplete request." - } - } - }, - "AutoCompleteResult": { - "type": "object", - "description": "The result of the autocomplete request.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/AutoCompleteResultValue" - }, - "x-ms-identifiers": [] - } - } - }, - "AutoCompleteResultValue": { - "type": "object", - "description": "The value item of the autocomplete suggest.", - "properties": { - "text": { - "type": "string", - "description": "The completed term or phrase." - }, - "queryPlusText": { - "type": "string", - "description": "The completed search query text." - } - } - }, - "Azure.Core.Foundations.Error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - }, - "x-ms-identifiers": [] - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "An object containing more specific information than the current object about the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "Azure.Core.Foundations.ErrorResponse": { - "type": "object", - "description": "A response containing error details.", - "properties": { - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "The error object." - } - }, - "required": [ - "error" - ] - }, - "Azure.Core.Foundations.InnerError": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "Inner error." - } - } - }, - "BulkImportResponse": { - "type": "object", - "description": "example", - "properties": { - "failedImportInfoList": { - "type": "array", - "description": "failed importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - }, - "successImportInfoList": { - "type": "array", - "description": "successful importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - } - } - }, - "BusinessAttributeUpdateBehavior": { - "type": "string", - "description": "Enum for business attribute update behavior", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - "Cardinality": { - "type": "string", - "description": "Cardinality", - "enum": [ - "SINGLE", - "LIST", - "SET" - ], - "x-ms-enum": { - "name": "Cardinality", - "modelAsString": true, - "values": [ - { - "name": "SINGLE", - "value": "SINGLE", - "description": "single" - }, - { - "name": "LIST", - "value": "LIST", - "description": "list" - }, - { - "name": "SET", - "value": "SET", - "description": "set" - } - ] - } - }, - "ClassificationAssociateRequest": { - "type": "object", - "description": "The request for classification association.", - "properties": { - "classification": { - "$ref": "#/definitions/AtlasClassification", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." - }, - "entityGuids": { - "type": "array", - "description": "The GUID of the entity.", - "items": { - "type": "string" - } - } - } - }, - "ClassificationFilter": { - "type": "object", - "description": "Classification type filter for search", - "properties": { - "classificationName": { - "type": "string", - "description": "Classification name" - }, - "includeSubClassifications": { - "type": "boolean", - "description": "Whether to include sub classifications" - } - }, - "required": [ - "classificationName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ClassificationFilter" - }, - "CollectionIdFilter": { - "type": "object", - "description": "Collection id filter for search", - "properties": { - "collectionId": { - "type": "string", - "description": "Collection id" - } - }, - "required": [ - "collectionId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "CollectionIdFilter" - }, - "ContactBasic": { - "type": "object", - "description": "ContactBasic", - "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." - } - } - }, - "ContactFilter": { - "type": "object", - "description": "Contact filter for search", - "properties": { - "contactType": { - "type": "string", - "description": "Contact type" - }, - "contactId": { - "type": "string", - "description": "Contact Id" - } - }, - "required": [ - "contactType", - "contactId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ContactFilter" - }, - "ContactSearchResultValue": { - "type": "object", - "description": "The contact in the search and suggest result.", - "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\nExpert or Steward for a glossary term." - } - } - }, - "CreateTimeFilter": { - "type": "object", - "description": "Create time filter for search", - "properties": { - "createTime": { - "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n} \nto represent the time filter" - } - }, - "required": [ - "createTime" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "CreateTimeFilter" - }, - "DateFormat": { - "type": "object", - "description": "The date format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "An array of available locales.", - "items": { - "type": "string" - } - }, - "calendar": { - "type": "number", - "format": "float", - "description": "Calendar" - }, - "dateInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "dateTimeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "instance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "lenient": { - "type": "boolean", - "description": "Determines the leniency of the date format." - }, - "numberFormat": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "timeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "timeZone": { - "$ref": "#/definitions/TimeZone", - "description": "The timezone information." - } - } - }, - "Direction": { - "type": "string", - "description": "Direction", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, - "DomainIdFilter": { - "type": "object", - "description": "Domain id filter for search", - "properties": { - "domainId": { - "type": "string", - "description": "Domain id" - } - }, - "required": [ - "domainId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "DomainIdFilter" - }, - "EntityMutationResponse": { - "type": "object", - "description": "The mutation response of entity.", - "properties": { - "guidAssignments": { - "type": "object", - "description": "A map of GUID assignments with entities.", - "additionalProperties": { - "type": "string" - } - }, - "mutatedEntities": { - "type": "object", - "description": "The entity headers of mutated entities.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - }, - "partialUpdatedEntities": { - "type": "array", - "description": "An array of entity headers that partially updated.", - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "ErrorResponse": { - "type": "object", - "description": "An error response from the service", - "properties": { - "requestId": { - "type": "string", - "description": "The request ID." - }, - "errorCode": { - "type": "string", - "description": "The error code." - }, - "errorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "ExistsFilter": { - "type": "object", - "description": "Exists filter for search", - "properties": { - "exists": { - "type": "string", - "description": "Field", - "x-ms-client-name": "field" - } - }, - "required": [ - "exists" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ExistsFilter" - }, - "FileExtensionFilter": { - "type": "object", - "description": "File extension filter for search", - "properties": { - "fileExtension": { - "type": "string", - "description": "File extension" - } - }, - "required": [ - "fileExtension" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "FileExtensionFilter" - }, - "GlossaryFilter": { - "type": "object", - "description": "Glossary filter for search", - "properties": { - "glossaryType": { - "type": "string", - "description": "Glossary type. Either AtlasGlossary or AtlasGlossaryType" - } - }, - "required": [ - "glossaryType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "GlossaryFilter" - }, - "IdFilter": { - "type": "object", - "description": "Id filter for search", - "properties": { - "id": { - "type": "string", - "description": "Id value" - } - }, - "required": [ - "id" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "IdFilter" - }, - "ImportInfo": { - "type": "object", - "description": "ImportInfo", - "properties": { - "childObjectName": { - "type": "string", - "description": "childObjectName" - }, - "importStatus": { - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" - }, - "parentObjectName": { - "type": "string", - "description": "parentObjectName" - }, - "remarks": { - "type": "string", - "description": "remarks" - } - } - }, - "ImportStatus": { - "type": "string", - "description": "Status for import", - "enum": [ - "SUCCESS", - "FAILED" - ], - "x-ms-enum": { - "name": "ImportStatus", - "modelAsString": true, - "values": [ - { - "name": "SUCCESS", - "value": "SUCCESS", - "description": "Success" - }, - { - "name": "FAILED", - "value": "FAILED", - "description": "Failed" - } - ] - } - }, - "LabelFilter": { - "type": "object", - "description": "Label filter for search", - "properties": { - "label": { - "type": "string", - "description": "Label" - }, - "includeSubLabels": { - "type": "boolean", - "description": "Whether to include sub labels" - } - }, - "required": [ - "label" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "LabelFilter" - }, - "LineageDirection": { - "type": "string", - "description": "Lineage direction", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - } - ] - } - }, - "LineageRelation": { - "type": "object", - "description": "The lineage relation with GUID of the from and to entity.", - "properties": { - "fromEntityId": { - "type": "string", - "description": "The GUID of from-entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "toEntityId": { - "type": "string", - "description": "The GUID of to-entity." - } - } - }, - "MoveEntitiesRequest": { - "type": "object", - "description": "MoveEntitiesRequest", - "properties": { - "entityGuids": { - "type": "array", - "description": "An array of entity guids to be moved to target collection.", - "items": { - "type": "string" - } - } - } - }, - "NameInPath": { - "type": "object", - "description": "The path for name.", - "properties": { - "name": { - "type": "string", - "description": "name", - "readOnly": true - } - }, - "required": [ - "name" - ] - }, - "NotFilter": { - "type": "object", - "description": "Not filter for search", - "properties": { - "not": { - "$ref": "#/definitions/SearchFilter", - "description": "Not filter", - "x-ms-client-name": "notFilters" - } - }, - "required": [ - "not" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "NotFilter" - }, - "NumberFormat": { - "type": "object", - "description": "The number format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "The number format.", - "items": { - "type": "string" - } - }, - "currency": { - "type": "string", - "description": "The currency." - }, - "currencyInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "groupingUsed": { - "type": "boolean", - "description": "Determines if grouping is used." - }, - "instance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "integerInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "maximumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of fraction digits." - }, - "maximumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of integer digits." - }, - "minimumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of fraction digits." - }, - "minimumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of integer digits." - }, - "numberInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "parseIntegerOnly": { - "type": "boolean", - "description": "Determines if only integer is parsed." - }, - "percentInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "roundingMode": { - "$ref": "#/definitions/RoundingMode", - "description": "The enum of rounding mode." - } - } - }, - "ObjectTypeFilter": { - "type": "object", - "description": "Label filter for search", - "properties": { - "objectType": { - "type": "string", - "description": "Object type" - } - }, - "required": [ - "objectType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ObjectTypeFilter" - }, - "OrFilter": { - "type": "object", - "description": "Or filter for search", - "properties": { - "or": { - "type": "array", - "description": "List of filters", - "items": { - "$ref": "#/definitions/SearchFilter" - }, - "x-ms-client-name": "orFilters", - "x-ms-identifiers": [] - } - }, - "required": [ - "or" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "OrFilter" - }, - "PList": { - "type": "object", - "description": "Paginated-list, for returning search results.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "ParentRelation": { - "type": "object", - "description": "The lineage parents relation with GUID of the parent entity and to child entity.", - "properties": { - "childEntityId": { - "type": "string", - "description": "The GUID of child entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "parentEntityId": { - "type": "string", - "description": "The GUID of parent entity." - } - } - }, - "PathFilter": { - "type": "object", - "description": "Path filter for search", - "properties": { - "path": { - "type": "string", - "description": "Path" - }, - "isParent": { - "type": "boolean", - "description": "Whether the path is parent path" - } - }, - "required": [ - "path" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "PathFilter" - }, - "PurviewObjectId": { - "type": "object", - "description": "PurviewObjectId", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "name": { - "type": "string", - "description": "Name" - }, - "displayText": { - "type": "string", - "description": "Display text" - }, - "itemPath": { - "type": "string", - "description": "Item path" - }, - "resourceId": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "type": "object", - "description": "Dictionary of ", - "additionalProperties": {} - } - } - }, - "RelationshipCategory": { - "type": "string", - "description": "Relationship Category", - "enum": [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "x-ms-enum": { - "name": "RelationshipCategory", - "modelAsString": true, - "values": [ - { - "name": "ASSOCIATION", - "value": "ASSOCIATION", - "description": "association" - }, - { - "name": "AGGREGATION", - "value": "AGGREGATION", - "description": "aggregation" - }, - { - "name": "COMPOSITION", - "value": "COMPOSITION", - "description": "composition" - } - ] - } - }, - "ResourceLink": { - "type": "object", - "description": "ResourceLink", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." - }, - "url": { - "type": "string", - "description": "web url. http or https" - } - } - }, - "RoundingMode": { - "type": "string", - "description": "Rounding Mode", - "enum": [ - "UP", - "DOWN", - "CEILING", - "FLOOR", - "HALF_UP", - "HALF_DOWN", - "HALF_EVEN", - "UNNECESSARY" - ], - "x-ms-enum": { - "name": "RoundingMode", - "modelAsString": true, - "values": [ - { - "name": "UP", - "value": "UP", - "description": "up" - }, - { - "name": "DOWN", - "value": "DOWN", - "description": "down" - }, - { - "name": "CEILING", - "value": "CEILING", - "description": "ceiling" - }, - { - "name": "FLOOR", - "value": "FLOOR", - "description": "floor" - }, - { - "name": "HALF_UP", - "value": "HALF_UP", - "description": "half up" - }, - { - "name": "HALF_DOWN", - "value": "HALF_DOWN", - "description": "half down" - }, - { - "name": "HALF_EVEN", - "value": "HALF_EVEN", - "description": "half even" - }, - { - "name": "UNNECESSARY", - "value": "UNNECESSARY", - "description": "unnecessary" - } - ] - } - }, - "ScanInfoFilter": { - "type": "object", - "description": "Scan info filter for search", - "properties": { - "dataSourceName": { - "type": "string", - "description": "Data source name" - }, - "scanName": { - "type": "string", - "description": "Scan name" - } - }, - "required": [ - "scanName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ScanInfoFilter" - }, - "SearchFacetItem": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "facet": { - "type": "string", - "description": "The name of the facet item." - }, - "sort": { - "description": "Any object" - } - } - }, - "SearchFacetItemValue": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "value": { - "type": "string", - "description": "The name of the facet item." - } - } - }, - "SearchFacetResultValue": { - "type": "object", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "properties": { - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "assetType": { - "type": "array", - "description": "Asset type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "classification": { - "type": "array", - "description": "Classification", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "term": { - "type": "array", - "description": "Term", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactId": { - "type": "array", - "description": "Contact id", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactType": { - "type": "array", - "description": "Contact type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "label": { - "type": "array", - "description": "Label", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "glossaryType": { - "type": "array", - "description": "Glossary type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termStatus": { - "type": "array", - "description": "Term status", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termTemplate": { - "type": "array", - "description": "Term template", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - } - } - }, - "SearchFilter": { - "type": "object", - "description": "Base model for search filter", - "properties": { - "kind": { - "type": "string", - "description": "Discriminator property for SearchFilter." - } - }, - "discriminator": "kind", - "required": [ - "kind" - ] - }, - "SearchFilterOperator": { - "type": "string", - "description": "Search filter operator", - "enum": [ - "eq", - "ne", - "gt", - "lt", - "ge", - "le", - "contains", - "contains_char", - "startswith", - "prefix", - "timerange", - "exists" - ], - "x-ms-enum": { - "name": "SearchFilterOperator", - "modelAsString": true, - "values": [ - { - "name": "eq", - "value": "eq", - "description": "eq" - }, - { - "name": "ne", - "value": "ne", - "description": "ne" - }, - { - "name": "gt", - "value": "gt", - "description": "gt" - }, - { - "name": "lt", - "value": "lt", - "description": "lt" - }, - { - "name": "ge", - "value": "ge", - "description": "ge" - }, - { - "name": "le", - "value": "le", - "description": "le" - }, - { - "name": "contains", - "value": "contains", - "description": "contains" - }, - { - "name": "contains_char", - "value": "contains_char", - "description": "contains_char" - }, - { - "name": "startswith", - "value": "startswith", - "description": "startswith" - }, - { - "name": "prefix", - "value": "prefix", - "description": "prefix" - }, - { - "name": "timerange", - "value": "timerange", - "description": "timerange" - }, - { - "name": "exists", - "value": "exists", - "description": "exists" - } - ] - } - }, - "SearchHighlights": { - "type": "object", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "properties": { - "id": { - "type": "array", - "description": "Id", - "items": { - "type": "string" - } - }, - "qualifiedName": { - "type": "array", - "description": "Qualified name", - "items": { - "type": "string" - } - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "type": "string" - } - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "type": "string" - } - }, - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "type": "string" - } - } - } - }, - "SearchRequest": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchRequestTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, - "SearchRequestTaxonomySetting": { - "type": "object", - "description": "Taxonomy setting for search request", - "properties": { - "assetTypes": { - "type": "array", - "description": "Asset types", - "items": { - "type": "string" - } - }, - "facet": { - "$ref": "#/definitions/SearchFacetItem", - "description": "The content of a search facet result item." - } - } - }, - "SearchResult": { - "type": "object", - "description": "The result of the search result.", - "properties": { - "@search.count": { - "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single\npage).", - "x-ms-client-name": "searchCount" - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa.", - "x-ms-client-name": "searchCountApproximate" - }, - "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", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "x-ms-client-name": "searchFacets" - }, - "value": { - "type": "array", - "description": "Search result value", - "items": { - "$ref": "#/definitions/SearchResultValue" - } - } - } - }, - "SearchResultValue": { - "type": "object", - "description": "The value item of the search result.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.highlights": { - "$ref": "#/definitions/SearchHighlights", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "x-ms-client-name": "searchHighlights" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "SortType": { - "type": "string", - "description": "Type for sorting", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "SortType", - "modelAsString": true, - "values": [ - { - "name": "NONE", - "value": "NONE", - "description": "No sorting order" - }, - { - "name": "ASC", - "value": "ASC", - "description": "Use ascending order for sorting" - }, - { - "name": "DESC", - "value": "DESC", - "description": "Use descending order for sorting" - } - ] - } - }, - "Status": { - "type": "string", - "description": "Status - can be active or deleted", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true, - "values": [ - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "The status is active." - }, - { - "name": "DELETED", - "value": "DELETED", - "description": "The status is deleted." - } - ] - } - }, - "StatusAtlasRelationship": { - "type": "string", - "description": "Status for atlas relationship", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "StatusAtlasRelationship", - "modelAsString": true, - "values": [ - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "DELETED", - "value": "DELETED", - "description": "deleted" - } - ] - } - }, - "SuggestRequest": { - "type": "object", - "description": "The query of suggest request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the search." - } - } - }, - "SuggestResult": { - "type": "object", - "description": "The result item of the search suggest.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/SuggestResultValue" - } - } - } - }, - "SuggestResultValue": { - "type": "object", - "description": "The value item of the search suggest.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.text": { - "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", - "x-ms-client-name": "searchText" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "TermSearchResultValue": { - "type": "object", - "description": "The context.", - "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." - } - } - }, - "TermStatus": { - "type": "string", - "description": "Status for term", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true, - "values": [ - { - "name": "Draft", - "value": "Draft", - "description": "draft" - }, - { - "name": "Approved", - "value": "Approved", - "description": "approved" - }, - { - "name": "Alert", - "value": "Alert", - "description": "alert" - }, - { - "name": "Expired", - "value": "Expired", - "description": "expired" - } - ] - } - }, - "TermTemplateDef": { - "type": "object", - "description": "Term template definition for glossary term.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "TimeBoundary": { - "type": "object", - "description": "Captures time-boundary details", - "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." - } - } - }, - "TimeZone": { - "type": "object", - "description": "The timezone information.", - "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", - "description": "The timezone information." - }, - "displayName": { - "type": "string", - "description": "The display name of the timezone." - }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." - } - } - }, - "TypeCategory": { - "type": "string", - "description": "Type Category", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true, - "values": [ - { - "name": "PRIMITIVE", - "value": "PRIMITIVE", - "description": "primitive" - }, - { - "name": "OBJECT_ID_TYPE", - "value": "OBJECT_ID_TYPE", - "description": "object id type" - }, - { - "name": "ENUM", - "value": "ENUM", - "description": "enum" - }, - { - "name": "STRUCT", - "value": "STRUCT", - "description": "struct" - }, - { - "name": "CLASSIFICATION", - "value": "CLASSIFICATION", - "description": "classification" - }, - { - "name": "ENTITY", - "value": "ENTITY", - "description": "entity" - }, - { - "name": "ARRAY", - "value": "ARRAY", - "description": "array" - }, - { - "name": "MAP", - "value": "MAP", - "description": "map" - }, - { - "name": "RELATIONSHIP", - "value": "RELATIONSHIP", - "description": "relationship" - }, - { - "name": "TERM_TEMPLATE", - "value": "TERM_TEMPLATE", - "description": "term template" - } - ] - } - }, - "TypeFilter": { - "type": "object", - "description": "Type filter for search", - "properties": { - "typeName": { - "type": "string", - "description": "Type name" - }, - "includeSubTypes": { - "type": "boolean", - "description": "Whether to include sub types" - } - }, - "required": [ - "typeName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "TypeFilter" - }, - "Typedef": { - "type": "string", - "description": "Type", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "Typedef", - "modelAsString": true, - "values": [ - { - "name": "enum", - "value": "enum", - "description": "enum" - }, - { - "name": "entity", - "value": "entity", - "description": "entity" - }, - { - "name": "classification", - "value": "classification", - "description": "classification" - }, - { - "name": "relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "struct", - "value": "struct", - "description": "struct" - }, - { - "name": "term_template", - "value": "term_template", - "description": "term template" - } - ] - } - }, - "UpdateTimeFilter": { - "type": "object", - "description": "Update time filter for search", - "properties": { - "updateTime": { - "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n} \nto represent the time filter" - } - }, - "required": [ - "updateTime" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "UpdateTimeFilter" - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": false, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "DataMapApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - } - } -} From 8450f55a6cbd2b67e73d1a5710d6a242cd0498ec Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 24 Nov 2023 16:52:05 +0800 Subject: [PATCH 038/132] Delete openapi.json --- .../stable/2023-09-01/openapi.json | 9375 ----------------- 1 file changed, 9375 deletions(-) delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json deleted file mode 100644 index ec3decc35510..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ /dev/null @@ -1,9375 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Analytics Purview Data Map", - "version": "2023-09-01", - "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/datamap/api", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "AADToken": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "description": "The Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "" - } - } - }, - "tags": [], - "paths": { - "/atlas/v2/entity": { - "post": { - "operationId": "Entity_CreateOrUpdate", - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "entity", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - }, - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" - }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" - } - } - } - }, - "/atlas/v2/entity/bulk": { - "get": { - "operationId": "Entity_ListByGuids", - "description": "List entities in bulk identified by its GUIDs.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to list.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - } - }, - "post": { - "operationId": "Entity_BulkCreateOrUpdate", - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "entities", - "in": "body", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "Entity_BulkDelete", - "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to delete.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - } - } - }, - "/atlas/v2/entity/bulk/classification": { - "post": { - "operationId": "Entity_AddClassification", - "description": "Associate a classification to multiple entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "request", - "in": "body", - "description": "The request to associate a classification to multiple entities.", - "required": true, - "schema": { - "$ref": "#/definitions/ClassificationAssociateRequest" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "operationId": "Entity_BulkSetClassifications", - "description": "Set classifications on entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "entityHeaders", - "in": "body", - "description": "Atlas entity headers.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" - } - } - } - }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_ListByUniqueAttributes", - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "operationId": "Entity_ImportBusinessMetadata", - "description": "Upload the file for creating Business Metadata in BULK", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "uploadedInputStream", - "in": "formData", - "description": "InputStream of file", - "required": true, - "type": "string", - "format": "byte" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/BulkImportResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "produces": [ - "application/octet-stream", - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "file" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "operationId": "Entity_Get", - "description": "Get complete definition of an entity given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateAttributeByGuid", - "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not\nsupport updating complex types like arrays, and maps.\nNull updates are not\npossible.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The name of the attribute.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The value of the attribute.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" - } - } - }, - "delete": { - "operationId": "Entity_Delete", - "description": "Delete an entity identified by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "description": "Add business metadata to an entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "isOverwrite", - "in": "query", - "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", - "required": false, - "type": "boolean" - }, - { - "name": "businessMetadata", - "in": "body", - "description": "BusinessMetadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadata", - "description": "Remove business metadata from an entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "businessMetadata", - "in": "body", - "description": "Business metadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "description": "Add or update business metadata attributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "bmName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "businessMetadataAttributes", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "description": "Delete business metadata attributes from an entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "bmName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "businessMetadataAttributes", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { - "get": { - "operationId": "Entity_GetClassification", - "description": "Get classification for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassification" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveClassification", - "description": "Delete a given classification from an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "operationId": "Entity_GetClassifications", - "description": "List classifications for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassifications" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" - } - } - }, - "put": { - "operationId": "Entity_UpdateClassifications", - "description": "Update classifications to an existing entity represented by a guid.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classifications", - "in": "body", - "description": "An array of classifications to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassifications", - "description": "Add classifications to an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classifications", - "in": "body", - "description": "An array of classifications to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "operationId": "Entity_GetHeader", - "description": "Get entity header given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetHeader": { - "$ref": "./examples/Entity_GetHeader.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/labels": { - "put": { - "operationId": "Entity_AddLabel", - "description": "Add given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_AddLabel.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabels", - "description": "Set labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set to the entity", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabels": { - "$ref": "./examples/Entity_SetLabels.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabels", - "description": "Delete given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_RemoveLabels.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_GetByUniqueAttributes", - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateByUniqueAttributes", - "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "atlasEntityWithExtInfo", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" - } - } - }, - "delete": { - "operationId": "Entity_DeleteByUniqueAttribute", - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { - "delete": { - "operationId": "Entity_RemoveClassificationByUniqueAttribute", - "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "put": { - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "description": "Update classification on an entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "atlasClassificationArray", - "in": "body", - "description": "An array of classification to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "description": "Add classification to the entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "atlasClassificationArray", - "in": "body", - "description": "An array of classification to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "put": { - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/glossary": { - "get": { - "operationId": "Glossary_List", - "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossary" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - } - }, - "post": { - "operationId": "Glossary_Create", - "description": "Create a glossary.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "atlasGlossary", - "in": "body", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}": { - "get": { - "operationId": "Glossary_Get", - "description": "Get a specific Glossary by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } - } - }, - "put": { - "operationId": "Glossary_Update", - "description": "Update the given glossary.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "updatedGlossary", - "in": "body", - "description": "The glossary definition to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - } - }, - "delete": { - "operationId": "Glossary_Delete", - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/categories": { - "get": { - "operationId": "Glossary_ListCategories", - "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { - "get": { - "operationId": "Glossary_ListCategoriesHeaders", - "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/detailed": { - "get": { - "operationId": "Glossary_GetDetailed", - "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/partial": { - "put": { - "operationId": "Glossary_PartialUpdate", - "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "partialUpdates", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/terms": { - "get": { - "operationId": "Glossary_ListTerms", - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { - "get": { - "operationId": "Glossary_ListTermHeaders", - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryGuid", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/categories": { - "post": { - "operationId": "Glossary_CreateCategories", - "description": "Create glossary category in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryCategory", - "in": "body", - "description": "An array of glossary category definitions to be created.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "operationId": "Glossary_CreateCategory", - "description": "Create a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "glossaryCategory", - "in": "body", - "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}": { - "get": { - "operationId": "Glossary_GetCategory", - "description": "Get specific glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateCategory", - "description": "Update the given glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "glossaryCategory", - "in": "body", - "description": "The glossary category to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteCategory", - "description": "Delete a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateCategory", - "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "partialUpdates", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}/related": { - "get": { - "operationId": "Glossary_ListRelatedCategories", - "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryGuid}/terms": { - "get": { - "operationId": "Glossary_ListCategoryTerms", - "description": "Get all terms associated with the specific category.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "categoryGuid", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - } - } - }, - "/atlas/v2/glossary/term": { - "post": { - "operationId": "Glossary_CreateTerm", - "description": "Create a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "glossaryTerm", - "in": "body", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termGuid}": { - "get": { - "operationId": "Glossary_GetTerm", - "description": "Get a specific glossary term by its GUID. ", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" - }, - "Glossary_GetTermWithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateTerm", - "description": "Update the given glossary term by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "glossaryTerm", - "in": "body", - "description": "The glossary term to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTerm", - "description": "Delete a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termGuid}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateTerm", - "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "partialUpdates", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" - } - } - } - }, - "/atlas/v2/glossary/terms": { - "post": { - "operationId": "Glossary_CreateTerms", - "description": "Create glossary terms in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "glossaryTerm", - "in": "body", - "description": "An array of glossary term definitions to be created in bulk.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { - "get": { - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - } - }, - "post": { - "operationId": "Glossary_AssignTermToEntities", - "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "relatedObjectIds", - "in": "body", - "description": "An array of related object IDs to which the term has to be associated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTermAssignmentFromEntities", - "description": "Delete the term assignment for the given list of related objects.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "relatedObjectIds", - "in": "body", - "description": "An array of related object IDs from which the term has to be dissociated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termGuid}/related": { - "get": { - "operationId": "Glossary_ListRelatedTerms", - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "termGuid", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "operationId": "Lineage_Get", - "description": "Get lineage info of the entity specified by GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" - } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Lineage_GetByUniqueAttribute", - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attr" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/relationship": { - "put": { - "operationId": "Relationship_Update", - "description": "Update an existing relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "relationship", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" - } - } - }, - "post": { - "operationId": "Relationship_Create", - "description": "Create a new relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "relationship", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - } - } - }, - "/atlas/v2/relationship/guid/{guid}": { - "get": { - "operationId": "Relationship_Get", - "description": "Get relationship information between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - }, - { - "name": "extendedInfo", - "in": "query", - "description": "Limits whether includes extended information.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - } - }, - "delete": { - "operationId": "Relationship_Delete", - "description": "Delete a relationship between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByGuid", - "description": "Get the businessMetadata definition for the given guid.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "businessMetadata guid", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByName", - "description": "Get the businessMetadata definition by it's name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "businessMetadata name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/guid/{guid}": { - "get": { - "operationId": "Type_GetClassificationDefByGuid", - "description": "Get the classification definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/name/{name}": { - "get": { - "operationId": "Type_GetClassificationDefByName", - "description": "Get the classification definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - } - } - }, - "/atlas/v2/types/entitydef/guid/{guid}": { - "get": { - "operationId": "Type_GetEntityDefByGuid", - "description": "Get the Entity definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/entitydef/name/{name}": { - "get": { - "operationId": "Type_GetEntityDefByName", - "description": "Get the entity definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByName": { - "$ref": "./examples/Type_GetEntityDefByName.json" - } - } - } - }, - "/atlas/v2/types/enumdef/guid/{guid}": { - "get": { - "operationId": "Type_GetEnumDefByGuid", - "description": "Get the enum definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/enumdef/name/{name}": { - "get": { - "operationId": "Type_GetEnumDefByName", - "description": "Get the enum definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/guid/{guid}": { - "get": { - "operationId": "Type_GetRelationshipDefByGuid", - "description": "Get the relationship definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/name/{name}": { - "get": { - "operationId": "Type_GetRelationshipDefByName", - "description": "Get the relationship definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } - } - } - }, - "/atlas/v2/types/structdef/guid/{guid}": { - "get": { - "operationId": "Type_GetStructDefByGuid", - "description": "Get the struct definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByGuid": { - "$ref": "./examples/Type_GetStructDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/structdef/name/{name}": { - "get": { - "operationId": "Type_GetStructDefByName", - "description": "Get the struct definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - } - } - }, - "/atlas/v2/types/typedef/guid/{guid}": { - "get": { - "operationId": "Type_GetByGuid", - "description": "Get the type definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - } - } - }, - "/atlas/v2/types/typedef/name/{name}": { - "get": { - "operationId": "Type_GetByName", - "description": "Get the type definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - } - }, - "delete": { - "operationId": "Type_Delete", - "description": "Delete API for type identified by its name.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" - } - } - } - }, - "/atlas/v2/types/typedefs": { - "get": { - "operationId": "Type_List", - "description": "List all type definitions in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "Typedef", - "modelAsString": true, - "values": [ - { - "name": "enum", - "value": "enum", - "description": "enum" - }, - { - "name": "entity", - "value": "entity", - "description": "entity" - }, - { - "name": "classification", - "value": "classification", - "description": "classification" - }, - { - "name": "relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "struct", - "value": "struct", - "description": "struct" - }, - { - "name": "term_template", - "value": "term_template", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - } - }, - "put": { - "operationId": "Type_BulkUpdate", - "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typesDef", - "in": "body", - "description": "A composite object that captures all type definition changes.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkUpdate": { - "$ref": "./examples/Type_BulkUpdate.json" - } - } - }, - "post": { - "operationId": "Type_BulkCreate", - "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typesDef", - "in": "body", - "description": "A composite wrapper object with corresponding lists of the type definition.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" - }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" - } - } - }, - "delete": { - "operationId": "Type_BulkDelete", - "description": "Delete API for all types in bulk.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "typesDef", - "in": "body", - "description": "A composite object that captures all types to be deleted", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - } - } - }, - "/atlas/v2/types/typedefs/headers": { - "get": { - "operationId": "Type_ListHeaders", - "description": "List all type definitions returned as a list of minimal information header.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "Typedef", - "modelAsString": true, - "values": [ - { - "name": "enum", - "value": "enum", - "description": "enum" - }, - { - "name": "entity", - "value": "entity", - "description": "entity" - }, - { - "name": "classification", - "value": "classification", - "description": "classification" - }, - { - "name": "relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "struct", - "value": "struct", - "description": "struct" - }, - { - "name": "term_template", - "value": "term_template", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasTypeDefHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - } - } - }, - "/entity/moveTo": { - "post": { - "operationId": "Entity_MoveEntitiesToCollection", - "description": "Move existing entities to the target collection.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to.", - "required": true, - "type": "string" - }, - { - "name": "moveEntitiesRequest", - "in": "body", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } - } - } - }, - "/lineage/{guid}/next": { - "get": { - "operationId": "Lineage_GetNextPage", - "description": "Return immediate next page lineage info about entity with pagination", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - } - } - }, - "/search/autocomplete": { - "post": { - "operationId": "Discovery_AutoComplete", - "description": "Get auto complete options.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "autoCompleteRequest", - "in": "body", - "description": "An object specifying the autocomplete criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/AutoCompleteRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AutoCompleteResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - } - } - }, - "/search/query": { - "post": { - "operationId": "Discovery_Query", - "description": "Get data using search.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "searchRequest", - "in": "body", - "description": "An object specifying the search criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/SearchRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/SearchResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" - }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" - }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" - }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_TermAssignment": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Type": { - "$ref": "./examples/Discovery_Query_Type.json" - } - } - } - }, - "/search/suggest": { - "post": { - "operationId": "Discovery_Suggest", - "description": "Get search suggestions by query criteria.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "suggestRequest", - "in": "body", - "description": "An object specifying the suggest criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/SuggestRequest" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/SuggestResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - } - } - }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "operationId": "Type_GetTermTemplateDefByGuid", - "description": "Get the term template definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - } - } - }, - "/types/termtemplatedef/name/{name}": { - "get": { - "operationId": "Type_GetTermTemplateDefByName", - "description": "Get the term template definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/DataMapApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The unique name of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" - } - } - } - } - }, - "definitions": { - "AADToken": { - "type": "object", - "description": "The Azure Active Directory OAuth2 Flow", - "properties": { - "type": { - "type": "string", - "description": "OAuth2 authentication", - "enum": [ - "oauth2" - ] - }, - "flows": { - "type": "array", - "description": "Supported OAuth2 flows", - "items": {} - } - }, - "required": [ - "type", - "flows" - ] - }, - "AndFilter": { - "type": "object", - "description": "And filter for search", - "properties": { - "and": { - "type": "array", - "description": "List of filters", - "items": { - "$ref": "#/definitions/SearchFilter" - }, - "x-ms-client-name": "andFilters", - "x-ms-identifiers": [] - } - }, - "required": [ - "and" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AndFilter" - }, - "ApiVersions": { - "type": "string", - "description": "Service API versions", - "enum": [ - "2023-09-01" - ], - "x-ms-enum": { - "name": "ApiVersions", - "modelAsString": true, - "values": [ - { - "name": "2023-09-01", - "value": "2023-09-01", - "description": "2023-09-01 service API version" - } - ] - } - }, - "AssetTypeFilter": { - "type": "object", - "description": "Asset type filter for search", - "properties": { - "assetType": { - "type": "string", - "description": "Asset type name" - } - }, - "required": [ - "assetType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AssetTypeFilter" - }, - "AtlasAttributeDef": { - "type": "object", - "description": "class that captures details of a struct-attribute.", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - } - } - }, - "AtlasBaseModelObject": { - "type": "object", - "description": "The base model object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - } - } - }, - "AtlasBaseTypeDef": { - "type": "object", - "description": "Base class that captures common-attributes for all types.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassification": { - "type": "object", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityGuid": { - "type": "string", - "description": "The GUID of the entity." - }, - "entityStatus": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "removePropagationsOnEntityDelete": { - "type": "boolean", - "description": "Determines if propagations will be removed on entity deletion." - }, - "validityPeriods": { - "type": "array", - "description": "An array of time boundaries indicating validity periods.", - "items": { - "$ref": "#/definitions/TimeBoundary" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassificationDef": { - "type": "object", - "description": "class that captures details of a classification-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - } - } - }, - "AtlasClassifications": { - "type": "object", - "description": "REST serialization friendly list.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "AtlasConstraintDef": { - "type": "object", - "description": "class that captures details of a constraint.", - "properties": { - "params": { - "type": "object", - "description": "The parameters of the constraint definition.", - "additionalProperties": {} - }, - "type": { - "type": "string", - "description": "The type of the constraint." - } - } - }, - "AtlasEntitiesWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entities": { - "type": "array", - "description": "An array of entities.", - "items": { - "$ref": "#/definitions/AtlasEntity" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntity": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "businessAttributes": { - "type": "object", - "description": "Business attributes", - "additionalProperties": {} - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "customAttributes": { - "type": "object", - "description": "Custom Attribute", - "additionalProperties": { - "type": "string" - } - }, - "guid": { - "type": "string", - "description": "The GUID of the entity." - }, - "homeId": { - "type": "string", - "description": "The home ID of the entity." - }, - "collectionId": { - "type": "string", - "description": "The collection ID of the entity.", - "readOnly": true - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers indicating the meanings of the entity.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship." - }, - "proxy": { - "type": "boolean", - "description": "Determines if there's a proxy." - }, - "relationshipAttributes": { - "type": "object", - "description": "The attributes of relationship.", - "additionalProperties": {} - }, - "status": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the entity." - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactBasic" - }, - "type": "array" - } - } - } - }, - "AtlasEntityDef": { - "type": "object", - "description": "class that captures details of a entity-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntityExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - } - } - }, - "AtlasEntityHeader": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "classificationNames": { - "type": "array", - "description": "An array of classification names.", - "items": { - "type": "string" - } - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "guid": { - "type": "string", - "description": "The GUID of the record." - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meaningNames": { - "type": "array", - "description": "An array of meanings.", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - } - } - }, - "AtlasEntityHeaders": { - "type": "object", - "description": "An instance of an entity header map.", - "properties": { - "guidHeaderMap": { - "type": "object", - "description": "The description of the guid header map,", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - } - } - }, - "AtlasEntityWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entity": { - "$ref": "#/definitions/AtlasEntity", - "description": "An instance of an entity - like hive_table, hive_database." - } - } - }, - "AtlasEnumDef": { - "type": "object", - "description": "class that captures details of an enum-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEnumElementDef": { - "type": "object", - "description": "class that captures details of an enum-element.", - "properties": { - "description": { - "type": "string", - "description": "The description of the enum element definition." - }, - "ordinal": { - "type": "integer", - "format": "int32", - "description": "The ordinal of the enum element definition." - }, - "value": { - "type": "string", - "description": "The value of the enum element definition." - } - } - }, - "AtlasExtraTypeDef": { - "type": "object", - "description": "Extra properties for a type.", - "properties": { - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n
    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossary": { - "type": "object", - "description": "The glossary object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - } - } - }, - "AtlasGlossaryBaseObject": { - "type": "object", - "description": "The glossary base object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - } - } - }, - "AtlasGlossaryCategory": { - "type": "object", - "description": "The glossary category.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "childrenCategories": { - "type": "array", - "description": "An array of children categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader", - "description": "The header of the related category." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossaryExtInfo": { - "type": "object", - "description": "The extended information of glossary.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - }, - "categoryInfo": { - "type": "object", - "description": "The glossary category information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "termInfo": { - "type": "object", - "description": "The glossary term information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - } - }, - "AtlasGlossaryHeader": { - "type": "object", - "description": "The glossary header with basic information.", - "properties": { - "displayText": { - "type": "string", - "description": "The display text." - }, - "glossaryGuid": { - "type": "string", - "description": "The GUID of the glossary." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasGlossaryTerm": { - "type": "object", - "description": "The glossary term.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "abbreviation": { - "type": "string", - "description": "The abbreviation of the term." - }, - "templateName": { - "type": "array", - "description": "The name of the template.", - "items": {} - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "antonyms": { - "type": "array", - "description": "An array of related term headers as antonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/TermStatus", - "description": "Status of the AtlasGlossaryTerm" - }, - "nickName": { - "type": "string", - "description": "The nick name of the term." - }, - "hierarchyInfo": { - "type": "array", - "description": "The hierarchy information of the term.", - "items": { - "$ref": "#/definitions/PurviewObjectId" - }, - "x-ms-identifiers": [] - }, - "resources": { - "type": "array", - "description": "An array of resource link for term", - "items": { - "$ref": "#/definitions/ResourceLink" - }, - "x-ms-identifiers": [] - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactBasic" - }, - "type": "array" - } - }, - "attributes": { - "type": "object", - "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "assignedEntities": { - "type": "array", - "description": "An array of related object IDs.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - }, - "categories": { - "type": "array", - "description": "An array of term categorization headers.", - "items": { - "$ref": "#/definitions/AtlasTermCategorizationHeader" - }, - "x-ms-identifiers": [] - }, - "classifies": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "examples": { - "type": "array", - "description": "An array of examples.", - "items": { - "type": "string" - } - }, - "isA": { - "type": "array", - "description": "An array of related term headers indicating the is-a relationship.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredTerms": { - "type": "array", - "description": "An array of preferred related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredToTerms": { - "type": "array", - "description": "An array of related term headers that are preferred to.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacedBy": { - "type": "array", - "description": "An array of related term headers that are replaced by.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacementTerms": { - "type": "array", - "description": "An array of related term headers for replacement.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "seeAlso": { - "type": "array", - "description": "An array of related term headers for see also.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "synonyms": { - "type": "array", - "description": "An array of related term headers as synonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translatedTerms": { - "type": "array", - "description": "An array of translated related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translationTerms": { - "type": "array", - "description": "An array of related term headers for translation.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the term." - }, - "validValues": { - "type": "array", - "description": "An array of related term headers as valid values.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "validValuesFor": { - "type": "array", - "description": "An array of related term headers as valid values for other records.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasLineageInfo": { - "type": "object", - "description": "The lineage information.", - "properties": { - "baseEntityGuid": { - "type": "string", - "description": "The GUID of the base entity." - }, - "guidEntityMap": { - "type": "object", - "description": "The GUID entity map.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "widthCounts": { - "type": "object", - "description": "The entity count in specific direction.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "lineageDepth": { - "type": "integer", - "format": "int32", - "description": "The depth of lineage." - }, - "lineageWidth": { - "type": "integer", - "format": "int32", - "description": "The width of lineage." - }, - "childrenCount": { - "type": "integer", - "format": "int32", - "description": "The number of children node." - }, - "lineageDirection": { - "$ref": "#/definitions/LineageDirection", - "description": "The enum of lineage direction." - }, - "parentRelations": { - "type": "array", - "description": "An array of parentRelations relations.", - "items": { - "$ref": "#/definitions/ParentRelation" - }, - "x-ms-identifiers": [] - }, - "relations": { - "type": "array", - "description": "An array of lineage relations.", - "items": { - "$ref": "#/definitions/LineageRelation" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasObjectId": { - "type": "object", - "description": "Reference to an object-instance of a type - like entity.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - } - } - }, - "AtlasRelatedCategoryHeader": { - "type": "object", - "description": "The header of the related category.", - "properties": { - "categoryGuid": { - "type": "string", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the category header." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "parentCategoryGuid": { - "type": "string", - "description": "The GUID of the parent category." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasRelatedObjectId": { - "type": "object", - "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "entityStatus": { - "$ref": "#/definitions/Status", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "relationshipType": { - "type": "string", - "description": "Relationship type" - }, - "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." - }, - "relationshipGuid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "relationshipStatus": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - } - } - }, - "AtlasRelatedTermHeader": { - "type": "object", - "description": "The header of the related term.", - "properties": { - "description": { - "type": "string", - "description": "The description of the related term." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "expression": { - "type": "string", - "description": "The expression of the term." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus", - "description": "The status of term relationship." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." - } - } - }, - "AtlasRelationship": { - "type": "object", - "description": "Atlas relationship instance.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "end1": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "end2": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "guid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "homeId": { - "type": "string", - "description": "The home ID of the relationship." - }, - "label": { - "type": "string", - "description": "The label of the relationship." - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship" - }, - "status": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the relationship." - } - } - }, - "AtlasRelationshipAttributeDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - }, - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." - }, - "relationshipTypeName": { - "type": "string", - "description": "The name of the relationship type." - } - } - }, - "AtlasRelationshipDef": { - "type": "object", - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

\nAs with\nother typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\n

\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\n

\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed.
\nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required
\nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\n

\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\n

\nEntityDef A might have attributes attr1,attr2,attr3\n
\nEntityDef B might have attributes attr4,attr5,attr6
\nRelationshipDef\nAtoB might define 2 ends
\n\n

\n   end1:  type A, name attr7\n   end2: \ntype B, name attr8
\n\n

\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7
\nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n

\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - } - } - }, - "AtlasRelationshipEndDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality", - "description": "single-valued attribute or multi-valued attribute." - }, - "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." - } - } - }, - "AtlasRelationshipWithExtInfo": { - "type": "object", - "description": "The relationship with extended information.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entity header.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "relationship": { - "$ref": "#/definitions/AtlasRelationship", - "description": "Atlas relationship instance." - } - } - }, - "AtlasStruct": { - "type": "object", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasStructDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTermAssignmentHeader": { - "type": "object", - "description": "The header for term assignment.", - "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", - "description": "The status of terms assignment." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." - } - } - }, - "AtlasTermAssignmentStatus": { - "type": "string", - "description": "Status for term assignment", - "enum": [ - "DISCOVERED", - "PROPOSED", - "IMPORTED", - "VALIDATED", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermAssignmentStatus", - "modelAsString": true, - "values": [ - { - "name": "DISCOVERED", - "value": "DISCOVERED", - "description": "The status is discovered." - }, - { - "name": "PROPOSED", - "value": "PROPOSED", - "description": "The status is proposed." - }, - { - "name": "IMPORTED", - "value": "IMPORTED", - "description": "The status is imported." - }, - { - "name": "VALIDATED", - "value": "VALIDATED", - "description": "The status is validated." - }, - { - "name": "DEPRECATED", - "value": "DEPRECATED", - "description": "The status is deprecated." - }, - { - "name": "OBSOLETE", - "value": "OBSOLETE", - "description": "The status is obsolete." - }, - { - "name": "OTHER", - "value": "OTHER", - "description": "Other status." - } - ] - } - }, - "AtlasTermCategorizationHeader": { - "type": "object", - "description": "The basic information for term categorization.", - "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", - "description": "The status of term relationship." - } - } - }, - "AtlasTermRelationshipStatus": { - "type": "string", - "description": "Status for atlas term relationship", - "enum": [ - "DRAFT", - "ACTIVE", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermRelationshipStatus", - "modelAsString": true, - "values": [ - { - "name": "DRAFT", - "value": "DRAFT", - "description": "draft" - }, - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "DEPRECATED", - "value": "DEPRECATED", - "description": "deprecated" - }, - { - "name": "OBSOLETE", - "value": "OBSOLETE", - "description": "obsolete" - }, - { - "name": "OTHER", - "value": "OTHER", - "description": "other" - } - ] - } - }, - "AtlasTypeDef": { - "type": "object", - "description": "The definitions of type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes\nof the entity types inherit the restriction
    • \n
  • Any classificationDef\nsubtypes inherit the parents entityTypes restrictions
    • \n
  • Any\nclassificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes
    • \n
  • An empty\nentityTypes list when there are no parent restrictions means there are no\nrestrictions
    • \n
  • An empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs
    • \n
", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the\nvalues.\n

\nASSOCIATION is a relationship with no containment.
\nCOMPOSITION\nand AGGREGATION are containment relationships.\n

\nThe difference being in the\nlifecycles of the container and its children. In the COMPOSITION case,\nthe\nchildren cannot exist without the container. For AGGREGATION, the life\ncycles\nof the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTypeDefHeader": { - "type": "object", - "description": "The basic information of the type definition.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - } - } - }, - "AtlasTypesDef": { - "type": "object", - "description": "The definitions of types.", - "properties": { - "businessMetadataDefs": { - "type": "array", - "description": "businessMetadataDefs", - "items": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - }, - "x-ms-identifiers": [] - }, - "classificationDefs": { - "type": "array", - "description": "An array of classification definitions.", - "items": { - "$ref": "#/definitions/AtlasClassificationDef" - }, - "x-ms-identifiers": [] - }, - "entityDefs": { - "type": "array", - "description": "An array of entity definitions.", - "items": { - "$ref": "#/definitions/AtlasEntityDef" - }, - "x-ms-identifiers": [] - }, - "enumDefs": { - "type": "array", - "description": "An array of enum definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumDef" - }, - "x-ms-identifiers": [] - }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" - }, - "x-ms-identifiers": [] - }, - "structDefs": { - "type": "array", - "description": "An array of struct definitions.", - "items": { - "$ref": "#/definitions/AtlasStructDef" - }, - "x-ms-identifiers": [] - }, - "termTemplateDefs": { - "type": "array", - "description": "An array of term template definitions.", - "items": { - "$ref": "#/definitions/TermTemplateDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AttributeFilter": { - "type": "object", - "description": "Attribute filter for search", - "properties": { - "attributeName": { - "type": "string", - "description": "Attribute name" - }, - "operator": { - "$ref": "#/definitions/SearchFilterOperator", - "description": "Operator" - }, - "attributeValue": { - "type": "string", - "description": "Attribute value" - } - }, - "required": [ - "attributeName", - "operator", - "attributeValue" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AttributeFilter" - }, - "AutoCompleteRequest": { - "type": "object", - "description": "The query of autocomplete request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the autocomplete request." - } - } - }, - "AutoCompleteResult": { - "type": "object", - "description": "The result of the autocomplete request.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/AutoCompleteResultValue" - }, - "x-ms-identifiers": [] - } - } - }, - "AutoCompleteResultValue": { - "type": "object", - "description": "The value item of the autocomplete suggest.", - "properties": { - "text": { - "type": "string", - "description": "The completed term or phrase." - }, - "queryPlusText": { - "type": "string", - "description": "The completed search query text." - } - } - }, - "Azure.Core.Foundations.Error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - }, - "x-ms-identifiers": [] - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "An object containing more specific information than the current object about the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "Azure.Core.Foundations.ErrorResponse": { - "type": "object", - "description": "A response containing error details.", - "properties": { - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "The error object." - } - }, - "required": [ - "error" - ] - }, - "Azure.Core.Foundations.InnerError": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "Inner error." - } - } - }, - "BulkImportResponse": { - "type": "object", - "description": "example", - "properties": { - "failedImportInfoList": { - "type": "array", - "description": "failed importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - }, - "successImportInfoList": { - "type": "array", - "description": "successful importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - } - } - }, - "BusinessAttributeUpdateBehavior": { - "type": "string", - "description": "Enum for business attribute update behavior", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - "Cardinality": { - "type": "string", - "description": "Cardinality", - "enum": [ - "SINGLE", - "LIST", - "SET" - ], - "x-ms-enum": { - "name": "Cardinality", - "modelAsString": true, - "values": [ - { - "name": "SINGLE", - "value": "SINGLE", - "description": "single" - }, - { - "name": "LIST", - "value": "LIST", - "description": "list" - }, - { - "name": "SET", - "value": "SET", - "description": "set" - } - ] - } - }, - "ClassificationAssociateRequest": { - "type": "object", - "description": "The request for classification association.", - "properties": { - "classification": { - "$ref": "#/definitions/AtlasClassification", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." - }, - "entityGuids": { - "type": "array", - "description": "The GUID of the entity.", - "items": { - "type": "string" - } - } - } - }, - "ClassificationFilter": { - "type": "object", - "description": "Classification type filter for search", - "properties": { - "classificationName": { - "type": "string", - "description": "Classification name" - }, - "includeSubClassifications": { - "type": "boolean", - "description": "Whether to include sub classifications" - } - }, - "required": [ - "classificationName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ClassificationFilter" - }, - "CollectionIdFilter": { - "type": "object", - "description": "Collection id filter for search", - "properties": { - "collectionId": { - "type": "string", - "description": "Collection id" - } - }, - "required": [ - "collectionId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "CollectionIdFilter" - }, - "ContactBasic": { - "type": "object", - "description": "ContactBasic", - "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." - } - } - }, - "ContactFilter": { - "type": "object", - "description": "Contact filter for search", - "properties": { - "contactType": { - "type": "string", - "description": "Contact type" - }, - "contactId": { - "type": "string", - "description": "Contact Id" - } - }, - "required": [ - "contactType", - "contactId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ContactFilter" - }, - "ContactSearchResultValue": { - "type": "object", - "description": "The contact in the search and suggest result.", - "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\nExpert or Steward for a glossary term." - } - } - }, - "CreateTimeFilter": { - "type": "object", - "description": "Create time filter for search", - "properties": { - "createTime": { - "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n} \nto represent the time filter" - } - }, - "required": [ - "createTime" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "CreateTimeFilter" - }, - "DateFormat": { - "type": "object", - "description": "The date format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "An array of available locales.", - "items": { - "type": "string" - } - }, - "calendar": { - "type": "number", - "format": "float", - "description": "Calendar" - }, - "dateInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "dateTimeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "instance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "lenient": { - "type": "boolean", - "description": "Determines the leniency of the date format." - }, - "numberFormat": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "timeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "timeZone": { - "$ref": "#/definitions/TimeZone", - "description": "The timezone information." - } - } - }, - "Direction": { - "type": "string", - "description": "Direction", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, - "DomainIdFilter": { - "type": "object", - "description": "Domain id filter for search", - "properties": { - "domainId": { - "type": "string", - "description": "Domain id" - } - }, - "required": [ - "domainId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "DomainIdFilter" - }, - "EntityMutationResponse": { - "type": "object", - "description": "The mutation response of entity.", - "properties": { - "guidAssignments": { - "type": "object", - "description": "A map of GUID assignments with entities.", - "additionalProperties": { - "type": "string" - } - }, - "mutatedEntities": { - "type": "object", - "description": "The entity headers of mutated entities.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - }, - "partialUpdatedEntities": { - "type": "array", - "description": "An array of entity headers that partially updated.", - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "ErrorResponse": { - "type": "object", - "description": "An error response from the service", - "properties": { - "requestId": { - "type": "string", - "description": "The request ID." - }, - "errorCode": { - "type": "string", - "description": "The error code." - }, - "errorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "ExistsFilter": { - "type": "object", - "description": "Exists filter for search", - "properties": { - "exists": { - "type": "string", - "description": "Field", - "x-ms-client-name": "field" - } - }, - "required": [ - "exists" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ExistsFilter" - }, - "FileExtensionFilter": { - "type": "object", - "description": "File extension filter for search", - "properties": { - "fileExtension": { - "type": "string", - "description": "File extension" - } - }, - "required": [ - "fileExtension" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "FileExtensionFilter" - }, - "GlossaryFilter": { - "type": "object", - "description": "Glossary filter for search", - "properties": { - "glossaryType": { - "type": "string", - "description": "Glossary type. Either AtlasGlossary or AtlasGlossaryType" - } - }, - "required": [ - "glossaryType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "GlossaryFilter" - }, - "IdFilter": { - "type": "object", - "description": "Id filter for search", - "properties": { - "id": { - "type": "string", - "description": "Id value" - } - }, - "required": [ - "id" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "IdFilter" - }, - "ImportInfo": { - "type": "object", - "description": "ImportInfo", - "properties": { - "childObjectName": { - "type": "string", - "description": "childObjectName" - }, - "importStatus": { - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" - }, - "parentObjectName": { - "type": "string", - "description": "parentObjectName" - }, - "remarks": { - "type": "string", - "description": "remarks" - } - } - }, - "ImportStatus": { - "type": "string", - "description": "Status for import", - "enum": [ - "SUCCESS", - "FAILED" - ], - "x-ms-enum": { - "name": "ImportStatus", - "modelAsString": true, - "values": [ - { - "name": "SUCCESS", - "value": "SUCCESS", - "description": "Success" - }, - { - "name": "FAILED", - "value": "FAILED", - "description": "Failed" - } - ] - } - }, - "LabelFilter": { - "type": "object", - "description": "Label filter for search", - "properties": { - "label": { - "type": "string", - "description": "Label" - }, - "includeSubLabels": { - "type": "boolean", - "description": "Whether to include sub labels" - } - }, - "required": [ - "label" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "LabelFilter" - }, - "LineageDirection": { - "type": "string", - "description": "Lineage direction", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - } - ] - } - }, - "LineageRelation": { - "type": "object", - "description": "The lineage relation with GUID of the from and to entity.", - "properties": { - "fromEntityId": { - "type": "string", - "description": "The GUID of from-entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "toEntityId": { - "type": "string", - "description": "The GUID of to-entity." - } - } - }, - "MoveEntitiesRequest": { - "type": "object", - "description": "MoveEntitiesRequest", - "properties": { - "entityGuids": { - "type": "array", - "description": "An array of entity guids to be moved to target collection.", - "items": { - "type": "string" - } - } - } - }, - "NameInPath": { - "type": "object", - "description": "The path for name.", - "properties": { - "name": { - "type": "string", - "description": "name", - "readOnly": true - } - }, - "required": [ - "name" - ] - }, - "NotFilter": { - "type": "object", - "description": "Not filter for search", - "properties": { - "not": { - "$ref": "#/definitions/SearchFilter", - "description": "Not filter", - "x-ms-client-name": "notFilters" - } - }, - "required": [ - "not" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "NotFilter" - }, - "NumberFormat": { - "type": "object", - "description": "The number format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "The number format.", - "items": { - "type": "string" - } - }, - "currency": { - "type": "string", - "description": "The currency." - }, - "currencyInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "groupingUsed": { - "type": "boolean", - "description": "Determines if grouping is used." - }, - "instance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "integerInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "maximumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of fraction digits." - }, - "maximumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of integer digits." - }, - "minimumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of fraction digits." - }, - "minimumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of integer digits." - }, - "numberInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "parseIntegerOnly": { - "type": "boolean", - "description": "Determines if only integer is parsed." - }, - "percentInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "roundingMode": { - "$ref": "#/definitions/RoundingMode", - "description": "The enum of rounding mode." - } - } - }, - "ObjectTypeFilter": { - "type": "object", - "description": "Label filter for search", - "properties": { - "objectType": { - "type": "string", - "description": "Object type" - } - }, - "required": [ - "objectType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ObjectTypeFilter" - }, - "OrFilter": { - "type": "object", - "description": "Or filter for search", - "properties": { - "or": { - "type": "array", - "description": "List of filters", - "items": { - "$ref": "#/definitions/SearchFilter" - }, - "x-ms-client-name": "orFilters", - "x-ms-identifiers": [] - } - }, - "required": [ - "or" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "OrFilter" - }, - "PList": { - "type": "object", - "description": "Paginated-list, for returning search results.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "ParentRelation": { - "type": "object", - "description": "The lineage parents relation with GUID of the parent entity and to child entity.", - "properties": { - "childEntityId": { - "type": "string", - "description": "The GUID of child entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "parentEntityId": { - "type": "string", - "description": "The GUID of parent entity." - } - } - }, - "PathFilter": { - "type": "object", - "description": "Path filter for search", - "properties": { - "path": { - "type": "string", - "description": "Path" - }, - "isParent": { - "type": "boolean", - "description": "Whether the path is parent path" - } - }, - "required": [ - "path" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "PathFilter" - }, - "PurviewObjectId": { - "type": "object", - "description": "PurviewObjectId", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "name": { - "type": "string", - "description": "Name" - }, - "displayText": { - "type": "string", - "description": "Display text" - }, - "itemPath": { - "type": "string", - "description": "Item path" - }, - "resourceId": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "type": "object", - "description": "Dictionary of ", - "additionalProperties": {} - } - } - }, - "RelationshipCategory": { - "type": "string", - "description": "Relationship Category", - "enum": [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "x-ms-enum": { - "name": "RelationshipCategory", - "modelAsString": true, - "values": [ - { - "name": "ASSOCIATION", - "value": "ASSOCIATION", - "description": "association" - }, - { - "name": "AGGREGATION", - "value": "AGGREGATION", - "description": "aggregation" - }, - { - "name": "COMPOSITION", - "value": "COMPOSITION", - "description": "composition" - } - ] - } - }, - "ResourceLink": { - "type": "object", - "description": "ResourceLink", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." - }, - "url": { - "type": "string", - "description": "web url. http or https" - } - } - }, - "RoundingMode": { - "type": "string", - "description": "Rounding Mode", - "enum": [ - "UP", - "DOWN", - "CEILING", - "FLOOR", - "HALF_UP", - "HALF_DOWN", - "HALF_EVEN", - "UNNECESSARY" - ], - "x-ms-enum": { - "name": "RoundingMode", - "modelAsString": true, - "values": [ - { - "name": "UP", - "value": "UP", - "description": "up" - }, - { - "name": "DOWN", - "value": "DOWN", - "description": "down" - }, - { - "name": "CEILING", - "value": "CEILING", - "description": "ceiling" - }, - { - "name": "FLOOR", - "value": "FLOOR", - "description": "floor" - }, - { - "name": "HALF_UP", - "value": "HALF_UP", - "description": "half up" - }, - { - "name": "HALF_DOWN", - "value": "HALF_DOWN", - "description": "half down" - }, - { - "name": "HALF_EVEN", - "value": "HALF_EVEN", - "description": "half even" - }, - { - "name": "UNNECESSARY", - "value": "UNNECESSARY", - "description": "unnecessary" - } - ] - } - }, - "ScanInfoFilter": { - "type": "object", - "description": "Scan info filter for search", - "properties": { - "dataSourceName": { - "type": "string", - "description": "Data source name" - }, - "scanName": { - "type": "string", - "description": "Scan name" - } - }, - "required": [ - "scanName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ScanInfoFilter" - }, - "SearchFacetItem": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "facet": { - "type": "string", - "description": "The name of the facet item." - }, - "sort": { - "description": "Any object" - } - } - }, - "SearchFacetItemValue": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "value": { - "type": "string", - "description": "The name of the facet item." - } - } - }, - "SearchFacetResultValue": { - "type": "object", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "properties": { - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "assetType": { - "type": "array", - "description": "Asset type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "classification": { - "type": "array", - "description": "Classification", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "term": { - "type": "array", - "description": "Term", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactId": { - "type": "array", - "description": "Contact id", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactType": { - "type": "array", - "description": "Contact type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "label": { - "type": "array", - "description": "Label", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "glossaryType": { - "type": "array", - "description": "Glossary type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termStatus": { - "type": "array", - "description": "Term status", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termTemplate": { - "type": "array", - "description": "Term template", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - } - } - }, - "SearchFilter": { - "type": "object", - "description": "Base model for search filter", - "properties": { - "kind": { - "type": "string", - "description": "Discriminator property for SearchFilter." - } - }, - "discriminator": "kind", - "required": [ - "kind" - ] - }, - "SearchFilterOperator": { - "type": "string", - "description": "Search filter operator", - "enum": [ - "eq", - "ne", - "gt", - "lt", - "ge", - "le", - "contains", - "startswith", - "prefix", - "timerange", - "exists" - ], - "x-ms-enum": { - "name": "SearchFilterOperator", - "modelAsString": true, - "values": [ - { - "name": "eq", - "value": "eq", - "description": "equal" - }, - { - "name": "ne", - "value": "ne", - "description": "not equal" - }, - { - "name": "gt", - "value": "gt", - "description": "greater than" - }, - { - "name": "lt", - "value": "lt", - "description": "less than" - }, - { - "name": "ge", - "value": "ge", - "description": "greater than or equal to" - }, - { - "name": "le", - "value": "le", - "description": "less than or equal to" - }, - { - "name": "contains", - "value": "contains", - "description": "contains" - }, - { - "name": "startswith", - "value": "startswith", - "description": "starts with" - }, - { - "name": "prefix", - "value": "prefix", - "description": "prefix" - }, - { - "name": "timerange", - "value": "timerange", - "description": "time range" - }, - { - "name": "exists", - "value": "exists", - "description": "exists" - } - ] - } - }, - "SearchHighlights": { - "type": "object", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "properties": { - "id": { - "type": "array", - "description": "Id", - "items": { - "type": "string" - } - }, - "qualifiedName": { - "type": "array", - "description": "Qualified name", - "items": { - "type": "string" - } - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "type": "string" - } - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "type": "string" - } - }, - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "type": "string" - } - } - } - }, - "SearchRequest": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchRequestTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, - "SearchRequestTaxonomySetting": { - "type": "object", - "description": "Taxonomy setting for search request", - "properties": { - "assetTypes": { - "type": "array", - "description": "Asset types", - "items": { - "type": "string" - } - }, - "facet": { - "$ref": "#/definitions/SearchFacetItem", - "description": "The content of a search facet result item." - } - } - }, - "SearchResult": { - "type": "object", - "description": "The result of the search result.", - "properties": { - "@search.count": { - "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single\npage).", - "x-ms-client-name": "searchCount" - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa.", - "x-ms-client-name": "searchCountApproximate" - }, - "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", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "x-ms-client-name": "searchFacets" - }, - "value": { - "type": "array", - "description": "Search result value", - "items": { - "$ref": "#/definitions/SearchResultValue" - } - } - } - }, - "SearchResultValue": { - "type": "object", - "description": "The value item of the search result.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.highlights": { - "$ref": "#/definitions/SearchHighlights", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "x-ms-client-name": "searchHighlights" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "SortType": { - "type": "string", - "description": "Type for sorting", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "SortType", - "modelAsString": true, - "values": [ - { - "name": "NONE", - "value": "NONE", - "description": "No sorting order" - }, - { - "name": "ASC", - "value": "ASC", - "description": "Use ascending order for sorting" - }, - { - "name": "DESC", - "value": "DESC", - "description": "Use descending order for sorting" - } - ] - } - }, - "Status": { - "type": "string", - "description": "Status - can be active or deleted", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true, - "values": [ - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "The status is active." - }, - { - "name": "DELETED", - "value": "DELETED", - "description": "The status is deleted." - } - ] - } - }, - "StatusAtlasRelationship": { - "type": "string", - "description": "Status for atlas relationship", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "StatusAtlasRelationship", - "modelAsString": true, - "values": [ - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "DELETED", - "value": "DELETED", - "description": "deleted" - } - ] - } - }, - "SuggestRequest": { - "type": "object", - "description": "The query of suggest request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the search." - } - } - }, - "SuggestResult": { - "type": "object", - "description": "The result item of the search suggest.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/SuggestResultValue" - } - } - } - }, - "SuggestResultValue": { - "type": "object", - "description": "The value item of the search suggest.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.text": { - "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", - "x-ms-client-name": "searchText" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "TermSearchResultValue": { - "type": "object", - "description": "The context.", - "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." - } - } - }, - "TermStatus": { - "type": "string", - "description": "Status for term", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true, - "values": [ - { - "name": "Draft", - "value": "Draft", - "description": "draft" - }, - { - "name": "Approved", - "value": "Approved", - "description": "approved" - }, - { - "name": "Alert", - "value": "Alert", - "description": "alert" - }, - { - "name": "Expired", - "value": "Expired", - "description": "expired" - } - ] - } - }, - "TermTemplateDef": { - "type": "object", - "description": "Term template definition for glossary term.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "TimeBoundary": { - "type": "object", - "description": "Captures time-boundary details", - "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." - } - } - }, - "TimeZone": { - "type": "object", - "description": "The timezone information.", - "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", - "description": "The timezone information." - }, - "displayName": { - "type": "string", - "description": "The display name of the timezone." - }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." - } - } - }, - "TypeCategory": { - "type": "string", - "description": "Type Category", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true, - "values": [ - { - "name": "PRIMITIVE", - "value": "PRIMITIVE", - "description": "primitive" - }, - { - "name": "OBJECT_ID_TYPE", - "value": "OBJECT_ID_TYPE", - "description": "object id type" - }, - { - "name": "ENUM", - "value": "ENUM", - "description": "enum" - }, - { - "name": "STRUCT", - "value": "STRUCT", - "description": "struct" - }, - { - "name": "CLASSIFICATION", - "value": "CLASSIFICATION", - "description": "classification" - }, - { - "name": "ENTITY", - "value": "ENTITY", - "description": "entity" - }, - { - "name": "ARRAY", - "value": "ARRAY", - "description": "array" - }, - { - "name": "MAP", - "value": "MAP", - "description": "map" - }, - { - "name": "RELATIONSHIP", - "value": "RELATIONSHIP", - "description": "relationship" - }, - { - "name": "TERM_TEMPLATE", - "value": "TERM_TEMPLATE", - "description": "term template" - } - ] - } - }, - "TypeFilter": { - "type": "object", - "description": "Type filter for search", - "properties": { - "typeName": { - "type": "string", - "description": "Type name" - }, - "includeSubTypes": { - "type": "boolean", - "description": "Whether to include sub types" - } - }, - "required": [ - "typeName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "TypeFilter" - }, - "Typedef": { - "type": "string", - "description": "Type", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "Typedef", - "modelAsString": true, - "values": [ - { - "name": "enum", - "value": "enum", - "description": "enum" - }, - { - "name": "entity", - "value": "entity", - "description": "entity" - }, - { - "name": "classification", - "value": "classification", - "description": "classification" - }, - { - "name": "relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "struct", - "value": "struct", - "description": "struct" - }, - { - "name": "term_template", - "value": "term_template", - "description": "term template" - } - ] - } - }, - "UpdateTimeFilter": { - "type": "object", - "description": "Update time filter for search", - "properties": { - "updateTime": { - "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n} \nto represent the time filter" - } - }, - "required": [ - "updateTime" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "UpdateTimeFilter" - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": false, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "DataMapApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - } - } -} From 2d1cd1b7ba8a4fd7d009c469936ce5fad054e45c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 28 Nov 2023 14:00:26 +0800 Subject: [PATCH 039/132] add @client --- .../routes.tsp | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index d8b2783bb98e..120d9e3ab205 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1,4 +1,7 @@ import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/http"; +import "@typespec/versioning"; import "@typespec/rest"; import "./models.tsp"; @@ -8,6 +11,7 @@ using TypeSpec.Versioning; using Azure.Core; using Azure.Core.Traits; using Azure.Core.Traits.Private; +using Azure.ClientGenerator.Core; namespace PurviewDataMap; @@ -90,6 +94,10 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr contentType: "multipart/form-data"; }>; +@client({ + name: "EntityClient", + service: PurviewDataMap, +}) interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -930,6 +938,10 @@ be changed to other unique attributes) >; } +@client({ + name: "GlossaryClient", + service: PurviewDataMap, +}) interface Glossary { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -1568,6 +1580,10 @@ to get pagination result. >; } +@client({ + name: "DiscoveryClient", + service: PurviewDataMap, +}) interface Discovery { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get data using search.") @@ -1609,6 +1625,10 @@ interface Discovery { >; } +@client({ + name: "LineageClient", + service: PurviewDataMap, +}) interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get lineage info of the entity specified by GUID.") @@ -1702,6 +1722,10 @@ be changed to other unique attributes) >; } +@client({ + name: "RelationshipClient", + service: PurviewDataMap, +}) interface Relationship { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a new relationship between entities.") @@ -1766,6 +1790,10 @@ be created. >; } +@client({ + name: "TypeClient", + service: PurviewDataMap, +}) interface `Type`{ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition for the given guid.") From 59bf3c1478e9554f4420067f185a794c29e09d9b Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 28 Nov 2023 14:15:57 +0800 Subject: [PATCH 040/132] Update routes.tsp --- .../routes.tsp | 35 ++++++------------- 1 file changed, 11 insertions(+), 24 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 120d9e3ab205..b259aeba3fd2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -12,6 +12,11 @@ using Azure.Core; using Azure.Core.Traits; using Azure.Core.Traits.Private; using Azure.ClientGenerator.Core; + +@client({ + name: "PurviewDataMapClient", + service: PurviewDataMap, +}) namespace PurviewDataMap; @@ -94,10 +99,7 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr contentType: "multipart/form-data"; }>; -@client({ - name: "EntityClient", - service: PurviewDataMap, -}) +@operationGroup interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -938,10 +940,7 @@ be changed to other unique attributes) >; } -@client({ - name: "GlossaryClient", - service: PurviewDataMap, -}) +@operationGroup interface Glossary { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -1580,10 +1579,7 @@ to get pagination result. >; } -@client({ - name: "DiscoveryClient", - service: PurviewDataMap, -}) +@operationGroup interface Discovery { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get data using search.") @@ -1625,10 +1621,7 @@ interface Discovery { >; } -@client({ - name: "LineageClient", - service: PurviewDataMap, -}) +@operationGroup interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get lineage info of the entity specified by GUID.") @@ -1722,10 +1715,7 @@ be changed to other unique attributes) >; } -@client({ - name: "RelationshipClient", - service: PurviewDataMap, -}) +@operationGroup interface Relationship { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a new relationship between entities.") @@ -1790,10 +1780,7 @@ be created. >; } -@client({ - name: "TypeClient", - service: PurviewDataMap, -}) +@operationGroup interface `Type`{ #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition for the given guid.") From cbc61f46603b3c45231e411b4b1a721319408db2 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 30 Nov 2023 16:53:34 +0800 Subject: [PATCH 041/132] Update routes.tsp --- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 9 --------- 1 file changed, 9 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index b259aeba3fd2..5b0d38324fa7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -36,15 +36,6 @@ model DataMapApiVersionParameter { apiVersion: string; } -@doc("The path for name.") -@resource("name") -model NameInPath { - @key("name") - @visibility("read") - @doc("name") - name: string; -} - model OkResponse { @statusCode status: 200; From bd0708c310280e40fe2f972d03b58cde3cd02c03 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Mon, 4 Dec 2023 11:21:25 +0800 Subject: [PATCH 042/132] Update tspconfig.yaml --- .../purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index f25aed928bf1..b9925df02b5c 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -13,7 +13,7 @@ options: examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/openapi.json" "@azure-tools/typespec-python": - package-dir: "azure-analytics-purview-datamap" + package-dir: "azure-purview-datamap" package-name: "{package-dir}" package-mode: dataplane "@azure-tools/typespec-csharp": From 09495a6e13999028b1cf2147bdb486ac3ba80c49 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Mon, 4 Dec 2023 14:35:12 +0800 Subject: [PATCH 043/132] Update main.tsp --- specification/purview/Azure.Analytics.Purview.DataMap/main.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 0eb3c286ff37..ac917e21f7b0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -40,6 +40,6 @@ model AADToken is OAuth2Auth<[ { type: OAuth2FlowType.implicit; authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; - scopes: ["user_impersonation"]; + scopes: ["https://purview.azure.net/.default"]; } ]>; \ No newline at end of file From aad337717c1d5a9ec3e72ec94aceaa02ea884b83 Mon Sep 17 00:00:00 2001 From: Yifan Zhou <78060542+yifan-zhou922@users.noreply.github.com> Date: Tue, 5 Dec 2023 10:22:25 +0800 Subject: [PATCH 044/132] Update specification/purview/Azure.Analytics.Purview.DataMap/main.tsp Co-authored-by: catalinaperalta --- specification/purview/Azure.Analytics.Purview.DataMap/main.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index ac917e21f7b0..db198aa39dfe 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -11,7 +11,7 @@ using TypeSpec.Versioning; }) @server( "{endpoint}/datamap/api", - "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service.", + "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments.", { endpoint: string, } From a693e849c6426fb4e145eca10e6df88ff759777e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 5 Dec 2023 13:26:06 +0800 Subject: [PATCH 045/132] updated --- .../models.tsp | 44 +- .../routes.tsp | 506 ++++++++++-------- .../tspconfig.yaml | 6 +- 3 files changed, 293 insertions(+), 263 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 33d42635e03f..c49af5f67139 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -231,12 +231,11 @@ model AtlasEntityWithExtInfo { entity?: AtlasEntity; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("An instance of an entity - like hive_table, hive_database.") model AtlasEntity { ...AtlasStruct; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" @doc("Business attributes") businessAttributes?: Record; @@ -277,7 +276,7 @@ model AtlasEntity { @doc("Determines if there's a proxy.") proxy?: boolean; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" @doc("The attributes of relationship.") relationshipAttributes?: Record; @@ -335,13 +334,12 @@ model TimeBoundary { timeZone?: string; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc(""" Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. """) model AtlasStruct { - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" @doc("The attributes of the struct.") attributes?: Record; @@ -370,7 +368,7 @@ model AtlasTermAssignmentHeader { expression?: string; @doc("The GUID of the relationship.") - relationGuid?: string; + relationGuid?: Azure.Core.uuid; @doc("The status of terms assignment.") status?: AtlasTermAssignmentStatus; @@ -379,7 +377,7 @@ model AtlasTermAssignmentHeader { steward?: string; @doc("The GUID of the term.") - termGuid?: string; + termGuid?: Azure.Core.uuid; } @doc("ContactBasic") @@ -426,7 +424,7 @@ model AtlasEntityHeader { displayText?: string; @doc("The GUID of the record.") - guid?: string; + guid: Azure.Core.uuid; @doc("Whether it is a shell entity") isIncomplete?: boolean; @@ -490,9 +488,9 @@ model AtlasClassifications { } #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Paginated-list, for returning search results.") model PList { + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object>" @doc("An array of objects.") list?: unknown[]; @@ -607,7 +605,7 @@ model AtlasRelatedTermHeader { termGuid?: string; } -#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" + @doc("The glossary base object.") model AtlasGlossaryBaseObject { ...AtlasBaseModelObject; @@ -627,6 +625,7 @@ model AtlasGlossaryBaseObject { @doc("The short version of description.") shortDescription?: string; + #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("ETag for concurrency control.") lastModifiedTS?: string; @@ -678,7 +677,7 @@ model AtlasGlossaryHeader { relationGuid?: string; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("The glossary term.") model AtlasGlossaryTerm { ...AtlasGlossaryBaseObject; @@ -686,6 +685,7 @@ model AtlasGlossaryTerm { @doc("The abbreviation of the term.") abbreviation?: string; + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The name of the template.") templateName?: unknown[]; @@ -791,7 +791,7 @@ model PurviewObjectId { @doc("Reference to an object-instance of a type - like entity.") model AtlasObjectId { @doc("The GUID of the object.") - guid?: string; + guid?: Azure.Core.uuid; @doc("The name of the type.") typeName?: string; @@ -836,7 +836,7 @@ AtlasEntity, AtlasClassification. relationshipAttributes?: AtlasStruct; @doc("The GUID of the relationship.") - relationshipGuid?: string; + relationshipGuid?: Azure.Core.uuid; @doc("The enum of relationship status.") relationshipStatus?: StatusAtlasRelationship; @@ -845,7 +845,7 @@ AtlasEntity, AtlasClassification. @doc("The basic information for term categorization.") model AtlasTermCategorizationHeader { @doc("The GUID of the category.") - categoryGuid?: string; + categoryGuid?: Azure.Core.uuid; @doc("The description of the record.") description?: string; @@ -854,7 +854,7 @@ model AtlasTermCategorizationHeader { displayText?: string; @doc("The GUID of the relationship.") - relationGuid?: string; + relationGuid?: Azure.Core.uuid; @doc("The status of term relationship.") status?: AtlasTermRelationshipStatus; @@ -871,7 +871,7 @@ model AtlasGlossaryExtInfo { termInfo?: Record; } -#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The search query of advanced search request.") model SearchRequest { @doc("The keywords applied to all searchable fields.") @@ -893,6 +893,7 @@ batch, and will return new token in each response unless there's no more data. @doc("The sort order of search results, can specify multiple fields.") orderby?: unknown[]; + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The filter for the search. See examples for the usage of supported filters.") filter?: unknown; @@ -903,7 +904,6 @@ batch, and will return new token in each response unless there's no more data. taxonomySetting?: SearchRequestTaxonomySetting; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The content of a search facet result item.") model SearchFacetItem { @@ -1136,7 +1136,7 @@ Expert or Steward for a glossary term. contactType?: string; } -#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The query of suggest request.") model SuggestRequest { @doc(""" @@ -1154,7 +1154,7 @@ must be a number between 1 and 100. limit?: int32; @doc("The filter for the search.") - filter?: unknown; + filter?: SearchFilter; } @doc("The result item of the search suggest.") @@ -1246,7 +1246,6 @@ AtlasGlossaryCategory. longDescription?: string; } -#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The query of autocomplete request.") model AutoCompleteRequest { @doc(""" @@ -1262,7 +1261,7 @@ The value must be a number between 1 and 100. limit?: int32; @doc("The filter for the autocomplete request.") - filter?: unknown; + filter?: SearchFilter; } @doc("The result of the autocomplete request.") @@ -1280,7 +1279,6 @@ model AutoCompleteResultValue { queryPlusText?: string; } -#suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("The lineage information.") model AtlasLineageInfo { @doc("The GUID of the base entity.") @@ -1289,7 +1287,7 @@ model AtlasLineageInfo { @doc("The GUID entity map.") guidEntityMap?: Record; - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Record to model Map" @doc("The entity count in specific direction.") widthCounts?: Record>; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 5b0d38324fa7..678d542c06b9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -19,23 +19,6 @@ using Azure.ClientGenerator.Core; }) namespace PurviewDataMap; - -@doc("The ApiVersion query parameter.") -model ApiVersionParameter { - @query("api-version") - @minLength(1) - @doc("The API version to use for this operation.") - apiVersion?: string; -} - -@doc("The ApiVersion query parameter for DataMap service.") -model DataMapApiVersionParameter { - @query("api-version") - @minLength(1) - @doc("The API version to use for this operation.") - apiVersion: string; -} - model OkResponse { @statusCode status: 200; @@ -43,47 +26,18 @@ model OkResponse { data: T; } -@doc("Operation for Atlas service") -op AtlasBaseOperation< - TParams extends TypeSpec.Reflection.Model, - TResponse, - Traits extends TypeSpec.Reflection.Model = {}, - TErrorResponse = ErrorResponse ->( - ...TraitProperties< - Traits & VersionParameterTrait, - TraitLocation.ApiVersionParameter - >, - ...TParams, -): TResponse | TErrorResponse; - - -@doc("Operation for DataMap service") -op DataMapBaseOperation< - TParams extends TypeSpec.Reflection.Model, - TResponse, - Traits extends TypeSpec.Reflection.Model = {}, - TErrorResponse = ErrorResponse ->( - ...TraitProperties< - Traits & VersionParameterTrait, - TraitLocation.ApiVersionParameter - >, - ...TParams, -): TResponse | TErrorResponse; - op AtlasImportOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, Traits extends TypeSpec.Reflection.Model = {}, TraitContexts extends TraitContext = TraitContext.Undefined -> is AtlasBaseOperation< +> is Azure.Core.Foundations.Operation< TParams & TraitProperties, TResponse & TraitProperties, -Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId +Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, +ErrorResponse >; -//alias DataMapResourceOperations = Azure.Core.ResourceOperations; alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ @doc("The content type for the operation. Always multipart/form-data for this operation.") @header("content-type") @@ -104,7 +58,7 @@ For each contact type, the maximum number of contacts is 20. """) @route("/atlas/v2/entity") @post - createOrUpdate is AtlasBaseOperation< + createOrUpdate is Azure.Core.Foundations.Operation< { @doc(""" Used to define the update behavior for business attributes when updating @@ -124,7 +78,9 @@ need to move an entity to another collection. @body entity: AtlasEntityWithExtInfo; }, - EntityMutationResponse + EntityMutationResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -132,7 +88,7 @@ need to move an entity to another collection. @doc("List entities in bulk identified by its GUIDs.") @route("/atlas/v2/entity/bulk") @get - listByGuids is AtlasBaseOperation< + listByGuids is Azure.Core.Foundations.Operation< { @doc("An array of GUIDs of entities to list.") @query({format: "multi"}) @@ -146,7 +102,9 @@ need to move an entity to another collection. @query ignoreRelationships?: boolean; }, - AtlasEntitiesWithExtInfo + AtlasEntitiesWithExtInfo, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -162,7 +120,7 @@ is 20. """) @route("/atlas/v2/entity/bulk") @post - bulkCreateOrUpdate is AtlasBaseOperation< + bulkCreateOrUpdate is Azure.Core.Foundations.Operation< { @doc(""" The collection where entities will be moved to. Only specify a value if you @@ -182,7 +140,9 @@ entities. @body entities: AtlasEntitiesWithExtInfo; }, - EntityMutationResponse + EntityMutationResponse, + {}, + ErrorResponse >; @@ -194,33 +154,35 @@ attributes. """) @route("/atlas/v2/entity/bulk") @delete - bulkDelete is AtlasBaseOperation< + bulkDelete is Azure.Core.Foundations.Operation< { @doc("An array of GUIDs of entities to delete.") @query({format: "multi"}) guid: string[]; }, - EntityMutationResponse + EntityMutationResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is AtlasBaseOperation< + addClassification is Azure.Core.Foundations.Operation< { @doc("The request to associate a classification to multiple entities.") @body request: ClassificationAssociateRequest; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get complete definition of an entity given its GUID.") @route("/atlas/v2/entity/guid/{guid}") @get - get is AtlasBaseOperation< + get is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -234,7 +196,7 @@ attributes. @query ignoreRelationships?: boolean; }, - AtlasEntityWithExtInfo + AtlasEntityWithExtInfo,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -249,7 +211,7 @@ possible. """) @route("/atlas/v2/entity/guid/{guid}") @put - partialUpdateAttributeByGuid is AtlasBaseOperation< + partialUpdateAttributeByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -264,27 +226,27 @@ possible. @body body: unknown; }, - EntityMutationResponse + EntityMutationResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete an entity identified by its GUID.") @route("/atlas/v2/entity/guid/{guid}") @delete - delete is AtlasBaseOperation< + delete is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path guid: string; }, - EntityMutationResponse + EntityMutationResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get classification for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @get - getClassification is AtlasBaseOperation< + getClassification is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -294,14 +256,14 @@ possible. @path classificationName: string; }, - AtlasClassification + AtlasClassification,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a given classification from an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @delete - removeClassification is AtlasBaseOperation< + removeClassification is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -311,20 +273,20 @@ possible. @path classificationName: string; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List classifications for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @get - getClassifications is AtlasBaseOperation< + getClassifications is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path guid: string; }, - AtlasClassifications + AtlasClassifications,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -332,7 +294,7 @@ possible. @doc("Add classifications to an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @post - addClassifications is AtlasBaseOperation< + addClassifications is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -342,7 +304,7 @@ possible. @body classifications: AtlasClassification[]; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -350,7 +312,7 @@ possible. @doc("Update classifications to an existing entity represented by a guid.") @route("/atlas/v2/entity/guid/{guid}/classifications") @put - updateClassifications is AtlasBaseOperation< + updateClassifications is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -360,7 +322,7 @@ possible. @body classifications: AtlasClassification[]; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -382,7 +344,7 @@ GET """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @get - getByUniqueAttributes is AtlasBaseOperation< + getByUniqueAttributes is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -403,7 +365,7 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - AtlasEntityWithExtInfo + AtlasEntityWithExtInfo,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -427,7 +389,7 @@ PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @put - partialUpdateByUniqueAttributes is AtlasBaseOperation< + partialUpdateByUniqueAttributes is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -444,7 +406,9 @@ be changed to other unique attributes) @body atlasEntityWithExtInfo: AtlasEntityWithExtInfo; }, - EntityMutationResponse + EntityMutationResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -464,7 +428,7 @@ DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @delete - deleteByUniqueAttribute is AtlasBaseOperation< + deleteByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -477,7 +441,9 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - EntityMutationResponse + EntityMutationResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -487,7 +453,7 @@ attributes. """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") @delete - removeClassificationByUniqueAttribute is AtlasBaseOperation< + removeClassificationByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -504,7 +470,9 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -512,7 +480,7 @@ be changed to other unique attributes) @doc("Add classification to the entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @post - addClassificationsByUniqueAttribute is AtlasBaseOperation< + addClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -529,7 +497,9 @@ be changed to other unique attributes) @body atlasClassificationArray: AtlasClassification[]; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -537,7 +507,7 @@ be changed to other unique attributes) @doc("Update classification on an entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @put - updateClassificationsByUniqueAttribute is AtlasBaseOperation< + updateClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -554,20 +524,24 @@ be changed to other unique attributes) @body atlasClassificationArray: AtlasClassification[]; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Set classifications on entities in bulk.") @route("/atlas/v2/entity/bulk/setClassifications") @post - bulkSetClassifications is AtlasBaseOperation< + bulkSetClassifications is Azure.Core.Foundations.Operation< { @doc("Atlas entity headers.") @body entityHeaders: AtlasEntityHeaders; }, - OkResponse + OkResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -594,7 +568,7 @@ at least one unique attribute must be provided. """) @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") @get - listByUniqueAttributes is AtlasBaseOperation< + listByUniqueAttributes is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -616,27 +590,31 @@ example. qualifiedName can be changed to other unique attributes) @query `attr_N:qualifiedName`?: string; }, - AtlasEntitiesWithExtInfo + AtlasEntitiesWithExtInfo, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get entity header given its GUID.") @route("/atlas/v2/entity/guid/{guid}/header") @get - getHeader is AtlasBaseOperation< + getHeader is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path guid: string; }, - AtlasEntityHeader + AtlasEntityHeader, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Remove business metadata from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @delete - removeBusinessMetadata is AtlasBaseOperation< + removeBusinessMetadata is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -646,14 +624,16 @@ example. qualifiedName can be changed to other unique attributes) @doc("Business metadata payload") @body businessMetadata: Record>; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Add business metadata to an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @post - addOrUpdateBusinessMetadata is AtlasBaseOperation< + addOrUpdateBusinessMetadata is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -669,7 +649,9 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @body businessMetadata: Record>; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @@ -677,7 +659,7 @@ default is false. @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @delete - removeBusinessMetadataAttributes is AtlasBaseOperation< + removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< { @doc("BusinessMetadata name") @path @@ -691,7 +673,9 @@ default is false. @doc("Business metadata attribute payload") @body businessMetadataAttributes: Record; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" @@ -699,7 +683,7 @@ default is false. @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") @post - addOrUpdateBusinessMetadataAttributes is AtlasBaseOperation< + addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< { @doc("BusinessMetadata name") @path @@ -712,7 +696,9 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @body businessMetadataAttributes: Record; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -743,7 +729,7 @@ default is false. @doc("Delete given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @delete - removeLabels is AtlasBaseOperation< + removeLabels is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -753,7 +739,9 @@ default is false. @body body: string[]; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -761,7 +749,7 @@ default is false. @doc("Set labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @post - setLabels is AtlasBaseOperation< + setLabels is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -771,7 +759,9 @@ default is false. @body body: string[]; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -779,7 +769,7 @@ default is false. @doc("Add given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @put - addLabel is AtlasBaseOperation< + addLabel is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -789,7 +779,9 @@ default is false. @body body: string[]; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -811,7 +803,7 @@ this: DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @delete - removeLabelsByUniqueAttribute is AtlasBaseOperation< + removeLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -828,7 +820,9 @@ be changed to other unique attributes) @body body: string[]; }, - void + void, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -852,7 +846,7 @@ request would look something like this: POST """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @post - setLabelsByUniqueAttribute is AtlasBaseOperation< + setLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -869,7 +863,7 @@ be changed to other unique attributes) @body body: string[]; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -893,7 +887,7 @@ request would look something like this: PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @put - addLabelsByUniqueAttribute is AtlasBaseOperation< + addLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -910,14 +904,14 @@ be changed to other unique attributes) @body body: string[]; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Move existing entities to the target collection.") @route("/entity/moveTo") @post - moveEntitiesToCollection is DataMapBaseOperation< + moveEntitiesToCollection is Azure.Core.Foundations.Operation< { @doc("The collection where entities will be moved to.") @query @@ -927,7 +921,7 @@ be changed to other unique attributes) @body moveEntitiesRequest: MoveEntitiesRequest; }, - EntityMutationResponse + EntityMutationResponse,{},ErrorResponse >; } @@ -946,7 +940,7 @@ and """) @route("/atlas/v2/glossary") @get - list is AtlasBaseOperation< + list is Azure.Core.Foundations.Operation< { @doc("The page size - by default there is no paging.") @query @@ -964,7 +958,9 @@ and @query ignoreTermsAndCategories?: boolean; }, - OkResponse + OkResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -972,7 +968,7 @@ and @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is AtlasBaseOperation< + create is Azure.Core.Foundations.Operation< { @doc(""" Glossary definition, terms & categories can be anchored to a glossary. @@ -982,7 +978,9 @@ the anchor attribute when creating the Term/Category. @body atlasGlossary: AtlasGlossary; }, - AtlasGlossary + AtlasGlossary, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -990,20 +988,22 @@ the anchor attribute when creating the Term/Category. @doc("Create glossary category in bulk.") @route("/atlas/v2/glossary/categories") @post - createCategories is AtlasBaseOperation< + createCategories is Azure.Core.Foundations.Operation< { @doc("An array of glossary category definitions to be created.") @body glossaryCategory: AtlasGlossaryCategory[]; }, - OkResponse + OkResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a glossary category.") @route("/atlas/v2/glossary/category") @post - createCategory is AtlasBaseOperation< + createCategory is Azure.Core.Foundations.Operation< { @doc(""" The glossary category definition. A category must be anchored to a Glossary @@ -1014,27 +1014,31 @@ can also be defined during creation. @body glossaryCategory: AtlasGlossaryCategory; }, - AtlasGlossaryCategory + AtlasGlossaryCategory, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get specific glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @get - getCategory is AtlasBaseOperation< + getCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path categoryGuid: string; }, - AtlasGlossaryCategory + AtlasGlossaryCategory, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryGuid}") @put - updateCategory is AtlasBaseOperation< + updateCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path @@ -1044,20 +1048,24 @@ can also be defined during creation. @body glossaryCategory: AtlasGlossaryCategory; }, - AtlasGlossaryCategory + AtlasGlossaryCategory, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a glossary category.") @route("/atlas/v2/glossary/category/{categoryGuid}") @delete - deleteCategory is AtlasBaseOperation< + deleteCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path categoryGuid: string; }, - void + void, + {}, + ErrorResponse >; @@ -1069,7 +1077,7 @@ updating shortDescription and longDescription for category. """) @route("/atlas/v2/glossary/category/{categoryGuid}/partial") @put - partialUpdateCategory is AtlasBaseOperation< + partialUpdateCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path @@ -1082,7 +1090,9 @@ values for partial update. @body partialUpdates: unknown; }, - AtlasGlossaryCategory + AtlasGlossaryCategory, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1092,7 +1102,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/category/{categoryGuid}/related") @get - listRelatedCategories is AtlasBaseOperation< + listRelatedCategories is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path @@ -1110,14 +1120,16 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - OkResponse> + OkResponse>, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get all terms associated with the specific category.") @route("/atlas/v2/glossary/category/{categoryGuid}/terms") @get - listCategoryTerms is AtlasBaseOperation< + listCategoryTerms is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path @@ -1135,14 +1147,16 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - OkResponse + OkResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a glossary term.") @route("/atlas/v2/glossary/term") @post - createTerm is AtlasBaseOperation< + createTerm is Azure.Core.Foundations.Operation< { @doc("Whether include term hierarchy") @query @@ -1156,27 +1170,27 @@ Optionally it can be categorized as well. @body glossaryTerm: AtlasGlossaryTerm; }, - AtlasGlossaryTerm + AtlasGlossaryTerm,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get a specific glossary term by its GUID. ") @route("/atlas/v2/glossary/term/{termGuid}") @get - getTerm is AtlasBaseOperation< + getTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path termGuid: string; }, - AtlasGlossaryTerm + AtlasGlossaryTerm,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary term by its GUID.") @route("/atlas/v2/glossary/term/{termGuid}") @put - updateTerm is AtlasBaseOperation< + updateTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path @@ -1190,20 +1204,20 @@ Optionally it can be categorized as well. @body glossaryTerm: AtlasGlossaryTerm; }, - AtlasGlossaryTerm + AtlasGlossaryTerm,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a glossary term.") @route("/atlas/v2/glossary/term/{termGuid}") @delete - deleteTerm is AtlasBaseOperation< + deleteTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path termGuid: string; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1214,7 +1228,7 @@ shortDescription, longDescription, abbreviation, usage and status for term. """) @route("/atlas/v2/glossary/term/{termGuid}/partial") @put - partialUpdateTerm is AtlasBaseOperation< + partialUpdateTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path @@ -1231,7 +1245,7 @@ values to be updated. @body partialUpdates: unknown; }, - AtlasGlossaryTerm + AtlasGlossaryTerm,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1239,7 +1253,7 @@ values to be updated. @doc("Create glossary terms in bulk.") @route("/atlas/v2/glossary/terms") @post - createTerms is AtlasBaseOperation< + createTerms is Azure.Core.Foundations.Operation< { @doc("Whether include term hierarchy") @query @@ -1249,7 +1263,7 @@ values to be updated. @body glossaryTerm: AtlasGlossaryTerm[]; }, - OkResponse + OkResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1259,7 +1273,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @get - listEntitiesAssignedWithTerm is AtlasBaseOperation< + listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path @@ -1277,7 +1291,7 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse + OkResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1292,7 +1306,7 @@ is an alternative to assign a term to multiple entities. """) @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @post - assignTermToEntities is AtlasBaseOperation< + assignTermToEntities is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path @@ -1302,7 +1316,7 @@ is an alternative to assign a term to multiple entities. @body relatedObjectIds: AtlasRelatedObjectId[]; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1310,7 +1324,7 @@ is an alternative to assign a term to multiple entities. @doc("Delete the term assignment for the given list of related objects.") @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") @delete - deleteTermAssignmentFromEntities is AtlasBaseOperation< + deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path @@ -1320,7 +1334,7 @@ is an alternative to assign a term to multiple entities. @body relatedObjectIds: AtlasRelatedObjectId[]; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1330,7 +1344,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/terms/{termGuid}/related") @get - listRelatedTerms is AtlasBaseOperation< + listRelatedTerms is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path @@ -1348,27 +1362,27 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - OkResponse> + OkResponse>,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get a specific Glossary by its GUID.") @route("/atlas/v2/glossary/{glossaryGuid}") @get - get is AtlasBaseOperation< + get is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path glossaryGuid: string; }, - AtlasGlossary + AtlasGlossary,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary.") @route("/atlas/v2/glossary/{glossaryGuid}") @put - update is AtlasBaseOperation< + update is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path @@ -1382,7 +1396,7 @@ parameters are currently not being enabled and won't work even they are passed. @body updatedGlossary: AtlasGlossary; }, - AtlasGlossary + AtlasGlossary,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1392,13 +1406,13 @@ separate delete terms and categories. """) @route("/atlas/v2/glossary/{glossaryGuid}") @delete - delete is AtlasBaseOperation< + delete is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path glossaryGuid: string; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1408,7 +1422,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories") @get - listCategories is AtlasBaseOperation< + listCategories is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path @@ -1426,7 +1440,7 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse + OkResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1436,7 +1450,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") @get - listCategoriesHeaders is AtlasBaseOperation< + listCategoriesHeaders is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path @@ -1454,7 +1468,7 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse + OkResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1470,13 +1484,13 @@ GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. """) @route("/atlas/v2/glossary/{glossaryGuid}/detailed") @get - getDetailed is AtlasBaseOperation< + getDetailed is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path glossaryGuid: string; }, - AtlasGlossaryExtInfo + AtlasGlossaryExtInfo,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1493,7 +1507,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. """) @route("/atlas/v2/glossary/{glossaryGuid}/partial") @put - partialUpdate is AtlasBaseOperation< + partialUpdate is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path @@ -1510,7 +1524,7 @@ values. @body partialUpdates: unknown; }, - AtlasGlossary + AtlasGlossary,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1520,7 +1534,7 @@ pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms") @get - listTerms is AtlasBaseOperation< + listTerms is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path @@ -1538,7 +1552,7 @@ pagination result. @query sort?: string; }, - OkResponse + OkResponse,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1548,7 +1562,7 @@ to get pagination result. """) @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") @get - listTermHeaders is AtlasBaseOperation< + listTermHeaders is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path @@ -1566,7 +1580,9 @@ to get pagination result. @query sort?: string; }, - OkResponse + OkResponse, + {}, + ErrorResponse >; } @@ -1576,39 +1592,43 @@ interface Discovery { @doc("Get data using search.") @route("/search/query") @post - query is DataMapBaseOperation< + query is Azure.Core.Foundations.Operation< { @doc("An object specifying the search criteria.") @body searchRequest: SearchRequest; }, - SearchResult + SearchResult, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get search suggestions by query criteria.") @route("/search/suggest") @post - suggest is DataMapBaseOperation< + suggest is Azure.Core.Foundations.Operation< { @doc("An object specifying the suggest criteria.") @body suggestRequest: SuggestRequest; }, - SuggestResult + SuggestResult, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get auto complete options.") @route("/search/autocomplete") @post - autoComplete is DataMapBaseOperation< + autoComplete is Azure.Core.Foundations.Operation< { @doc("An object specifying the autocomplete criteria.") @body autoCompleteRequest: AutoCompleteRequest; }, - AutoCompleteResult + AutoCompleteResult,{},ErrorResponse >; } @@ -1618,7 +1638,7 @@ interface Lineage { @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get - get is AtlasBaseOperation< + get is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -1632,14 +1652,14 @@ interface Lineage { @query direction: Direction; }, - AtlasLineageInfo + AtlasLineageInfo,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Return immediate next page lineage info about entity with pagination") @route("/lineage/{guid}/next/") @get - getNextPage is DataMapBaseOperation< + getNextPage is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path @@ -1657,7 +1677,9 @@ interface Lineage { @query limit?: int32; }, - AtlasLineageInfo + AtlasLineageInfo, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1681,7 +1703,7 @@ GET """) @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") @get - getByUniqueAttribute is AtlasBaseOperation< + getByUniqueAttribute is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path @@ -1702,7 +1724,7 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - AtlasLineageInfo + AtlasLineageInfo,{},ErrorResponse >; } @@ -1712,7 +1734,7 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is AtlasBaseOperation< + create is Azure.Core.Foundations.Operation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1721,14 +1743,14 @@ be created. @body relationship: AtlasRelationship; }, - AtlasRelationship + AtlasRelationship,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is AtlasBaseOperation< + update is Azure.Core.Foundations.Operation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1737,14 +1759,14 @@ be created. @body relationship: AtlasRelationship; }, - AtlasRelationship + AtlasRelationship,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get relationship information between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @get - get is AtlasBaseOperation< + get is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the relationship.") @path @@ -1754,20 +1776,20 @@ be created. @query extendedInfo?: boolean; }, - AtlasRelationshipWithExtInfo + AtlasRelationshipWithExtInfo,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a relationship between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @delete - delete is AtlasBaseOperation< + delete is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the relationship.") @path guid: string; }, - void + void,{},ErrorResponse >; } @@ -1777,202 +1799,206 @@ interface `Type`{ @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get - getBusinessMetadataDefByGuid is AtlasBaseOperation< + getBusinessMetadataDefByGuid is Azure.Core.Foundations.Operation< { @doc("businessMetadata guid") @path guid: string; }, - AtlasBusinessMetadataDef + AtlasBusinessMetadataDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition by it's name (unique).") @route("/atlas/v2/types/businessmetadatadef/name/{name}") @get - getBusinessMetadataDefByName is AtlasBaseOperation< + getBusinessMetadataDefByName is Azure.Core.Foundations.Operation< { @doc("businessMetadata name") @path name: string; }, - AtlasBusinessMetadataDef + AtlasBusinessMetadataDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the classification definition for the given GUID.") @route("/atlas/v2/types/classificationdef/guid/{guid}") @get - getClassificationDefByGuid is AtlasBaseOperation< + getClassificationDefByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the classification.") @path guid: string; }, - AtlasClassificationDef + AtlasClassificationDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the classification definition by its name (unique).") @route("/atlas/v2/types/classificationdef/name/{name}") @get - getClassificationDefByName is AtlasBaseOperation< + getClassificationDefByName is Azure.Core.Foundations.Operation< { @doc("The name of the classification.") @path name: string; }, - AtlasClassificationDef + AtlasClassificationDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the Entity definition for the given GUID.") @route("/atlas/v2/types/entitydef/guid/{guid}") @get - getEntityDefByGuid is AtlasBaseOperation< + getEntityDefByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the entity.") @path guid: string; }, - AtlasEntityDef + AtlasEntityDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the entity definition by its name (unique).") @route("/atlas/v2/types/entitydef/name/{name}") @get - getEntityDefByName is AtlasBaseOperation< + getEntityDefByName is Azure.Core.Foundations.Operation< { @doc("The name of the entity.") @path name: string; }, - AtlasEntityDef + AtlasEntityDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the enum definition for the given GUID.") @route("/atlas/v2/types/enumdef/guid/{guid}") @get - getEnumDefByGuid is AtlasBaseOperation< + getEnumDefByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the enum.") @path guid: string; }, - AtlasEnumDef + AtlasEnumDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the enum definition by its name (unique).") @route("/atlas/v2/types/enumdef/name/{name}") @get - getEnumDefByName is AtlasBaseOperation< + getEnumDefByName is Azure.Core.Foundations.Operation< { @doc("The name of the enum.") @path name: string; }, - AtlasEnumDef + AtlasEnumDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the relationship definition for the given GUID.") @route("/atlas/v2/types/relationshipdef/guid/{guid}") @get - getRelationshipDefByGuid is AtlasBaseOperation< + getRelationshipDefByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the relationship.") @path guid: string; }, - AtlasRelationshipDef + AtlasRelationshipDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the relationship definition by its name (unique).") @route("/atlas/v2/types/relationshipdef/name/{name}") @get - getRelationshipDefByName is AtlasBaseOperation< + getRelationshipDefByName is Azure.Core.Foundations.Operation< { @doc("The name of the relationship.") @path name: string; }, - AtlasRelationshipDef + AtlasRelationshipDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the struct definition for the given GUID.") @route("/atlas/v2/types/structdef/guid/{guid}") @get - getStructDefByGuid is AtlasBaseOperation< + getStructDefByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the struct.") @path guid: string; }, - AtlasStructDef + AtlasStructDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the struct definition by its name (unique).") @route("/atlas/v2/types/structdef/name/{name}") @get - getStructDefByName is AtlasBaseOperation< + getStructDefByName is Azure.Core.Foundations.Operation< { @doc("The name of the struct.") @path name: string; }, - AtlasStructDef + AtlasStructDef, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the type definition for the given GUID.") @route("/atlas/v2/types/typedef/guid/{guid}") @get - getByGuid is AtlasBaseOperation< + getByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the type.") @path guid: string; }, - AtlasTypeDef + AtlasTypeDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the type definition by its name (unique).") @route("/atlas/v2/types/typedef/name/{name}") @get - getByName is AtlasBaseOperation< + getByName is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path name: string; }, - AtlasTypeDef + AtlasTypeDef, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete API for type identified by its name.") @route("/atlas/v2/types/typedef/name/{name}") @delete - delete is AtlasBaseOperation< + delete is Azure.Core.Foundations.Operation< { @doc("The name of the type.") @path name: string; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions in bulk.") @route("/atlas/v2/types/typedefs") @get - list is AtlasBaseOperation< + list is Azure.Core.Foundations.Operation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -1986,7 +2012,7 @@ when search filter type=term_template @query type?: Typedef; }, - AtlasTypesDef + AtlasTypesDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1997,13 +2023,13 @@ Any changes to the existing definitions will be discarded. """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is AtlasBaseOperation< + bulkCreate is Azure.Core.Foundations.Operation< { @doc("A composite wrapper object with corresponding lists of the type definition.") @body typesDef: AtlasTypesDef; }, - AtlasTypesDef + AtlasTypesDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2013,33 +2039,33 @@ persisted. """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is AtlasBaseOperation< + bulkUpdate is Azure.Core.Foundations.Operation< { @doc("A composite object that captures all type definition changes.") @body typesDef: AtlasTypesDef; }, - AtlasTypesDef + AtlasTypesDef,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is AtlasBaseOperation< + bulkDelete is Azure.Core.Foundations.Operation< { @doc("A composite object that captures all types to be deleted") @body typesDef: AtlasTypesDef; }, - void + void,{},ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions returned as a list of minimal information header.") @route("/atlas/v2/types/typedefs/headers") @get - listHeaders is AtlasBaseOperation< + listHeaders is Azure.Core.Foundations.Operation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -2053,32 +2079,38 @@ when search filter type=term_template @query type?: Typedef; }, - OkResponse + OkResponse, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get the term template definition for the given GUID.") @route("/types/termtemplatedef/guid/{guid}") @get - getTermTemplateDefByGuid is DataMapBaseOperation< + getTermTemplateDefByGuid is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the term template.") @path guid: string; }, - TermTemplateDef + TermTemplateDef, + {}, + ErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get the term template definition by its name (unique).") @route("/types/termtemplatedef/name/{name}") @get - getTermTemplateDefByName is DataMapBaseOperation< + getTermTemplateDefByName is Azure.Core.Foundations.Operation< { @doc("The unique name of the term template.") @path name: string; }, - TermTemplateDef + TermTemplateDef, + {}, + ErrorResponse >; } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index b9925df02b5c..0a9b306457e4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -22,12 +22,12 @@ options: clear-output-folder: true model-namespace: false "@azure-tools/typespec-ts": - package-dir: "analytics-purview-datamap" + package-dir: "purview-datamap-rest" generateMetadata: true generateTest: true packageDetails: - name: "@azure-rest/analytics-purview-datamap" - description: "Azure.Analytics.Purview.DataMap Service" + name: "@azure-rest/purview-datamap" + description: Purview DataMap Service" "@azure-tools/typespec-java": package-dir: "azure-analytics-purview-datamap" namespace: com.azure.analytics.purview.datamap From f9ae1c9ebb562ce9144b95a6c8eece33f1832637 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 5 Dec 2023 13:48:17 +0800 Subject: [PATCH 046/132] Update models.tsp --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index c49af5f67139..df380da9d3e7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -345,7 +345,7 @@ model AtlasStruct { @doc("The name of the type.") typeName?: string; - #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" @doc("ETag for concurrency control.") lastModifiedTS?: string; } @@ -487,7 +487,7 @@ model AtlasClassifications { ...PList; } -#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" +#suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" @doc("Paginated-list, for returning search results.") model PList { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object>" @@ -625,7 +625,7 @@ model AtlasGlossaryBaseObject { @doc("The short version of description.") shortDescription?: string; - #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" @doc("ETag for concurrency control.") lastModifiedTS?: string; @@ -1449,7 +1449,6 @@ model AtlasConstraintDef { type?: string; } -#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("Base class that captures common-attributes for all types.") model AtlasBaseTypeDef { @doc("The enum of type category.") @@ -1491,6 +1490,7 @@ model AtlasBaseTypeDef { @doc("The version of the record.") version?: int64; + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" @doc("ETag for concurrency control.") lastModifiedTS?: string; } From 7dab36ef35addc76128fa850c069171e40d52a3f Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 5 Dec 2023 14:02:26 +0800 Subject: [PATCH 047/132] update error response --- .../models.tsp | 4 +- .../routes.tsp | 193 +++++++++--------- 2 files changed, 99 insertions(+), 98 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index df380da9d3e7..43b525b0c542 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -447,9 +447,9 @@ removed. @doc("An error response from the service") @error -model ErrorResponse { +model AtlasErrorResponse { @doc("The request ID.") - requestId?: string; + requestId?: Azure.Core.uuid; @doc("The error code.") errorCode?: string; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 678d542c06b9..d1733af0cf7d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -35,7 +35,7 @@ op AtlasImportOperation< TParams & TraitProperties, TResponse & TraitProperties, Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, -ErrorResponse +AtlasErrorResponse >; alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ @@ -80,7 +80,7 @@ need to move an entity to another collection. }, EntityMutationResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -104,7 +104,7 @@ need to move an entity to another collection. }, AtlasEntitiesWithExtInfo, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -142,7 +142,7 @@ entities. }, EntityMutationResponse, {}, - ErrorResponse + AtlasErrorResponse >; @@ -162,7 +162,7 @@ attributes. }, EntityMutationResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -175,7 +175,7 @@ attributes. @body request: ClassificationAssociateRequest; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -196,7 +196,7 @@ attributes. @query ignoreRelationships?: boolean; }, - AtlasEntityWithExtInfo,{},ErrorResponse + AtlasEntityWithExtInfo,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -226,7 +226,7 @@ possible. @body body: unknown; }, - EntityMutationResponse,{},ErrorResponse + EntityMutationResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -239,7 +239,7 @@ possible. @path guid: string; }, - EntityMutationResponse,{},ErrorResponse + EntityMutationResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -256,7 +256,7 @@ possible. @path classificationName: string; }, - AtlasClassification,{},ErrorResponse + AtlasClassification,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -273,7 +273,7 @@ possible. @path classificationName: string; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -286,7 +286,7 @@ possible. @path guid: string; }, - AtlasClassifications,{},ErrorResponse + AtlasClassifications,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -304,7 +304,7 @@ possible. @body classifications: AtlasClassification[]; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -322,7 +322,7 @@ possible. @body classifications: AtlasClassification[]; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -365,7 +365,7 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - AtlasEntityWithExtInfo,{},ErrorResponse + AtlasEntityWithExtInfo,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -408,7 +408,7 @@ be changed to other unique attributes) }, EntityMutationResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -443,7 +443,7 @@ be changed to other unique attributes) }, EntityMutationResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -472,7 +472,7 @@ be changed to other unique attributes) }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -499,7 +499,7 @@ be changed to other unique attributes) }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -526,7 +526,7 @@ be changed to other unique attributes) }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -541,7 +541,7 @@ be changed to other unique attributes) }, OkResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -592,7 +592,7 @@ example. qualifiedName can be changed to other unique attributes) }, AtlasEntitiesWithExtInfo, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -607,7 +607,7 @@ example. qualifiedName can be changed to other unique attributes) }, AtlasEntityHeader, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -626,7 +626,7 @@ example. qualifiedName can be changed to other unique attributes) }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -651,7 +651,7 @@ default is false. }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @@ -675,7 +675,7 @@ default is false. }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" @@ -698,7 +698,7 @@ default is false. }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -708,7 +708,8 @@ default is false. getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation<{}, { @header contentType: "application/octet-stream"; @body template: bytes; - }>; + },{},AtlasErrorResponse + >; #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -741,7 +742,7 @@ default is false. }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -761,7 +762,7 @@ default is false. }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -781,7 +782,7 @@ default is false. }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -822,7 +823,7 @@ be changed to other unique attributes) }, void, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -863,7 +864,7 @@ be changed to other unique attributes) @body body: string[]; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -904,7 +905,7 @@ be changed to other unique attributes) @body body: string[]; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -921,7 +922,7 @@ be changed to other unique attributes) @body moveEntitiesRequest: MoveEntitiesRequest; }, - EntityMutationResponse,{},ErrorResponse + EntityMutationResponse,{},AtlasErrorResponse >; } @@ -960,7 +961,7 @@ and }, OkResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -980,7 +981,7 @@ the anchor attribute when creating the Term/Category. }, AtlasGlossary, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -996,7 +997,7 @@ the anchor attribute when creating the Term/Category. }, OkResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1016,7 +1017,7 @@ can also be defined during creation. }, AtlasGlossaryCategory, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1031,7 +1032,7 @@ can also be defined during creation. }, AtlasGlossaryCategory, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1050,7 +1051,7 @@ can also be defined during creation. }, AtlasGlossaryCategory, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1065,7 +1066,7 @@ can also be defined during creation. }, void, {}, - ErrorResponse + AtlasErrorResponse >; @@ -1092,7 +1093,7 @@ values for partial update. }, AtlasGlossaryCategory, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1122,7 +1123,7 @@ parameters are currently not being enabled and won't work even they are passed. }, OkResponse>, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1149,7 +1150,7 @@ parameters are currently not being enabled and won't work even they are passed. }, OkResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1170,7 +1171,7 @@ Optionally it can be categorized as well. @body glossaryTerm: AtlasGlossaryTerm; }, - AtlasGlossaryTerm,{},ErrorResponse + AtlasGlossaryTerm,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1183,7 +1184,7 @@ Optionally it can be categorized as well. @path termGuid: string; }, - AtlasGlossaryTerm,{},ErrorResponse + AtlasGlossaryTerm,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1204,7 +1205,7 @@ Optionally it can be categorized as well. @body glossaryTerm: AtlasGlossaryTerm; }, - AtlasGlossaryTerm,{},ErrorResponse + AtlasGlossaryTerm,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1217,7 +1218,7 @@ Optionally it can be categorized as well. @path termGuid: string; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1245,7 +1246,7 @@ values to be updated. @body partialUpdates: unknown; }, - AtlasGlossaryTerm,{},ErrorResponse + AtlasGlossaryTerm,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1263,7 +1264,7 @@ values to be updated. @body glossaryTerm: AtlasGlossaryTerm[]; }, - OkResponse,{},ErrorResponse + OkResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1291,7 +1292,7 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse,{},ErrorResponse + OkResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1316,7 +1317,7 @@ is an alternative to assign a term to multiple entities. @body relatedObjectIds: AtlasRelatedObjectId[]; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1334,7 +1335,7 @@ is an alternative to assign a term to multiple entities. @body relatedObjectIds: AtlasRelatedObjectId[]; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1362,7 +1363,7 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - OkResponse>,{},ErrorResponse + OkResponse>,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1375,7 +1376,7 @@ parameters are currently not being enabled and won't work even they are passed. @path glossaryGuid: string; }, - AtlasGlossary,{},ErrorResponse + AtlasGlossary,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1396,7 +1397,7 @@ parameters are currently not being enabled and won't work even they are passed. @body updatedGlossary: AtlasGlossary; }, - AtlasGlossary,{},ErrorResponse + AtlasGlossary,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1412,7 +1413,7 @@ separate delete terms and categories. @path glossaryGuid: string; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1440,7 +1441,7 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse,{},ErrorResponse + OkResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1468,7 +1469,7 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse,{},ErrorResponse + OkResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1490,7 +1491,7 @@ GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. @path glossaryGuid: string; }, - AtlasGlossaryExtInfo,{},ErrorResponse + AtlasGlossaryExtInfo,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1524,7 +1525,7 @@ values. @body partialUpdates: unknown; }, - AtlasGlossary,{},ErrorResponse + AtlasGlossary,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1552,7 +1553,7 @@ pagination result. @query sort?: string; }, - OkResponse,{},ErrorResponse + OkResponse,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1582,7 +1583,7 @@ to get pagination result. }, OkResponse, {}, - ErrorResponse + AtlasErrorResponse >; } @@ -1600,7 +1601,7 @@ interface Discovery { }, SearchResult, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -1615,7 +1616,7 @@ interface Discovery { }, SuggestResult, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -1628,7 +1629,7 @@ interface Discovery { @body autoCompleteRequest: AutoCompleteRequest; }, - AutoCompleteResult,{},ErrorResponse + AutoCompleteResult,{},AtlasErrorResponse >; } @@ -1652,7 +1653,7 @@ interface Lineage { @query direction: Direction; }, - AtlasLineageInfo,{},ErrorResponse + AtlasLineageInfo,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -1679,7 +1680,7 @@ interface Lineage { }, AtlasLineageInfo, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1724,7 +1725,7 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - AtlasLineageInfo,{},ErrorResponse + AtlasLineageInfo,{},AtlasErrorResponse >; } @@ -1743,7 +1744,7 @@ be created. @body relationship: AtlasRelationship; }, - AtlasRelationship,{},ErrorResponse + AtlasRelationship,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1759,7 +1760,7 @@ be created. @body relationship: AtlasRelationship; }, - AtlasRelationship,{},ErrorResponse + AtlasRelationship,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1776,7 +1777,7 @@ be created. @query extendedInfo?: boolean; }, - AtlasRelationshipWithExtInfo,{},ErrorResponse + AtlasRelationshipWithExtInfo,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1789,7 +1790,7 @@ be created. @path guid: string; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; } @@ -1805,7 +1806,7 @@ interface `Type`{ @path guid: string; }, - AtlasBusinessMetadataDef,{},ErrorResponse + AtlasBusinessMetadataDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1818,7 +1819,7 @@ interface `Type`{ @path name: string; }, - AtlasBusinessMetadataDef,{},ErrorResponse + AtlasBusinessMetadataDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1831,7 +1832,7 @@ interface `Type`{ @path guid: string; }, - AtlasClassificationDef,{},ErrorResponse + AtlasClassificationDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1844,7 +1845,7 @@ interface `Type`{ @path name: string; }, - AtlasClassificationDef,{},ErrorResponse + AtlasClassificationDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1857,7 +1858,7 @@ interface `Type`{ @path guid: string; }, - AtlasEntityDef,{},ErrorResponse + AtlasEntityDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1870,7 +1871,7 @@ interface `Type`{ @path name: string; }, - AtlasEntityDef,{},ErrorResponse + AtlasEntityDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1883,7 +1884,7 @@ interface `Type`{ @path guid: string; }, - AtlasEnumDef,{},ErrorResponse + AtlasEnumDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1896,7 +1897,7 @@ interface `Type`{ @path name: string; }, - AtlasEnumDef,{},ErrorResponse + AtlasEnumDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1909,7 +1910,7 @@ interface `Type`{ @path guid: string; }, - AtlasRelationshipDef,{},ErrorResponse + AtlasRelationshipDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1922,7 +1923,7 @@ interface `Type`{ @path name: string; }, - AtlasRelationshipDef,{},ErrorResponse + AtlasRelationshipDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1935,7 +1936,7 @@ interface `Type`{ @path guid: string; }, - AtlasStructDef,{},ErrorResponse + AtlasStructDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1950,7 +1951,7 @@ interface `Type`{ }, AtlasStructDef, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1963,7 +1964,7 @@ interface `Type`{ @path guid: string; }, - AtlasTypeDef,{},ErrorResponse + AtlasTypeDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1978,7 +1979,7 @@ interface `Type`{ }, AtlasTypeDef, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1991,7 +1992,7 @@ interface `Type`{ @path name: string; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2012,7 +2013,7 @@ when search filter type=term_template @query type?: Typedef; }, - AtlasTypesDef,{},ErrorResponse + AtlasTypesDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2029,7 +2030,7 @@ Any changes to the existing definitions will be discarded. @body typesDef: AtlasTypesDef; }, - AtlasTypesDef,{},ErrorResponse + AtlasTypesDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2045,7 +2046,7 @@ persisted. @body typesDef: AtlasTypesDef; }, - AtlasTypesDef,{},ErrorResponse + AtlasTypesDef,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2058,7 +2059,7 @@ persisted. @body typesDef: AtlasTypesDef; }, - void,{},ErrorResponse + void,{},AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2081,7 +2082,7 @@ when search filter type=term_template }, OkResponse, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -2096,7 +2097,7 @@ when search filter type=term_template }, TermTemplateDef, {}, - ErrorResponse + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -2111,6 +2112,6 @@ when search filter type=term_template }, TermTemplateDef, {}, - ErrorResponse + AtlasErrorResponse >; } From 1ddbdd9109ca3108fc7cbc242aee78108d970391 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 5 Dec 2023 15:56:20 +0800 Subject: [PATCH 048/132] Update models.tsp --- .../models.tsp | 24 +++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 43b525b0c542..2f86d103302b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -911,11 +911,27 @@ model SearchFacetItem { count?: int32; @doc("The name of the facet item.") - facet?: string; + facet: string; - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" - @doc("Any object") - sort?: unknown; + @doc("Define the sorting criteria for items") + sort?: SearchFacetSort; +} + +@doc("The sorting criteria") +model SearchFacetSort { + @doc("Order by count") + count?: SearchSortOrder; + + @doc("Order by value") + value?: SearchSortOrder; +} + +@doc("Search sort order") +enum SearchSortOrder { + @doc("Use ascending order for sorting") + asc, + @doc("Use descending order for sorting") + desc } @doc("Taxonomy setting for search request") From df20c1d8587557b872deb50b322ef142faa455e9 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 5 Dec 2023 16:42:47 +0800 Subject: [PATCH 049/132] update descriptions --- .../models.tsp | 135 ++++++++---------- .../routes.tsp | 6 +- 2 files changed, 60 insertions(+), 81 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 2f86d103302b..e9c7665e9fcc 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -1615,24 +1615,25 @@ model AtlasClassificationDef { Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. -

    -
  • Any subtypes -of the entity types inherit the restriction
    • -
  • Any classificationDef -subtypes inherit the parents entityTypes restrictions
    • -
  • Any -classificationDef subtypes can further restrict the parents entityTypes -restrictions by specifying a subset of the entityTypes
    • -
  • An empty -entityTypes list when there are no parent restrictions means there are no -restrictions
    • -
  • An empty entityTypes list when there are parent + +Any subtypes of the entity types inherit the restriction. + +Any classificationDef subtypes inherit the parents entityTypes restrictions. + +Any classificationDef subtypes can further restrict the parents entityTypes +restrictions by specifying a subset of the entityTypes. + +An empty entityTypes list when there are no parent restrictions means there are no +restrictions. + +An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents -restrictions
    • -
  • If a list of entityTypes are supplied, where one inherits +restrictions. + +If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner -classificationsDefs
    • -
+classificationsDefs. + """) entityTypes?: string[]; @@ -1698,48 +1699,39 @@ model AtlasEnumElementDef { @doc(""" AtlasRelationshipDef is a TypeDef that defines a relationship. -

-As with -other typeDefs the AtlasRelationshipDef has a name. Once created the +As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. The name and the guid are the 2 ways that the RelationshipDef is identified. -

RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally whether the end is a container. -

RelationshipDefs can have AttributeDefs - though only -primitive types are allowed.
+primitive types are allowed. RelationshipDefs have a relationshipCategory -specifying the UML type of relationship required
+specifying the UML type of relationship required The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs will not specify an EntityDef type name as their types. -

RelationshipDefs introduce new attributes to the entity instances. For example -

EntityDef A might have attributes attr1,attr2,attr3 -
-EntityDef B might have attributes attr4,attr5,attr6
+ +EntityDef B might have attributes attr4,attr5,attr6 RelationshipDef -AtoB might define 2 ends
+AtoB might define 2 ends -

-   end1:  type A, name attr7
-   end2:
-type B, name attr8
+end1: type A, name attr7 +end2: type B, name attr8 -

When an instance of EntityDef A is created, it -will have attributes attr1,attr2,attr3,attr7
+will have attributes attr1,attr2,attr3,attr7 When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8 -

+ In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into @@ -1767,19 +1759,12 @@ it is the container end of the relationship. @doc(""" The Relationship category determines the style of relationship around containment and lifecycle. -UML terminology is used for the -values. -

-ASSOCIATION is a relationship with no containment.
-COMPOSITION -and AGGREGATION are containment relationships. -

-The difference being in the -lifecycles of the container and its children. In the COMPOSITION case, -the -children cannot exist without the container. For AGGREGATION, the life -cycles -of the container and children are totally independent. +UML terminology is used for the values. +ASSOCIATION is a relationship with no containment. +COMPOSITION and AGGREGATION are containment relationships. +The difference being in the lifecycles of the container and its children. +In the COMPOSITION case, the children cannot exist without the container. +For AGGREGATION, the life cycles of the container and children are totally independent. """) relationshipCategory?: RelationshipCategory; @@ -1825,24 +1810,25 @@ model AtlasExtraTypeDef { Specifying a list of entityType names in the classificationDef, ensures that classifications can only be applied to those entityTypes. -

    -
  • Any subtypes -of the entity types inherit the restriction
    • -
  • Any classificationDef -subtypes inherit the parents entityTypes restrictions
    • -
  • Any -classificationDef subtypes can further restrict the parents entityTypes -restrictions by specifying a subset of the entityTypes
    • -
  • An empty -entityTypes list when there are no parent restrictions means there are no -restrictions
    • -
  • An empty entityTypes list when there are parent + +Any subtypes of the entity types inherit the restriction. + +Any classificationDef subtypes inherit the parents entityTypes restrictions. + +Any classificationDef subtypes can further restrict the parents entityTypes +restrictions by specifying a subset of the entityTypes. + +An empty entityTypes list when there are no parent restrictions means there are no +restrictions. + +An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents -restrictions
    • -
  • If a list of entityTypes are supplied, where one inherits +restrictions. + +If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner -classificationsDefs
    • -
+classificationsDefs. + """) entityTypes?: string[]; @@ -1880,19 +1866,14 @@ it is the container end of the relationship. @doc(""" The Relationship category determines the style of relationship around containment and lifecycle. -UML terminology is used for the -values. -

-ASSOCIATION is a relationship with no containment.
-COMPOSITION -and AGGREGATION are containment relationships. -

-The difference being in the -lifecycles of the container and its children. In the COMPOSITION case, -the -children cannot exist without the container. For AGGREGATION, the life -cycles -of the container and children are totally independent. +UML terminology is used for the values. + +ASSOCIATION is a relationship with no containment. +COMPOSITION and AGGREGATION are containment relationships. + +The difference being in the lifecycles of the container and its children. +In the COMPOSITION case, the children cannot exist without the container. +For AGGREGATION, the life cycles of the container and children are totally independent. """) relationshipCategory?: RelationshipCategory; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index d1733af0cf7d..2520fd209cc7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -204,10 +204,8 @@ attributes. Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. -It does not -support updating complex types like arrays, and maps. -Null updates are not -possible. +It does not support updating complex types like arrays, and maps. +Null updates are not possible. """) @route("/atlas/v2/entity/guid/{guid}") @put From 1fb8066a528439080d233c985f230e7d7dd593b9 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 10:09:41 +0800 Subject: [PATCH 050/132] run tsp format --- .../Azure.Analytics.Purview.DataMap/main.tsp | 18 +- .../models.tsp | 108 +++++- .../routes.tsp | 325 +++++++++++++----- 3 files changed, 334 insertions(+), 117 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index db198aa39dfe..33b774fd1f62 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -16,7 +16,6 @@ using TypeSpec.Versioning; endpoint: string, } ) - @doc(""" Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. @@ -31,15 +30,16 @@ namespace PurviewDataMap; enum ApiVersions { @doc("2023-09-01 service API version") @useDependency(Azure.Core.Versions.v1_0_Preview_2) - "2023-09-01", + `2023-09-01`, } #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" @doc("The Azure Active Directory OAuth2 Flow") -model AADToken is OAuth2Auth<[ - { - type: OAuth2FlowType.implicit; - authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; - scopes: ["https://purview.azure.net/.default"]; - } -]>; \ No newline at end of file +model AADToken + is OAuth2Auth<[ + { + type: OAuth2FlowType.implicit; + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; + scopes: ["https://purview.azure.net/.default"]; + } + ]>; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index e9c7665e9fcc..35be06c02b6e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -10,8 +10,10 @@ namespace PurviewDataMap; enum BusinessAttributeUpdateBehavior { @doc("Ignore the business attribute payload for update.") ignore, + @doc("Replace all the business attributes using the payload.") replace, + @doc("Merge the business attributes. Business attributes will not be updated if not provided.") merge, } @@ -20,6 +22,7 @@ enum BusinessAttributeUpdateBehavior { enum Status { @doc("The status is active.") ACTIVE, + @doc("The status is deleted.") DELETED, } @@ -28,16 +31,22 @@ enum Status { enum AtlasTermAssignmentStatus { @doc("The status is discovered.") DISCOVERED, + @doc("The status is proposed.") PROPOSED, + @doc("The status is imported.") IMPORTED, + @doc("The status is validated.") VALIDATED, + @doc("The status is deprecated.") DEPRECATED, + @doc("The status is obsolete.") OBSOLETE, + @doc("Other status.") OTHER, } @@ -46,8 +55,10 @@ enum AtlasTermAssignmentStatus { enum SortType { @doc("No sorting order") NONE, + @doc("Use ascending order for sorting") ASC, + @doc("Use descending order for sorting") DESC, } @@ -56,6 +67,7 @@ enum SortType { enum ImportStatus { @doc("Success") SUCCESS, + @doc("Failed") FAILED, } @@ -64,12 +76,16 @@ enum ImportStatus { enum AtlasTermRelationshipStatus { @doc("draft") DRAFT, + @doc("active") ACTIVE, + @doc("deprecated") DEPRECATED, + @doc("obsolete") OBSOLETE, + @doc("other") OTHER, } @@ -78,10 +94,13 @@ enum AtlasTermRelationshipStatus { enum TermStatus { @doc("draft") Draft, + @doc("approved") Approved, + @doc("alert") Alert, + @doc("expired") Expired, } @@ -90,6 +109,7 @@ enum TermStatus { enum StatusAtlasRelationship { @doc("active") ACTIVE, + @doc("deleted") DELETED, } @@ -98,8 +118,10 @@ enum StatusAtlasRelationship { enum Direction { @doc("both") BOTH, + @doc("input") INPUT, + @doc("output") OUTPUT, } @@ -108,8 +130,10 @@ enum Direction { enum LineageDirection { @doc("input") INPUT, + @doc("output") OUTPUT, + @doc("both") BOTH, } @@ -118,8 +142,10 @@ enum LineageDirection { enum Cardinality { @doc("single") SINGLE, + @doc("list") LIST, + @doc("set") SET, } @@ -128,22 +154,31 @@ enum Cardinality { enum TypeCategory { @doc("primitive") PRIMITIVE, + @doc("object id type") OBJECT_ID_TYPE, + @doc("enum") ENUM, + @doc("struct") STRUCT, + @doc("classification") CLASSIFICATION, + @doc("entity") ENTITY, + @doc("array") ARRAY, + @doc("map") MAP, + @doc("relationship") RELATIONSHIP, + @doc("term template") TERM_TEMPLATE, } @@ -152,18 +187,25 @@ enum TypeCategory { enum RoundingMode { @doc("up") UP, + @doc("down") DOWN, + @doc("ceiling") CEILING, + @doc("floor") FLOOR, + @doc("half up") HALF_UP, + @doc("half down") HALF_DOWN, + @doc("half even") HALF_EVEN, + @doc("unnecessary") UNNECESSARY, } @@ -172,8 +214,10 @@ enum RoundingMode { enum RelationshipCategory { @doc("association") ASSOCIATION, + @doc("aggregation") AGGREGATION, + @doc("composition") COMPOSITION, } @@ -182,14 +226,19 @@ enum RelationshipCategory { enum Typedef { @doc("enum") `enum`, + @doc("entity") entity, + @doc("classification") classification, + @doc("relationship") relationship, + @doc("struct") struct, + @doc("term template") term_template, } @@ -198,24 +247,34 @@ enum Typedef { enum SearchFilterOperator { @doc("equal") eq, + @doc("not equal") ne, + @doc("greater than") gt, + @doc("less than") lt, + @doc("greater than or equal to") ge, + @doc("less than or equal to") le, + @doc("contains") contains, + @doc("start with") startswith, + @doc("prefix") prefix, + @doc("time range") timerange, + @doc("exists") exists, } @@ -345,6 +404,7 @@ model AtlasStruct { @doc("The name of the type.") typeName?: string; + #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" @doc("ETag for concurrency control.") lastModifiedTS?: string; @@ -605,7 +665,6 @@ model AtlasRelatedTermHeader { termGuid?: string; } - @doc("The glossary base object.") model AtlasGlossaryBaseObject { ...AtlasBaseModelObject; @@ -677,7 +736,6 @@ model AtlasGlossaryHeader { relationGuid?: string; } - @doc("The glossary term.") model AtlasGlossaryTerm { ...AtlasGlossaryBaseObject; @@ -871,7 +929,6 @@ model AtlasGlossaryExtInfo { termInfo?: Record; } - @doc("The search query of advanced search request.") model SearchRequest { @doc("The keywords applied to all searchable fields.") @@ -906,7 +963,6 @@ batch, and will return new token in each response unless there's no more data. @doc("The content of a search facet result item.") model SearchFacetItem { - @doc("The count of the facet item.") count?: int32; @@ -930,8 +986,9 @@ model SearchFacetSort { enum SearchSortOrder { @doc("Use ascending order for sorting") asc, + @doc("Use descending order for sorting") - desc + desc, } @doc("Taxonomy setting for search request") @@ -1152,7 +1209,6 @@ Expert or Steward for a glossary term. contactType?: string; } - @doc("The query of suggest request.") model SuggestRequest { @doc(""" @@ -1927,18 +1983,16 @@ model AtlasTypeDefHeader { @discriminator("kind") @doc("Base model for search filter") -model SearchFilter { - -} - +model SearchFilter {} @doc("And filter for search") model AndFilter extends SearchFilter { @doc("And filter for search") kind: "AndFilter"; + @doc("List of filters") @projectedName("json", "and") - andFilters : SearchFilter[]; + andFilters: SearchFilter[]; } @doc("Not filter for search") @@ -1948,22 +2002,24 @@ model NotFilter extends SearchFilter { @doc("Not filter") @projectedName("json", "not") - notFilters : SearchFilter; + notFilters: SearchFilter; } @doc("Or filter for search") model OrFilter extends SearchFilter { @doc("Or filter for search") kind: "OrFilter"; + @doc("List of filters") @projectedName("json", "or") - orFilters : SearchFilter[]; + orFilters: SearchFilter[]; } @doc("Asset type filter for search") model AssetTypeFilter extends SearchFilter { @doc("Asset type filter for search") kind: "AssetTypeFilter"; + @doc("Asset type name") assetType: string; } @@ -1975,6 +2031,7 @@ model AttributeFilter extends SearchFilter { @doc("Attribute name") attributeName: string; + @doc("Operator") operator: SearchFilterOperator; @@ -1986,8 +2043,10 @@ model AttributeFilter extends SearchFilter { model ClassificationFilter extends SearchFilter { @doc("Classification type filter for search") kind: "ClassificationFilter"; + @doc("Classification name") classificationName: string; + @doc("Whether to include sub classifications") includeSubClassifications?: boolean; } @@ -1996,6 +2055,7 @@ model ClassificationFilter extends SearchFilter { model ClassificationCategoryFilter extends SearchFilter { @doc("Classification category filter for search") kind: "ClassificationCategoryFilter"; + @doc("Classification category") classificationCategory: string; } @@ -2004,6 +2064,7 @@ model ClassificationCategoryFilter extends SearchFilter { model CollectionIdFilter extends SearchFilter { @doc("Collection id filter for search") kind: "CollectionIdFilter"; + @doc("Collection id") collectionId: string; } @@ -2012,8 +2073,10 @@ model CollectionIdFilter extends SearchFilter { model ContactFilter extends SearchFilter { @doc("Contact filter for search") kind: "ContactFilter"; + @doc("Contact type") contactType?: string; + @doc("Contact Id") contactId?: string; } @@ -2022,6 +2085,7 @@ model ContactFilter extends SearchFilter { model DomainIdFilter extends SearchFilter { @doc("Domain id filter for search") kind: "DomainIdFilter"; + @doc("Domain id") domainId: string; } @@ -2030,6 +2094,7 @@ model DomainIdFilter extends SearchFilter { model ExistsFilter extends SearchFilter { @doc("Exists filter for search") kind: "ExistsFilter"; + @projectedName("json", "exists") @doc("Field") field: string; @@ -2039,6 +2104,7 @@ model ExistsFilter extends SearchFilter { model FileExtensionFilter extends SearchFilter { @doc("File extension filter for search") kind: "FileExtensionFilter"; + @doc("File extension") fileExtension: string; } @@ -2047,17 +2113,19 @@ model FileExtensionFilter extends SearchFilter { model LabelFilter extends SearchFilter { @doc("Label filter for search") kind: "LabelFilter"; + @doc("Label") label: string; + @doc("Whether to include sub labels") includeSubLabels?: boolean; } - @doc("Label filter for search") model ObjectTypeFilter extends SearchFilter { @doc("Label filter for search") kind: "ObjectTypeFilter"; + @doc("Object type") objectType: string; } @@ -2066,8 +2134,10 @@ model ObjectTypeFilter extends SearchFilter { model PathFilter extends SearchFilter { @doc("Path filter for search") kind: "PathFilter"; + @doc("Path") path: string; + @doc("Whether the path is parent path") isParent?: boolean; } @@ -2076,8 +2146,10 @@ model PathFilter extends SearchFilter { model ScanInfoFilter extends SearchFilter { @doc("Scan info filter for search") kind: "ScanInfoFilter"; + @doc("Data source name") dataSourceName?: string; + @doc("Scan name") scanName?: string; } @@ -2086,6 +2158,7 @@ model ScanInfoFilter extends SearchFilter { model GlossaryFilter extends SearchFilter { @doc("Glossary filter for search") kind: "GlossaryFilter"; + @doc("Glossary type. Either AtlasGlossary or AtlasGlossaryType") glossaryType: string; } @@ -2094,6 +2167,7 @@ model GlossaryFilter extends SearchFilter { model IdFilter extends SearchFilter { @doc("Id filter for search") kind: "IdFilter"; + @doc("Id value") id: string; } @@ -2102,8 +2176,10 @@ model IdFilter extends SearchFilter { model TypeFilter extends SearchFilter { @doc("Type filter for search") kind: "TypeFilter"; + @doc("Type name") typeName: string; + @doc("Whether to include sub types") includeSubTypes?: boolean; } @@ -2113,6 +2189,7 @@ model TypeFilter extends SearchFilter { model CreateTimeFilter extends SearchFilter { @doc("Create time filter for search") kind: "CreateTimeFilter"; + @doc(""" Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example { @@ -2129,6 +2206,7 @@ to represent the time filter, operator must be one of gt/lt/gte/lte model UpdateTimeFilter extends SearchFilter { @doc("Update time filter for search") kind: "UpdateTimeFilter"; + @doc(""" Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example { @@ -2138,4 +2216,4 @@ Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or u to represent the time filter, operator must be one of gt/lt/gte/lte """) updateTime: unknown; -} \ No newline at end of file +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 2520fd209cc7..1666aea0cba9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -22,6 +22,7 @@ namespace PurviewDataMap; model OkResponse { @statusCode status: 200; + @body data: T; } @@ -29,13 +30,29 @@ model OkResponse { op AtlasImportOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, - Traits extends TypeSpec.Reflection.Model = {}, + Traits extends TypeSpec.Reflection.Model = {}, TraitContexts extends TraitContext = TraitContext.Undefined > is Azure.Core.Foundations.Operation< -TParams & TraitProperties, -TResponse & TraitProperties, -Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, -AtlasErrorResponse + TParams & + TraitProperties< + Traits & + NoConditionalRequests & + NoRepeatableRequests & + NoClientRequestId, + TraitLocation.Parameters, + TraitContext.Action + >, + TResponse & + TraitProperties< + Traits & + NoConditionalRequests & + NoRepeatableRequests & + NoClientRequestId, + TraitLocation.Response, + TraitContext.Action + >, + Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, + AtlasErrorResponse >; alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ @@ -91,7 +108,9 @@ need to move an entity to another collection. listByGuids is Azure.Core.Foundations.Operation< { @doc("An array of GUIDs of entities to list.") - @query({format: "multi"}) + @query({ + format: "multi", + }) guid: string[]; @doc("Whether to return minimal information for referred entities.") @@ -145,7 +164,6 @@ entities. AtlasErrorResponse >; - #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -157,7 +175,9 @@ attributes. bulkDelete is Azure.Core.Foundations.Operation< { @doc("An array of GUIDs of entities to delete.") - @query({format: "multi"}) + @query({ + format: "multi", + }) guid: string[]; }, EntityMutationResponse, @@ -175,7 +195,9 @@ attributes. @body request: ClassificationAssociateRequest; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -196,7 +218,9 @@ attributes. @query ignoreRelationships?: boolean; }, - AtlasEntityWithExtInfo,{},AtlasErrorResponse + AtlasEntityWithExtInfo, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -224,7 +248,9 @@ Null updates are not possible. @body body: unknown; }, - EntityMutationResponse,{},AtlasErrorResponse + EntityMutationResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -237,7 +263,9 @@ Null updates are not possible. @path guid: string; }, - EntityMutationResponse,{},AtlasErrorResponse + EntityMutationResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -254,7 +282,9 @@ Null updates are not possible. @path classificationName: string; }, - AtlasClassification,{},AtlasErrorResponse + AtlasClassification, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -271,7 +301,9 @@ Null updates are not possible. @path classificationName: string; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -284,7 +316,9 @@ Null updates are not possible. @path guid: string; }, - AtlasClassifications,{},AtlasErrorResponse + AtlasClassifications, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -302,7 +336,9 @@ Null updates are not possible. @body classifications: AtlasClassification[]; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -320,7 +356,9 @@ Null updates are not possible. @body classifications: AtlasClassification[]; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -363,7 +401,9 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - AtlasEntityWithExtInfo,{},AtlasErrorResponse + AtlasEntityWithExtInfo, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -620,7 +660,8 @@ example. qualifiedName can be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata payload") - @body businessMetadata: Record>; + @body + businessMetadata: Record>; }, void, {}, @@ -643,9 +684,11 @@ default is false. """) @query isOverwrite?: boolean; - @doc("BusinessMetadata payload") + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @body businessMetadata: Record>; + @doc("BusinessMetadata payload") + @body + businessMetadata: Record>; }, void, {}, @@ -669,13 +712,14 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata attribute payload") - @body businessMetadataAttributes: Record; + @body + businessMetadataAttributes: Record; }, void, {}, AtlasErrorResponse >; - + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Add or update business metadata attributes.") @@ -690,9 +734,11 @@ default is false. @doc("The globally unique identifier of the entity.") @path guid: string; - @doc("Business metadata attribute payload") + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @body businessMetadataAttributes: Record; + @doc("Business metadata attribute payload") + @body + businessMetadataAttributes: Record; }, void, {}, @@ -703,10 +749,14 @@ default is false. @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get - getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation<{}, { - @header contentType: "application/octet-stream"; - @body template: bytes; - },{},AtlasErrorResponse + getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation< + {}, + { + @header contentType: "application/octet-stream"; + @body template: bytes; + }, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" @@ -715,12 +765,12 @@ default is false. @route("/atlas/v2/entity/businessmetadata/import") @post importBusinessMetadata is AtlasImportOperation< - { - @doc("InputStream of file") - uploadedInputStream: bytes; - }, - BulkImportResponse, - MultipartFormDataRequestHeadersTraits + { + @doc("InputStream of file") + uploadedInputStream: bytes; + }, + BulkImportResponse, + MultipartFormDataRequestHeadersTraits >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -862,7 +912,9 @@ be changed to other unique attributes) @body body: string[]; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -903,7 +955,9 @@ be changed to other unique attributes) @body body: string[]; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -920,7 +974,9 @@ be changed to other unique attributes) @body moveEntitiesRequest: MoveEntitiesRequest; }, - EntityMutationResponse,{},AtlasErrorResponse + EntityMutationResponse, + {}, + AtlasErrorResponse >; } @@ -1067,7 +1123,6 @@ can also be defined during creation. AtlasErrorResponse >; - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" @@ -1169,7 +1224,9 @@ Optionally it can be categorized as well. @body glossaryTerm: AtlasGlossaryTerm; }, - AtlasGlossaryTerm,{},AtlasErrorResponse + AtlasGlossaryTerm, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1182,7 +1239,9 @@ Optionally it can be categorized as well. @path termGuid: string; }, - AtlasGlossaryTerm,{},AtlasErrorResponse + AtlasGlossaryTerm, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1203,7 +1262,9 @@ Optionally it can be categorized as well. @body glossaryTerm: AtlasGlossaryTerm; }, - AtlasGlossaryTerm,{},AtlasErrorResponse + AtlasGlossaryTerm, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1216,7 +1277,9 @@ Optionally it can be categorized as well. @path termGuid: string; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1244,7 +1307,9 @@ values to be updated. @body partialUpdates: unknown; }, - AtlasGlossaryTerm,{},AtlasErrorResponse + AtlasGlossaryTerm, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1262,7 +1327,9 @@ values to be updated. @body glossaryTerm: AtlasGlossaryTerm[]; }, - OkResponse,{},AtlasErrorResponse + OkResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1290,7 +1357,9 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse,{},AtlasErrorResponse + OkResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1315,7 +1384,9 @@ is an alternative to assign a term to multiple entities. @body relatedObjectIds: AtlasRelatedObjectId[]; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1333,7 +1404,9 @@ is an alternative to assign a term to multiple entities. @body relatedObjectIds: AtlasRelatedObjectId[]; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1361,7 +1434,9 @@ parameters are currently not being enabled and won't work even they are passed. @query sort?: string; }, - OkResponse>,{},AtlasErrorResponse + OkResponse>, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1374,7 +1449,9 @@ parameters are currently not being enabled and won't work even they are passed. @path glossaryGuid: string; }, - AtlasGlossary,{},AtlasErrorResponse + AtlasGlossary, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1395,7 +1472,9 @@ parameters are currently not being enabled and won't work even they are passed. @body updatedGlossary: AtlasGlossary; }, - AtlasGlossary,{},AtlasErrorResponse + AtlasGlossary, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1411,7 +1490,9 @@ separate delete terms and categories. @path glossaryGuid: string; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1439,7 +1520,9 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse,{},AtlasErrorResponse + OkResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1467,7 +1550,9 @@ limit/offset to get pagination result. @query sort?: string; }, - OkResponse,{},AtlasErrorResponse + OkResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1489,7 +1574,9 @@ GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. @path glossaryGuid: string; }, - AtlasGlossaryExtInfo,{},AtlasErrorResponse + AtlasGlossaryExtInfo, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1523,7 +1610,9 @@ values. @body partialUpdates: unknown; }, - AtlasGlossary,{},AtlasErrorResponse + AtlasGlossary, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1551,7 +1640,9 @@ pagination result. @query sort?: string; }, - OkResponse,{},AtlasErrorResponse + OkResponse, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1627,7 +1718,9 @@ interface Discovery { @body autoCompleteRequest: AutoCompleteRequest; }, - AutoCompleteResult,{},AtlasErrorResponse + AutoCompleteResult, + {}, + AtlasErrorResponse >; } @@ -1651,7 +1744,9 @@ interface Lineage { @query direction: Direction; }, - AtlasLineageInfo,{},AtlasErrorResponse + AtlasLineageInfo, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -1723,7 +1818,9 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - AtlasLineageInfo,{},AtlasErrorResponse + AtlasLineageInfo, + {}, + AtlasErrorResponse >; } @@ -1742,7 +1839,9 @@ be created. @body relationship: AtlasRelationship; }, - AtlasRelationship,{},AtlasErrorResponse + AtlasRelationship, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1758,7 +1857,9 @@ be created. @body relationship: AtlasRelationship; }, - AtlasRelationship,{},AtlasErrorResponse + AtlasRelationship, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1775,7 +1876,9 @@ be created. @query extendedInfo?: boolean; }, - AtlasRelationshipWithExtInfo,{},AtlasErrorResponse + AtlasRelationshipWithExtInfo, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1788,12 +1891,14 @@ be created. @path guid: string; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; } @operationGroup -interface `Type`{ +interface Type { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @@ -1804,7 +1909,9 @@ interface `Type`{ @path guid: string; }, - AtlasBusinessMetadataDef,{},AtlasErrorResponse + AtlasBusinessMetadataDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1817,7 +1924,9 @@ interface `Type`{ @path name: string; }, - AtlasBusinessMetadataDef,{},AtlasErrorResponse + AtlasBusinessMetadataDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1830,7 +1939,9 @@ interface `Type`{ @path guid: string; }, - AtlasClassificationDef,{},AtlasErrorResponse + AtlasClassificationDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1843,7 +1954,9 @@ interface `Type`{ @path name: string; }, - AtlasClassificationDef,{},AtlasErrorResponse + AtlasClassificationDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1856,7 +1969,9 @@ interface `Type`{ @path guid: string; }, - AtlasEntityDef,{},AtlasErrorResponse + AtlasEntityDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1869,7 +1984,9 @@ interface `Type`{ @path name: string; }, - AtlasEntityDef,{},AtlasErrorResponse + AtlasEntityDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1882,7 +1999,9 @@ interface `Type`{ @path guid: string; }, - AtlasEnumDef,{},AtlasErrorResponse + AtlasEnumDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1895,7 +2014,9 @@ interface `Type`{ @path name: string; }, - AtlasEnumDef,{},AtlasErrorResponse + AtlasEnumDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1908,7 +2029,9 @@ interface `Type`{ @path guid: string; }, - AtlasRelationshipDef,{},AtlasErrorResponse + AtlasRelationshipDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1921,7 +2044,9 @@ interface `Type`{ @path name: string; }, - AtlasRelationshipDef,{},AtlasErrorResponse + AtlasRelationshipDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1934,7 +2059,9 @@ interface `Type`{ @path guid: string; }, - AtlasStructDef,{},AtlasErrorResponse + AtlasStructDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1962,7 +2089,9 @@ interface `Type`{ @path guid: string; }, - AtlasTypeDef,{},AtlasErrorResponse + AtlasTypeDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1990,7 +2119,9 @@ interface `Type`{ @path name: string; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2011,9 +2142,11 @@ when search filter type=term_template @query type?: Typedef; }, - AtlasTypesDef,{},AtlasErrorResponse + AtlasTypesDef, + {}, + AtlasErrorResponse >; - + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" Create all atlas type definitions in bulk, only new definitions will be @@ -2028,7 +2161,9 @@ Any changes to the existing definitions will be discarded. @body typesDef: AtlasTypesDef; }, - AtlasTypesDef,{},AtlasErrorResponse + AtlasTypesDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2044,7 +2179,9 @@ persisted. @body typesDef: AtlasTypesDef; }, - AtlasTypesDef,{},AtlasErrorResponse + AtlasTypesDef, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2057,7 +2194,9 @@ persisted. @body typesDef: AtlasTypesDef; }, - void,{},AtlasErrorResponse + void, + {}, + AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2097,19 +2236,19 @@ when search filter type=term_template {}, AtlasErrorResponse >; - + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get the term template definition by its name (unique).") @route("/types/termtemplatedef/name/{name}") @get getTermTemplateDefByName is Azure.Core.Foundations.Operation< - { - @doc("The unique name of the term template.") - @path - name: string; - }, - TermTemplateDef, - {}, - AtlasErrorResponse ->; + { + @doc("The unique name of the term template.") + @path + name: string; + }, + TermTemplateDef, + {}, + AtlasErrorResponse + >; } From fe6df80ad4e78c86e8955f07d3e0dfadf74ba883 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 11:15:18 +0800 Subject: [PATCH 051/132] Create openapi.json --- .../stable/2023-09-01/openapi.json | 9338 +++++++++++++++++ 1 file changed, 9338 insertions(+) create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json new file mode 100644 index 000000000000..e4c0e92b5a4a --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -0,0 +1,9338 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Analytics Purview Data Map", + "version": "2023-09-01", + "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/datamap/api", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AADToken": [ + "https://purview.azure.net/.default" + ] + } + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://purview.azure.net/.default": "" + } + } + }, + "tags": [], + "paths": { + "/atlas/v2/entity": { + "post": { + "operationId": "Entity_CreateOrUpdate", + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" + }, + { + "name": "entity", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + }, + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + } + } + } + }, + "/atlas/v2/entity/bulk": { + "get": { + "operationId": "Entity_ListByGuids", + "description": "List entities in bulk identified by its GUIDs.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to list.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } + } + }, + "post": { + "operationId": "Entity_BulkCreateOrUpdate", + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" + }, + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "entities", + "in": "body", + "description": "An array of entities to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Entity_BulkDelete", + "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to delete.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } + } + } + }, + "/atlas/v2/entity/bulk/classification": { + "post": { + "operationId": "Entity_AddClassification", + "description": "Associate a classification to multiple entities in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "request", + "in": "body", + "description": "The request to associate a classification to multiple entities.", + "required": true, + "schema": { + "$ref": "#/definitions/ClassificationAssociateRequest" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } + } + } + }, + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "operationId": "Entity_BulkSetClassifications", + "description": "Set classifications on entities in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "entityHeaders", + "in": "body", + "description": "Atlas entity headers.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" + } + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_ListByUniqueAttributes", + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "operationId": "Entity_ImportBusinessMetadata", + "description": "Upload the file for creating Business Metadata in BULK", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "uploadedInputStream", + "in": "formData", + "description": "InputStream of file", + "required": true, + "type": "string", + "format": "byte" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BulkImportResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import/template": { + "get": { + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "operationId": "Entity_Get", + "description": "Get complete definition of an entity given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" + } + } + }, + "put": { + "operationId": "Entity_PartialUpdateAttributeByGuid", + "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The value of the attribute.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_PartialUpdateAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + } + } + }, + "delete": { + "operationId": "Entity_Delete", + "description": "Delete an entity identified by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "description": "Add business metadata to an entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "isOverwrite", + "in": "query", + "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", + "required": false, + "type": "boolean" + }, + { + "name": "businessMetadata", + "in": "body", + "description": "BusinessMetadata payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadata", + "description": "Remove business metadata from an entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "businessMetadata", + "in": "body", + "description": "Business metadata payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "description": "Add or update business metadata attributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "bmName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "businessMetadataAttributes", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "description": "Delete business metadata attributes from an entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "bmName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "businessMetadataAttributes", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "operationId": "Entity_GetClassification", + "description": "Get classification for a given entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveClassification", + "description": "Delete a given classification from an existing entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "operationId": "Entity_GetClassifications", + "description": "List classifications for a given entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } + } + }, + "put": { + "operationId": "Entity_UpdateClassifications", + "description": "Update classifications to an existing entity represented by a guid.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classifications", + "in": "body", + "description": "An array of classifications to be updated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" + } + } + }, + "post": { + "operationId": "Entity_AddClassifications", + "description": "Add classifications to an existing entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classifications", + "in": "body", + "description": "An array of classifications to be added.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/header": { + "get": { + "operationId": "Entity_GetHeader", + "description": "Get entity header given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetHeader": { + "$ref": "./examples/Entity_GetHeader.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/labels": { + "put": { + "operationId": "Entity_AddLabel", + "description": "Add given labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be added", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_AddLabel.json" + } + } + }, + "post": { + "operationId": "Entity_SetLabels", + "description": "Set labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be set to the entity", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_SetLabels": { + "$ref": "./examples/Entity_SetLabels.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveLabels", + "description": "Delete given labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be deleted", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_RemoveLabels.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_GetByUniqueAttributes", + "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" + } + } + }, + "put": { + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "atlasEntityWithExtInfo", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_PartialUpdateByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + } + } + }, + "delete": { + "operationId": "Entity_DeleteByUniqueAttribute", + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { + "delete": { + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "put": { + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "description": "Update classification on an entity identified by its type and unique attributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "atlasClassificationArray", + "in": "body", + "description": "An array of classification to be updated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" + } + } + }, + "post": { + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "description": "Add classification to the entity identified by its type and unique attributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "atlasClassificationArray", + "in": "body", + "description": "An array of classification to be added.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { + "put": { + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be added", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } + } + }, + "post": { + "operationId": "Entity_SetLabelsByUniqueAttribute", + "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be set", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be deleted", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/glossary": { + "get": { + "operationId": "Glossary_List", + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossary" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } + } + }, + "post": { + "operationId": "Glossary_Create", + "description": "Create a glossary.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "atlasGlossary", + "in": "body", + "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}": { + "get": { + "operationId": "Glossary_Get", + "description": "Get a specific Glossary by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" + } + } + }, + "put": { + "operationId": "Glossary_Update", + "description": "Update the given glossary.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "updatedGlossary", + "in": "body", + "description": "The glossary definition to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" + } + } + }, + "delete": { + "operationId": "Glossary_Delete", + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/categories": { + "get": { + "operationId": "Glossary_ListCategories", + "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { + "get": { + "operationId": "Glossary_ListCategoriesHeaders", + "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "get": { + "operationId": "Glossary_GetDetailed", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/partial": { + "put": { + "operationId": "Glossary_PartialUpdate", + "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "partialUpdates", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/terms": { + "get": { + "operationId": "Glossary_ListTerms", + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "get": { + "operationId": "Glossary_ListTermHeaders", + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } + } + } + }, + "/atlas/v2/glossary/categories": { + "post": { + "operationId": "Glossary_CreateCategories", + "description": "Create glossary category in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryCategory", + "in": "body", + "description": "An array of glossary category definitions to be created.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" + } + } + } + }, + "/atlas/v2/glossary/category": { + "post": { + "operationId": "Glossary_CreateCategory", + "description": "Create a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryCategory", + "in": "body", + "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}": { + "get": { + "operationId": "Glossary_GetCategory", + "description": "Get specific glossary category by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" + } + } + }, + "put": { + "operationId": "Glossary_UpdateCategory", + "description": "Update the given glossary category by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "glossaryCategory", + "in": "body", + "description": "The glossary category to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteCategory", + "description": "Delete a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateCategory", + "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "partialUpdates", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/related": { + "get": { + "operationId": "Glossary_ListRelatedCategories", + "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "get": { + "operationId": "Glossary_ListCategoryTerms", + "description": "Get all terms associated with the specific category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryGuid", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" + } + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "operationId": "Glossary_CreateTerm", + "description": "Create a glossary term.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "glossaryTerm", + "in": "body", + "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" + }, + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" + } + } + } + }, + "/atlas/v2/glossary/term/{termGuid}": { + "get": { + "operationId": "Glossary_GetTerm", + "description": "Get a specific glossary term by its GUID. ", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" + }, + "Glossary_GetTermWithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" + } + } + }, + "put": { + "operationId": "Glossary_UpdateTerm", + "description": "Update the given glossary term by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "glossaryTerm", + "in": "body", + "description": "The glossary term to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteTerm", + "description": "Delete a glossary term.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } + } + } + }, + "/atlas/v2/glossary/term/{termGuid}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateTerm", + "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "partialUpdates", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } + } + } + }, + "/atlas/v2/glossary/terms": { + "post": { + "operationId": "Glossary_CreateTerms", + "description": "Create glossary terms in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "glossaryTerm", + "in": "body", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } + } + } + }, + "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "get": { + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" + } + } + }, + "post": { + "operationId": "Glossary_AssignTermToEntities", + "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "relatedObjectIds", + "in": "body", + "description": "An array of related object IDs to which the term has to be associated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "description": "Delete the term assignment for the given list of related objects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "relatedObjectIds", + "in": "body", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } + } + } + }, + "/atlas/v2/glossary/terms/{termGuid}/related": { + "get": { + "operationId": "Glossary_ListRelatedTerms", + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" + } + } + } + }, + "/atlas/v2/lineage/{guid}": { + "get": { + "operationId": "Lineage_Get", + "description": "Get lineage info of the entity specified by GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } + } + } + }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Lineage_GetByUniqueAttribute", + "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attr" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/relationship": { + "put": { + "operationId": "Relationship_Update", + "description": "Update an existing relationship between entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "relationship", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" + } + } + }, + "post": { + "operationId": "Relationship_Create", + "description": "Create a new relationship between entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "relationship", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } + } + } + }, + "/atlas/v2/relationship/guid/{guid}": { + "get": { + "operationId": "Relationship_Get", + "description": "Get relationship information between entities by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + }, + { + "name": "extendedInfo", + "in": "query", + "description": "Limits whether includes extended information.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" + } + } + }, + "delete": { + "operationId": "Relationship_Delete", + "description": "Delete a relationship between entities by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByGuid", + "description": "Get the businessMetadata definition for the given guid.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "businessMetadata guid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByName", + "description": "Get the businessMetadata definition by it's name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "businessMetadata name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } + } + } + }, + "/atlas/v2/types/classificationdef/guid/{guid}": { + "get": { + "operationId": "Type_GetClassificationDefByGuid", + "description": "Get the classification definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "operationId": "Type_GetClassificationDefByName", + "description": "Get the classification definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } + } + } + }, + "/atlas/v2/types/entitydef/guid/{guid}": { + "get": { + "operationId": "Type_GetEntityDefByGuid", + "description": "Get the Entity definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/entitydef/name/{name}": { + "get": { + "operationId": "Type_GetEntityDefByName", + "description": "Get the entity definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEntityDefByName": { + "$ref": "./examples/Type_GetEntityDefByName.json" + } + } + } + }, + "/atlas/v2/types/enumdef/guid/{guid}": { + "get": { + "operationId": "Type_GetEnumDefByGuid", + "description": "Get the enum definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the enum.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/enumdef/name/{name}": { + "get": { + "operationId": "Type_GetEnumDefByName", + "description": "Get the enum definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the enum.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } + } + } + }, + "/atlas/v2/types/relationshipdef/guid/{guid}": { + "get": { + "operationId": "Type_GetRelationshipDefByGuid", + "description": "Get the relationship definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/relationshipdef/name/{name}": { + "get": { + "operationId": "Type_GetRelationshipDefByName", + "description": "Get the relationship definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } + } + } + }, + "/atlas/v2/types/structdef/guid/{guid}": { + "get": { + "operationId": "Type_GetStructDefByGuid", + "description": "Get the struct definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the struct.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetStructDefByGuid": { + "$ref": "./examples/Type_GetStructDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/structdef/name/{name}": { + "get": { + "operationId": "Type_GetStructDefByName", + "description": "Get the struct definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the struct.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } + } + } + }, + "/atlas/v2/types/typedef/guid/{guid}": { + "get": { + "operationId": "Type_GetByGuid", + "description": "Get the type definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } + } + } + }, + "/atlas/v2/types/typedef/name/{name}": { + "get": { + "operationId": "Type_GetByName", + "description": "Get the type definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" + } + } + }, + "delete": { + "operationId": "Type_Delete", + "description": "Delete API for type identified by its name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } + } + } + }, + "/atlas/v2/types/typedefs": { + "get": { + "operationId": "Type_List", + "description": "List all type definitions in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" + }, + { + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "Typedef", + "modelAsString": true, + "values": [ + { + "name": "enum", + "value": "enum", + "description": "enum" + }, + { + "name": "entity", + "value": "entity", + "description": "entity" + }, + { + "name": "classification", + "value": "classification", + "description": "classification" + }, + { + "name": "relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "struct", + "value": "struct", + "description": "struct" + }, + { + "name": "term_template", + "value": "term_template", + "description": "term template" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_List": { + "$ref": "./examples/Type_List.json" + }, + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" + } + } + }, + "put": { + "operationId": "Type_BulkUpdate", + "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typesDef", + "in": "body", + "description": "A composite object that captures all type definition changes.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkUpdate": { + "$ref": "./examples/Type_BulkUpdate.json" + } + } + }, + "post": { + "operationId": "Type_BulkCreate", + "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typesDef", + "in": "body", + "description": "A composite wrapper object with corresponding lists of the type definition.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + } + } + }, + "delete": { + "operationId": "Type_BulkDelete", + "description": "Delete API for all types in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typesDef", + "in": "body", + "description": "A composite object that captures all types to be deleted", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } + } + } + }, + "/atlas/v2/types/typedefs/headers": { + "get": { + "operationId": "Type_ListHeaders", + "description": "List all type definitions returned as a list of minimal information header.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" + }, + { + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "Typedef", + "modelAsString": true, + "values": [ + { + "name": "enum", + "value": "enum", + "description": "enum" + }, + { + "name": "entity", + "value": "entity", + "description": "entity" + }, + { + "name": "classification", + "value": "classification", + "description": "classification" + }, + { + "name": "relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "struct", + "value": "struct", + "description": "struct" + }, + { + "name": "term_template", + "value": "term_template", + "description": "term template" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasTypeDefHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } + } + } + }, + "/entity/moveTo": { + "post": { + "operationId": "Entity_MoveEntitiesToCollection", + "description": "Move existing entities to the target collection.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to.", + "required": true, + "type": "string" + }, + { + "name": "moveEntitiesRequest", + "in": "body", + "description": "Entity guids to be moved to target collection.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } + } + } + }, + "/lineage/{guid}/next": { + "get": { + "operationId": "Lineage_GetNextPage", + "description": "Return immediate next page lineage info about entity with pagination", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } + } + } + }, + "/search/autocomplete": { + "post": { + "operationId": "Discovery_AutoComplete", + "description": "Get auto complete options.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "autoCompleteRequest", + "in": "body", + "description": "An object specifying the autocomplete criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AutoCompleteResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } + } + } + }, + "/search/query": { + "post": { + "operationId": "Discovery_Query", + "description": "Get data using search.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "searchRequest", + "in": "body", + "description": "An object specifying the search criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SearchResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_TermAssignment": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Type": { + "$ref": "./examples/Discovery_Query_Type.json" + } + } + } + }, + "/search/suggest": { + "post": { + "operationId": "Discovery_Suggest", + "description": "Get search suggestions by query criteria.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "suggestRequest", + "in": "body", + "description": "An object specifying the suggest criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" + } + } + } + }, + "/types/termtemplatedef/guid/{guid}": { + "get": { + "operationId": "Type_GetTermTemplateDefByGuid", + "description": "Get the term template definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" + } + } + } + }, + "/types/termtemplatedef/name/{name}": { + "get": { + "operationId": "Type_GetTermTemplateDefByName", + "description": "Get the term template definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The unique name of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" + } + } + } + } + }, + "definitions": { + "AADToken": { + "type": "object", + "description": "The Azure Active Directory OAuth2 Flow", + "properties": { + "type": { + "type": "string", + "description": "OAuth2 authentication", + "enum": [ + "oauth2" + ] + }, + "flows": { + "type": "array", + "description": "Supported OAuth2 flows", + "items": {} + } + }, + "required": [ + "type", + "flows" + ] + }, + "AndFilter": { + "type": "object", + "description": "And filter for search", + "properties": { + "and": { + "type": "array", + "description": "List of filters", + "items": { + "$ref": "#/definitions/SearchFilter" + }, + "x-ms-client-name": "andFilters", + "x-ms-identifiers": [] + } + }, + "required": [ + "and" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "AndFilter" + }, + "ApiVersions": { + "type": "string", + "description": "Service API versions", + "enum": [ + "2023-09-01" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "2023-09-01", + "value": "2023-09-01", + "description": "2023-09-01 service API version" + } + ] + } + }, + "AssetTypeFilter": { + "type": "object", + "description": "Asset type filter for search", + "properties": { + "assetType": { + "type": "string", + "description": "Asset type name" + } + }, + "required": [ + "assetType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "AssetTypeFilter" + }, + "AtlasAttributeDef": { + "type": "object", + "description": "class that captures details of a struct-attribute.", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + } + } + }, + "AtlasBaseModelObject": { + "type": "object", + "description": "The base model object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + } + } + }, + "AtlasBaseTypeDef": { + "type": "object", + "description": "Base class that captures common-attributes for all types.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + } + } + }, + "AtlasBusinessMetadataDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassification": { + "type": "object", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityGuid": { + "type": "string", + "description": "The GUID of the entity." + }, + "entityStatus": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "removePropagationsOnEntityDelete": { + "type": "boolean", + "description": "Determines if propagations will be removed on entity deletion." + }, + "validityPeriods": { + "type": "array", + "description": "An array of time boundaries indicating validity periods.", + "items": { + "$ref": "#/definitions/TimeBoundary" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassificationDef": { + "type": "object", + "description": "class that captures details of a classification-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + } + } + }, + "AtlasClassifications": { + "type": "object", + "description": "REST serialization friendly list.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." + } + } + }, + "AtlasConstraintDef": { + "type": "object", + "description": "class that captures details of a constraint.", + "properties": { + "params": { + "type": "object", + "description": "The parameters of the constraint definition.", + "additionalProperties": {} + }, + "type": { + "type": "string", + "description": "The type of the constraint." + } + } + }, + "AtlasEntitiesWithExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "entities": { + "type": "array", + "description": "An array of entities.", + "items": { + "$ref": "#/definitions/AtlasEntity" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntity": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "businessAttributes": { + "type": "object", + "description": "Business attributes", + "additionalProperties": {} + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "customAttributes": { + "type": "object", + "description": "Custom Attribute", + "additionalProperties": { + "type": "string" + } + }, + "guid": { + "type": "string", + "description": "The GUID of the entity." + }, + "homeId": { + "type": "string", + "description": "The home ID of the entity." + }, + "collectionId": { + "type": "string", + "description": "The collection ID of the entity.", + "readOnly": true + }, + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" + }, + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers indicating the meanings of the entity.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship." + }, + "proxy": { + "type": "boolean", + "description": "Determines if there's a proxy." + }, + "relationshipAttributes": { + "type": "object", + "description": "The attributes of relationship.", + "additionalProperties": {} + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the entity." + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactBasic" + }, + "type": "array" + } + } + } + }, + "AtlasEntityDef": { + "type": "object", + "description": "class that captures details of a entity-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntityExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + } + } + }, + "AtlasEntityHeader": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "classificationNames": { + "type": "array", + "description": "An array of classification names.", + "items": { + "type": "string" + } + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "guid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the record." + }, + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" + }, + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meaningNames": { + "type": "array", + "description": "An array of meanings.", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + } + }, + "required": [ + "guid" + ] + }, + "AtlasEntityHeaders": { + "type": "object", + "description": "An instance of an entity header map.", + "properties": { + "guidHeaderMap": { + "type": "object", + "description": "The description of the guid header map,", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + } + } + }, + "AtlasEntityWithExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "entity": { + "$ref": "#/definitions/AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database." + } + } + }, + "AtlasEnumDef": { + "type": "object", + "description": "class that captures details of an enum-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEnumElementDef": { + "type": "object", + "description": "class that captures details of an enum-element.", + "properties": { + "description": { + "type": "string", + "description": "The description of the enum element definition." + }, + "ordinal": { + "type": "integer", + "format": "int32", + "description": "The ordinal of the enum element definition." + }, + "value": { + "type": "string", + "description": "The value of the enum element definition." + } + } + }, + "AtlasErrorResponse": { + "type": "object", + "description": "An error response from the service", + "properties": { + "requestId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The request ID." + }, + "errorCode": { + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "AtlasExtraTypeDef": { + "type": "object", + "description": "Extra properties for a type.", + "properties": { + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasGlossary": { + "type": "object", + "description": "The glossary object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + } + } + }, + "AtlasGlossaryBaseObject": { + "type": "object", + "description": "The glossary base object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + } + } + }, + "AtlasGlossaryCategory": { + "type": "object", + "description": "The glossary category.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "childrenCategories": { + "type": "array", + "description": "An array of children categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "parentCategory": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader", + "description": "The header of the related category." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasGlossaryExtInfo": { + "type": "object", + "description": "The extended information of glossary.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + }, + "categoryInfo": { + "type": "object", + "description": "The glossary category information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "termInfo": { + "type": "object", + "description": "The glossary term information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + } + }, + "AtlasGlossaryHeader": { + "type": "object", + "description": "The glossary header with basic information.", + "properties": { + "displayText": { + "type": "string", + "description": "The display text." + }, + "glossaryGuid": { + "type": "string", + "description": "The GUID of the glossary." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + } + }, + "AtlasGlossaryTerm": { + "type": "object", + "description": "The glossary term.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "abbreviation": { + "type": "string", + "description": "The abbreviation of the term." + }, + "templateName": { + "type": "array", + "description": "The name of the template.", + "items": {} + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "antonyms": { + "type": "array", + "description": "An array of related term headers as antonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/TermStatus", + "description": "Status of the AtlasGlossaryTerm" + }, + "nickName": { + "type": "string", + "description": "The nick name of the term." + }, + "hierarchyInfo": { + "type": "array", + "description": "The hierarchy information of the term.", + "items": { + "$ref": "#/definitions/PurviewObjectId" + }, + "x-ms-identifiers": [] + }, + "resources": { + "type": "array", + "description": "An array of resource link for term", + "items": { + "$ref": "#/definitions/ResourceLink" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactBasic" + }, + "type": "array" + } + }, + "attributes": { + "type": "object", + "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + }, + "assignedEntities": { + "type": "array", + "description": "An array of related object IDs.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + }, + "categories": { + "type": "array", + "description": "An array of term categorization headers.", + "items": { + "$ref": "#/definitions/AtlasTermCategorizationHeader" + }, + "x-ms-identifiers": [] + }, + "classifies": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "examples": { + "type": "array", + "description": "An array of examples.", + "items": { + "type": "string" + } + }, + "isA": { + "type": "array", + "description": "An array of related term headers indicating the is-a relationship.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "preferredTerms": { + "type": "array", + "description": "An array of preferred related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "preferredToTerms": { + "type": "array", + "description": "An array of related term headers that are preferred to.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "replacedBy": { + "type": "array", + "description": "An array of related term headers that are replaced by.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "replacementTerms": { + "type": "array", + "description": "An array of related term headers for replacement.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "seeAlso": { + "type": "array", + "description": "An array of related term headers for see also.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "synonyms": { + "type": "array", + "description": "An array of related term headers as synonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "translatedTerms": { + "type": "array", + "description": "An array of translated related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "translationTerms": { + "type": "array", + "description": "An array of related term headers for translation.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the term." + }, + "validValues": { + "type": "array", + "description": "An array of related term headers as valid values.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "validValuesFor": { + "type": "array", + "description": "An array of related term headers as valid values for other records.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasLineageInfo": { + "type": "object", + "description": "The lineage information.", + "properties": { + "baseEntityGuid": { + "type": "string", + "description": "The GUID of the base entity." + }, + "guidEntityMap": { + "type": "object", + "description": "The GUID entity map.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "widthCounts": { + "type": "object", + "description": "The entity count in specific direction.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + }, + "lineageDepth": { + "type": "integer", + "format": "int32", + "description": "The depth of lineage." + }, + "lineageWidth": { + "type": "integer", + "format": "int32", + "description": "The width of lineage." + }, + "childrenCount": { + "type": "integer", + "format": "int32", + "description": "The number of children node." + }, + "lineageDirection": { + "$ref": "#/definitions/LineageDirection", + "description": "The enum of lineage direction." + }, + "parentRelations": { + "type": "array", + "description": "An array of parentRelations relations.", + "items": { + "$ref": "#/definitions/ParentRelation" + }, + "x-ms-identifiers": [] + }, + "relations": { + "type": "array", + "description": "An array of lineage relations.", + "items": { + "$ref": "#/definitions/LineageRelation" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasObjectId": { + "type": "object", + "description": "Reference to an object-instance of a type - like entity.", + "properties": { + "guid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + } + } + }, + "AtlasRelatedCategoryHeader": { + "type": "object", + "description": "The header of the related category.", + "properties": { + "categoryGuid": { + "type": "string", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the category header." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "parentCategoryGuid": { + "type": "string", + "description": "The GUID of the parent category." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + } + }, + "AtlasRelatedObjectId": { + "type": "object", + "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", + "properties": { + "guid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "entityStatus": { + "$ref": "#/definitions/Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "relationshipType": { + "type": "string", + "description": "Relationship type" + }, + "relationshipAttributes": { + "$ref": "#/definitions/AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." + }, + "relationshipGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "relationshipStatus": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." + } + } + }, + "AtlasRelatedTermHeader": { + "type": "object", + "description": "The header of the related term.", + "properties": { + "description": { + "type": "string", + "description": "The description of the related term." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + } + }, + "AtlasRelationship": { + "type": "object", + "description": "Atlas relationship instance.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "end1": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "end2": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "guid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "homeId": { + "type": "string", + "description": "The home ID of the relationship." + }, + "label": { + "type": "string", + "description": "The label of the relationship." + }, + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship" + }, + "status": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the relationship." + } + } + }, + "AtlasRelationshipAttributeDef": { + "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." + } + } + }, + "AtlasRelationshipDef": { + "type": "object", + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + } + } + }, + "AtlasRelationshipEndDef": { + "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "single-valued attribute or multi-valued attribute." + }, + "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." + } + } + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "description": "The relationship with extended information.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "relationship": { + "$ref": "#/definitions/AtlasRelationship", + "description": "Atlas relationship instance." + } + } + }, + "AtlasStruct": { + "type": "object", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + } + } + }, + "AtlasStructDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasTermAssignmentHeader": { + "type": "object", + "description": "The header for term assignment.", + "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": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermAssignmentStatus", + "description": "The status of terms assignment." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the term." + } + } + }, + "AtlasTermAssignmentStatus": { + "type": "string", + "description": "Status for term assignment", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true, + "values": [ + { + "name": "DISCOVERED", + "value": "DISCOVERED", + "description": "The status is discovered." + }, + { + "name": "PROPOSED", + "value": "PROPOSED", + "description": "The status is proposed." + }, + { + "name": "IMPORTED", + "value": "IMPORTED", + "description": "The status is imported." + }, + { + "name": "VALIDATED", + "value": "VALIDATED", + "description": "The status is validated." + }, + { + "name": "DEPRECATED", + "value": "DEPRECATED", + "description": "The status is deprecated." + }, + { + "name": "OBSOLETE", + "value": "OBSOLETE", + "description": "The status is obsolete." + }, + { + "name": "OTHER", + "value": "OTHER", + "description": "Other status." + } + ] + } + }, + "AtlasTermCategorizationHeader": { + "type": "object", + "description": "The basic information for term categorization.", + "properties": { + "categoryGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the record." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "relationGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." + } + } + }, + "AtlasTermRelationshipStatus": { + "type": "string", + "description": "Status for atlas term relationship", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true, + "values": [ + { + "name": "DRAFT", + "value": "DRAFT", + "description": "draft" + }, + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "DEPRECATED", + "value": "DEPRECATED", + "description": "deprecated" + }, + { + "name": "OBSOLETE", + "value": "OBSOLETE", + "description": "obsolete" + }, + { + "name": "OTHER", + "value": "OTHER", + "description": "other" + } + ] + } + }, + "AtlasTypeDef": { + "type": "object", + "description": "The definitions of type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasTypeDefHeader": { + "type": "object", + "description": "The basic information of the type definition.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + } + }, + "AtlasTypesDef": { + "type": "object", + "description": "The definitions of types.", + "properties": { + "businessMetadataDefs": { + "type": "array", + "description": "businessMetadataDefs", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + }, + "x-ms-identifiers": [] + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + }, + "x-ms-identifiers": [] + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + }, + "x-ms-identifiers": [] + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + }, + "x-ms-identifiers": [] + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + }, + "x-ms-identifiers": [] + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + }, + "x-ms-identifiers": [] + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AttributeFilter": { + "type": "object", + "description": "Attribute filter for search", + "properties": { + "attributeName": { + "type": "string", + "description": "Attribute name" + }, + "operator": { + "$ref": "#/definitions/SearchFilterOperator", + "description": "Operator" + }, + "attributeValue": { + "type": "string", + "description": "Attribute value" + } + }, + "required": [ + "attributeName", + "operator", + "attributeValue" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "AttributeFilter" + }, + "AutoCompleteRequest": { + "type": "object", + "description": "The query of autocomplete request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." + }, + "filter": { + "$ref": "#/definitions/SearchFilter", + "description": "The filter for the autocomplete request." + } + } + }, + "AutoCompleteResult": { + "type": "object", + "description": "The result of the autocomplete request.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + }, + "x-ms-identifiers": [] + } + } + }, + "AutoCompleteResultValue": { + "type": "object", + "description": "The value item of the autocomplete suggest.", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BulkImportResponse": { + "type": "object", + "description": "example", + "properties": { + "failedImportInfoList": { + "type": "array", + "description": "failed importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + }, + "successImportInfoList": { + "type": "array", + "description": "successful importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + } + } + }, + "BusinessAttributeUpdateBehavior": { + "type": "string", + "description": "Enum for business attribute update behavior", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + "Cardinality": { + "type": "string", + "description": "Cardinality", + "enum": [ + "SINGLE", + "LIST", + "SET" + ], + "x-ms-enum": { + "name": "Cardinality", + "modelAsString": true, + "values": [ + { + "name": "SINGLE", + "value": "SINGLE", + "description": "single" + }, + { + "name": "LIST", + "value": "LIST", + "description": "list" + }, + { + "name": "SET", + "value": "SET", + "description": "set" + } + ] + } + }, + "ClassificationAssociateRequest": { + "type": "object", + "description": "The request for classification association.", + "properties": { + "classification": { + "$ref": "#/definitions/AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." + }, + "entityGuids": { + "type": "array", + "description": "The GUID of the entity.", + "items": { + "type": "string" + } + } + } + }, + "ClassificationCategoryFilter": { + "type": "object", + "description": "Classification category filter for search", + "properties": { + "classificationCategory": { + "type": "string", + "description": "Classification category" + } + }, + "required": [ + "classificationCategory" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ClassificationCategoryFilter" + }, + "ClassificationFilter": { + "type": "object", + "description": "Classification type filter for search", + "properties": { + "classificationName": { + "type": "string", + "description": "Classification name" + }, + "includeSubClassifications": { + "type": "boolean", + "description": "Whether to include sub classifications" + } + }, + "required": [ + "classificationName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ClassificationFilter" + }, + "CollectionIdFilter": { + "type": "object", + "description": "Collection id filter for search", + "properties": { + "collectionId": { + "type": "string", + "description": "Collection id" + } + }, + "required": [ + "collectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "CollectionIdFilter" + }, + "ContactBasic": { + "type": "object", + "description": "ContactBasic", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, + "ContactFilter": { + "type": "object", + "description": "Contact filter for search", + "properties": { + "contactType": { + "type": "string", + "description": "Contact type" + }, + "contactId": { + "type": "string", + "description": "Contact Id" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ContactFilter" + }, + "ContactSearchResultValue": { + "type": "object", + "description": "The contact in the search and suggest result.", + "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\nExpert or Steward for a glossary term." + } + } + }, + "CreateTimeFilter": { + "type": "object", + "description": "Create time filter for search", + "properties": { + "createTime": { + "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n}\nto represent the time filter, operator must be one of gt/lt/gte/lte" + } + }, + "required": [ + "createTime" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "CreateTimeFilter" + }, + "DateFormat": { + "type": "object", + "description": "The date format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "An array of available locales.", + "items": { + "type": "string" + } + }, + "calendar": { + "type": "number", + "format": "float", + "description": "Calendar" + }, + "dateInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "dateTimeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "instance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "lenient": { + "type": "boolean", + "description": "Determines the leniency of the date format." + }, + "numberFormat": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "timeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "timeZone": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + } + } + }, + "Direction": { + "type": "string", + "description": "Direction", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true, + "values": [ + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + }, + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + } + ] + } + }, + "DomainIdFilter": { + "type": "object", + "description": "Domain id filter for search", + "properties": { + "domainId": { + "type": "string", + "description": "Domain id" + } + }, + "required": [ + "domainId" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "DomainIdFilter" + }, + "EntityMutationResponse": { + "type": "object", + "description": "The mutation response of entity.", + "properties": { + "guidAssignments": { + "type": "object", + "description": "A map of GUID assignments with entities.", + "additionalProperties": { + "type": "string" + } + }, + "mutatedEntities": { + "type": "object", + "description": "The entity headers of mutated entities.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "partialUpdatedEntities": { + "type": "array", + "description": "An array of entity headers that partially updated.", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "ExistsFilter": { + "type": "object", + "description": "Exists filter for search", + "properties": { + "exists": { + "type": "string", + "description": "Field", + "x-ms-client-name": "field" + } + }, + "required": [ + "exists" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ExistsFilter" + }, + "FileExtensionFilter": { + "type": "object", + "description": "File extension filter for search", + "properties": { + "fileExtension": { + "type": "string", + "description": "File extension" + } + }, + "required": [ + "fileExtension" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "FileExtensionFilter" + }, + "GlossaryFilter": { + "type": "object", + "description": "Glossary filter for search", + "properties": { + "glossaryType": { + "type": "string", + "description": "Glossary type. Either AtlasGlossary or AtlasGlossaryType" + } + }, + "required": [ + "glossaryType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "GlossaryFilter" + }, + "IdFilter": { + "type": "object", + "description": "Id filter for search", + "properties": { + "id": { + "type": "string", + "description": "Id value" + } + }, + "required": [ + "id" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "IdFilter" + }, + "ImportInfo": { + "type": "object", + "description": "ImportInfo", + "properties": { + "childObjectName": { + "type": "string", + "description": "childObjectName" + }, + "importStatus": { + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "type": "string", + "description": "parentObjectName" + }, + "remarks": { + "type": "string", + "description": "remarks" + } + } + }, + "ImportStatus": { + "type": "string", + "description": "Status for import", + "enum": [ + "SUCCESS", + "FAILED" + ], + "x-ms-enum": { + "name": "ImportStatus", + "modelAsString": true, + "values": [ + { + "name": "SUCCESS", + "value": "SUCCESS", + "description": "Success" + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Failed" + } + ] + } + }, + "LabelFilter": { + "type": "object", + "description": "Label filter for search", + "properties": { + "label": { + "type": "string", + "description": "Label" + }, + "includeSubLabels": { + "type": "boolean", + "description": "Whether to include sub labels" + } + }, + "required": [ + "label" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "LabelFilter" + }, + "LineageDirection": { + "type": "string", + "description": "Lineage direction", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "INPUT", + "value": "INPUT", + "description": "input" + }, + { + "name": "OUTPUT", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "BOTH", + "value": "BOTH", + "description": "both" + } + ] + } + }, + "LineageRelation": { + "type": "object", + "description": "The lineage relation with GUID of the from and to entity.", + "properties": { + "fromEntityId": { + "type": "string", + "description": "The GUID of from-entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "toEntityId": { + "type": "string", + "description": "The GUID of to-entity." + } + } + }, + "MoveEntitiesRequest": { + "type": "object", + "description": "MoveEntitiesRequest", + "properties": { + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } + } + } + }, + "NotFilter": { + "type": "object", + "description": "Not filter for search", + "properties": { + "not": { + "$ref": "#/definitions/SearchFilter", + "description": "Not filter", + "x-ms-client-name": "notFilters" + } + }, + "required": [ + "not" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "NotFilter" + }, + "NumberFormat": { + "type": "object", + "description": "The number format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "The number format.", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string", + "description": "The currency." + }, + "currencyInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "groupingUsed": { + "type": "boolean", + "description": "Determines if grouping is used." + }, + "instance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "integerInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "maximumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of fraction digits." + }, + "maximumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of integer digits." + }, + "minimumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of fraction digits." + }, + "minimumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of integer digits." + }, + "numberInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "parseIntegerOnly": { + "type": "boolean", + "description": "Determines if only integer is parsed." + }, + "percentInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "roundingMode": { + "$ref": "#/definitions/RoundingMode", + "description": "The enum of rounding mode." + } + } + }, + "ObjectTypeFilter": { + "type": "object", + "description": "Label filter for search", + "properties": { + "objectType": { + "type": "string", + "description": "Object type" + } + }, + "required": [ + "objectType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ObjectTypeFilter" + }, + "OrFilter": { + "type": "object", + "description": "Or filter for search", + "properties": { + "or": { + "type": "array", + "description": "List of filters", + "items": { + "$ref": "#/definitions/SearchFilter" + }, + "x-ms-client-name": "orFilters", + "x-ms-identifiers": [] + } + }, + "required": [ + "or" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "OrFilter" + }, + "PList": { + "type": "object", + "description": "Paginated-list, for returning search results.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." + } + } + }, + "ParentRelation": { + "type": "object", + "description": "The lineage parents relation with GUID of the parent entity and to child entity.", + "properties": { + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + } + }, + "PathFilter": { + "type": "object", + "description": "Path filter for search", + "properties": { + "path": { + "type": "string", + "description": "Path" + }, + "isParent": { + "type": "boolean", + "description": "Whether the path is parent path" + } + }, + "required": [ + "path" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "PathFilter" + }, + "PurviewObjectId": { + "type": "object", + "description": "PurviewObjectId", + "properties": { + "guid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "name": { + "type": "string", + "description": "Name" + }, + "displayText": { + "type": "string", + "description": "Display text" + }, + "itemPath": { + "type": "string", + "description": "Item path" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": {} + } + } + }, + "RelationshipCategory": { + "type": "string", + "description": "Relationship Category", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true, + "values": [ + { + "name": "ASSOCIATION", + "value": "ASSOCIATION", + "description": "association" + }, + { + "name": "AGGREGATION", + "value": "AGGREGATION", + "description": "aggregation" + }, + { + "name": "COMPOSITION", + "value": "COMPOSITION", + "description": "composition" + } + ] + } + }, + "ResourceLink": { + "type": "object", + "description": "ResourceLink", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } + } + }, + "RoundingMode": { + "type": "string", + "description": "Rounding Mode", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true, + "values": [ + { + "name": "UP", + "value": "UP", + "description": "up" + }, + { + "name": "DOWN", + "value": "DOWN", + "description": "down" + }, + { + "name": "CEILING", + "value": "CEILING", + "description": "ceiling" + }, + { + "name": "FLOOR", + "value": "FLOOR", + "description": "floor" + }, + { + "name": "HALF_UP", + "value": "HALF_UP", + "description": "half up" + }, + { + "name": "HALF_DOWN", + "value": "HALF_DOWN", + "description": "half down" + }, + { + "name": "HALF_EVEN", + "value": "HALF_EVEN", + "description": "half even" + }, + { + "name": "UNNECESSARY", + "value": "UNNECESSARY", + "description": "unnecessary" + } + ] + } + }, + "ScanInfoFilter": { + "type": "object", + "description": "Scan info filter for search", + "properties": { + "dataSourceName": { + "type": "string", + "description": "Data source name" + }, + "scanName": { + "type": "string", + "description": "Scan name" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "ScanInfoFilter" + }, + "SearchFacetItem": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "$ref": "#/definitions/SearchFacetSort", + "description": "Define the sorting criteria for items" + } + }, + "required": [ + "facet" + ] + }, + "SearchFacetItemValue": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + } + }, + "SearchFacetResultValue": { + "type": "object", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "properties": { + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "assetType": { + "type": "array", + "description": "Asset type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "classification": { + "type": "array", + "description": "Classification", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "term": { + "type": "array", + "description": "Term", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactId": { + "type": "array", + "description": "Contact id", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactType": { + "type": "array", + "description": "Contact type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "label": { + "type": "array", + "description": "Label", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "glossaryType": { + "type": "array", + "description": "Glossary type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termStatus": { + "type": "array", + "description": "Term status", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termTemplate": { + "type": "array", + "description": "Term template", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + } + } + }, + "SearchFacetSort": { + "type": "object", + "description": "The sorting criteria", + "properties": { + "count": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by count" + }, + "value": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by value" + } + } + }, + "SearchFilter": { + "type": "object", + "description": "Base model for search filter", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for SearchFilter." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "SearchFilterOperator": { + "type": "string", + "description": "Search Filter Operator", + "enum": [ + "eq", + "ne", + "gt", + "lt", + "ge", + "le", + "contains", + "startswith", + "prefix", + "timerange", + "exists" + ], + "x-ms-enum": { + "name": "SearchFilterOperator", + "modelAsString": true, + "values": [ + { + "name": "eq", + "value": "eq", + "description": "equal" + }, + { + "name": "ne", + "value": "ne", + "description": "not equal" + }, + { + "name": "gt", + "value": "gt", + "description": "greater than" + }, + { + "name": "lt", + "value": "lt", + "description": "less than" + }, + { + "name": "ge", + "value": "ge", + "description": "greater than or equal to" + }, + { + "name": "le", + "value": "le", + "description": "less than or equal to" + }, + { + "name": "contains", + "value": "contains", + "description": "contains" + }, + { + "name": "startswith", + "value": "startswith", + "description": "start with" + }, + { + "name": "prefix", + "value": "prefix", + "description": "prefix" + }, + { + "name": "timerange", + "value": "timerange", + "description": "time range" + }, + { + "name": "exists", + "value": "exists", + "description": "exists" + } + ] + } + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "properties": { + "id": { + "type": "array", + "description": "Id", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "description": "Qualified name", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "type": "string" + } + } + } + }, + "SearchRequest": { + "type": "object", + "description": "The search query of advanced search request.", + "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\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchRequestTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, + "SearchRequestTaxonomySetting": { + "type": "object", + "description": "Taxonomy setting for search request", + "properties": { + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, + "SearchResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "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", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + } + }, + "SearchResultValue": { + "type": "object", + "description": "The value item of the search result.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "x-ms-client-name": "searchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" + }, + "x-ms-identifiers": [] + }, + "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\nAtlasGlossaryCategory." + }, + "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." + } + } + }, + "SearchSortOrder": { + "type": "string", + "description": "Search sort order", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "SearchSortOrder", + "modelAsString": true, + "values": [ + { + "name": "asc", + "value": "asc", + "description": "Use ascending order for sorting" + }, + { + "name": "desc", + "value": "desc", + "description": "Use descending order for sorting" + } + ] + } + }, + "SortType": { + "type": "string", + "description": "Type for sorting", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "No sorting order" + }, + { + "name": "ASC", + "value": "ASC", + "description": "Use ascending order for sorting" + }, + { + "name": "DESC", + "value": "DESC", + "description": "Use descending order for sorting" + } + ] + } + }, + "Status": { + "type": "string", + "description": "Status - can be active or deleted", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "DELETED", + "value": "DELETED", + "description": "The status is deleted." + } + ] + } + }, + "StatusAtlasRelationship": { + "type": "string", + "description": "Status for atlas relationship", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "StatusAtlasRelationship", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "DELETED", + "value": "DELETED", + "description": "deleted" + } + ] + } + }, + "SuggestRequest": { + "type": "object", + "description": "The query of suggest request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." + }, + "filter": { + "$ref": "#/definitions/SearchFilter", + "description": "The filter for the search." + } + } + }, + "SuggestResult": { + "type": "object", + "description": "The result item of the search suggest.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + } + }, + "SuggestResultValue": { + "type": "object", + "description": "The value item of the search suggest.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", + "x-ms-client-name": "searchText" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" + }, + "x-ms-identifiers": [] + }, + "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\nAtlasGlossaryCategory." + }, + "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." + } + } + }, + "TermSearchResultValue": { + "type": "object", + "description": "The context.", + "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." + } + } + }, + "TermStatus": { + "type": "string", + "description": "Status for term", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "Draft", + "description": "draft" + }, + { + "name": "Approved", + "value": "Approved", + "description": "approved" + }, + { + "name": "Alert", + "value": "Alert", + "description": "alert" + }, + { + "name": "Expired", + "value": "Expired", + "description": "expired" + } + ] + } + }, + "TermTemplateDef": { + "type": "object", + "description": "Term template definition for glossary term.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "TimeBoundary": { + "type": "object", + "description": "Captures time-boundary details", + "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." + } + } + }, + "TimeZone": { + "type": "object", + "description": "The timezone information.", + "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", + "description": "The timezone information." + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + } + }, + "TypeCategory": { + "type": "string", + "description": "Type Category", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "PRIMITIVE", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "OBJECT_ID_TYPE", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "ENUM", + "value": "ENUM", + "description": "enum" + }, + { + "name": "STRUCT", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "CLASSIFICATION", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "ENTITY", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "ARRAY", + "value": "ARRAY", + "description": "array" + }, + { + "name": "MAP", + "value": "MAP", + "description": "map" + }, + { + "name": "RELATIONSHIP", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TERM_TEMPLATE", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } + }, + "TypeFilter": { + "type": "object", + "description": "Type filter for search", + "properties": { + "typeName": { + "type": "string", + "description": "Type name" + }, + "includeSubTypes": { + "type": "boolean", + "description": "Whether to include sub types" + } + }, + "required": [ + "typeName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "TypeFilter" + }, + "Typedef": { + "type": "string", + "description": "Type", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "Typedef", + "modelAsString": true, + "values": [ + { + "name": "enum", + "value": "enum", + "description": "enum" + }, + { + "name": "entity", + "value": "entity", + "description": "entity" + }, + { + "name": "classification", + "value": "classification", + "description": "classification" + }, + { + "name": "relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "struct", + "value": "struct", + "description": "struct" + }, + { + "name": "term_template", + "value": "term_template", + "description": "term template" + } + ] + } + }, + "UpdateTimeFilter": { + "type": "object", + "description": "Update time filter for search", + "properties": { + "updateTime": { + "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n}\nto represent the time filter, operator must be one of gt/lt/gte/lte" + } + }, + "required": [ + "updateTime" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "UpdateTimeFilter" + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} From 5f3a726c93519f2aa93c2bc1d40d558bdb5974a8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 11:24:11 +0800 Subject: [PATCH 052/132] update --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 2 +- .../stable/2023-09-01/openapi.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 35be06c02b6e..7ccd0d4cacba 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -484,7 +484,7 @@ model AtlasEntityHeader { displayText?: string; @doc("The GUID of the record.") - guid: Azure.Core.uuid; + guid: string; @doc("Whether it is a shell entity") isIncomplete?: boolean; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index e4c0e92b5a4a..08e09dadf92a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -5467,7 +5467,7 @@ "description": "The display text." }, "guid": { - "$ref": "#/definitions/Azure.Core.uuid", + "type": "string", "description": "The GUID of the record." }, "isIncomplete": { From 8da84edfce9886522e8e2278537861e69964e6d5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 13:37:29 +0800 Subject: [PATCH 053/132] add api version --- .../stable/2023-09-01/examples/Entity_AddCustomAttribute.json | 1 + .../stable/2023-09-01/examples/Entity_Create.json | 1 + .../stable/2023-09-01/examples/Entity_Update.json | 1 + 3 files changed, 3 insertions(+) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 38d275e09fc6..b30d034aed83 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -1,6 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", "entity": { "referredEntities": {}, "entity": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index a8c29d541e8f..baf955ab8e7d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -1,6 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", "entity": { "referredEntities": {}, "entity": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 8a73eb79a419..99e21e91b2a8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -1,6 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", "entity": { "referredEntities": {}, "entity": { From 82cf5abe67076af3862aa365b7575f30a96c6b9c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 13:46:45 +0800 Subject: [PATCH 054/132] updated --- .../examples/2023-09-01/Entity_AddCustomAttribute.json | 1 + .../examples/2023-09-01/Entity_Create.json | 1 + .../examples/2023-09-01/Entity_Update.json | 1 + .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 2 +- .../stable/2023-09-01/openapi.json | 5 +---- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json index 38d275e09fc6..b30d034aed83 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json @@ -1,6 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", "entity": { "referredEntities": {}, "entity": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json index a8c29d541e8f..baf955ab8e7d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json @@ -1,6 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", "entity": { "referredEntities": {}, "entity": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json index 8a73eb79a419..99e21e91b2a8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json @@ -1,6 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", + "api-version": "2023-09-01", "entity": { "referredEntities": {}, "entity": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 7ccd0d4cacba..fe776e03dd44 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -967,7 +967,7 @@ model SearchFacetItem { count?: int32; @doc("The name of the facet item.") - facet: string; + facet?: string; @doc("Define the sorting criteria for items") sort?: SearchFacetSort; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 08e09dadf92a..1853ab5765b3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -8266,10 +8266,7 @@ "$ref": "#/definitions/SearchFacetSort", "description": "Define the sorting criteria for items" } - }, - "required": [ - "facet" - ] + } }, "SearchFacetItemValue": { "type": "object", From 6fbb57e96151907811610c5acaa66dbe2e826b60 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 16:18:52 +0800 Subject: [PATCH 055/132] guid is not required --- .../examples/2023-09-01/Entity_ImportBusinessMetadata.json | 2 +- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 2 +- .../2023-09-01/examples/Entity_ImportBusinessMetadata.json | 2 +- .../stable/2023-09-01/openapi.json | 5 +---- 4 files changed, 4 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json index dd6f3a5375b8..7b3743545b30 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "uploadedInputStreamInBytes" + "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index fe776e03dd44..857038d037cf 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -484,7 +484,7 @@ model AtlasEntityHeader { displayText?: string; @doc("The GUID of the record.") - guid: string; + guid?: string; @doc("Whether it is a shell entity") isIncomplete?: boolean; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index dd6f3a5375b8..7b3743545b30 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "uploadedInputStreamInBytes" + "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 1853ab5765b3..68957d786311 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -5500,10 +5500,7 @@ "$ref": "#/definitions/Status", "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." } - }, - "required": [ - "guid" - ] + } }, "AtlasEntityHeaders": { "type": "object", From 63d18920c1be2a511634f5f8c8d8b9a803d4ceae Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 6 Dec 2023 17:15:31 +0800 Subject: [PATCH 056/132] update examples --- .../2023-09-01/Discovery_AutoComplete.json | 4 +- .../examples/2023-09-01/Discovery_Query.json | 5 +- .../2023-09-01/Discovery_Query_And.json | 5 +- .../Discovery_Query_AndOrNested.json | 8 ++- .../2023-09-01/Discovery_Query_AssetType.json | 28 +++++++++ .../2023-09-01/Discovery_Query_Attribute.json | 4 ++ ...overy_Query_BusinessMetadataAttribute.json | 5 ++ .../Discovery_Query_Classification.json | 1 + .../Discovery_Query_Collection.json | 1 + .../2023-09-01/Discovery_Query_Facet.json | 1 + .../Discovery_Query_FileExtension.json | 2 + .../Discovery_Query_GlossaryTerm.json | 5 ++ .../2023-09-01/Discovery_Query_Id.json | 2 + .../2023-09-01/Discovery_Query_Not.json | 4 +- .../Discovery_Query_ObjectType.json | 59 +++++++++++-------- ...very_Query_PaginationContinuationPage.json | 5 +- .../Discovery_Query_PaginationFirstPage.json | 5 +- .../Discovery_Query_PaginationLastPage.json | 5 +- .../Discovery_Query_SystemTime.json | 3 + .../2023-09-01/Discovery_Query_Taxonomy.json | 10 +++- .../Discovery_Query_TermAssignment.json | 4 ++ .../2023-09-01/Discovery_Query_Type.json | 4 +- .../2023-09-01/Discovery_Suggest.json | 4 +- .../models.tsp | 16 ++++- .../examples/Discovery_AutoComplete.json | 4 +- .../2023-09-01/examples/Discovery_Query.json | 5 +- .../examples/Discovery_Query_And.json | 5 +- .../examples/Discovery_Query_AndOrNested.json | 8 ++- .../examples/Discovery_Query_AssetType.json | 28 +++++++++ .../examples/Discovery_Query_Attribute.json | 4 ++ ...overy_Query_BusinessMetadataAttribute.json | 5 ++ .../Discovery_Query_Classification.json | 1 + .../examples/Discovery_Query_Collection.json | 1 + .../examples/Discovery_Query_Facet.json | 1 + .../Discovery_Query_FileExtension.json | 2 + .../Discovery_Query_GlossaryTerm.json | 5 ++ .../examples/Discovery_Query_Id.json | 2 + .../examples/Discovery_Query_Not.json | 4 +- .../examples/Discovery_Query_ObjectType.json | 59 +++++++++++-------- ...very_Query_PaginationContinuationPage.json | 5 +- .../Discovery_Query_PaginationFirstPage.json | 5 +- .../Discovery_Query_PaginationLastPage.json | 5 +- .../examples/Discovery_Query_SystemTime.json | 3 + .../examples/Discovery_Query_Taxonomy.json | 10 +++- .../Discovery_Query_TermAssignment.json | 4 ++ .../examples/Discovery_Query_Type.json | 4 +- .../examples/Discovery_Suggest.json | 4 +- .../stable/2023-09-01/openapi.json | 24 ++++++++ 48 files changed, 313 insertions(+), 75 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json index 2c6462c735ab..555ee4e7b9ac 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json @@ -4,9 +4,11 @@ "autoCompleteRequest": { "keywords": "exa", "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path", + "kind": "TypeFilter", + "typeName": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json index 24ef568e34e7..4ce2b6deb104 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json index 858d8fec1f54..e3390d1ef012 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json @@ -5,11 +5,14 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" }, { + "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json index 2175edbbaa01..f36aad63f5d6 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json @@ -5,23 +5,29 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" }, { + "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" }, { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { + "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "prefix", "attributeValue": "https://" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json index 15afdce1337f..86290bbcb119 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json @@ -5,86 +5,114 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "AssetTypeFilter", "assetType": "SQL Server" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Server" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Database" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Data Warehouse" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Managed Instance" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Storage Account" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Blob Storage" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Files" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Table Storage" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen1" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen2" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Cosmos DB" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Factory" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Cognitive Search" }, { + "kind": "AssetTypeFilter", "assetType": "Power BI" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Explorer" }, { + "kind": "AssetTypeFilter", "assetType": "Amazon S3" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Share" }, { + "kind": "AssetTypeFilter", "assetType": "Teradata" }, { + "kind": "AssetTypeFilter", "assetType": "SAP S4HANA" }, { + "kind": "AssetTypeFilter", "assetType": "SAP ECC" }, { + "kind": "AssetTypeFilter", "assetType": "SQL Server Integration Services" }, { + "kind": "AssetTypeFilter", "assetType": "hive" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Database for MySQL" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Database for MariaDB" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Database for PostgreSQL" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Synapse Analytics" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json index 3baee531460e..8d2fffbdbe6c 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json @@ -5,18 +5,22 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { + "kind": "AttributeFilter", "attributeName": "createTime", "operator": "ge", "attributeValue": 1545580800000 }, { + "kind": "AttributeFilter", "attributeName": "modifiedTime", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json index 1920ea21bd36..8440b75e8bb0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json @@ -5,23 +5,28 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|contains|prefix", "attributeValue": "string value" }, { + "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|gt|ge|lt|le", "attributeValue": 123 }, { + "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne", "attributeValue": true }, { + "kind": "AttributeFilter", "attributeName": ".", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json index 6b1c6113741e..e4acf8953fd9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json @@ -5,6 +5,7 @@ "keywords": null, "limit": 10, "filter": { + "kind": "ClassificationFilter", "classification": "MICROSOFT.PERSONAL.EMAIL", "includeSubClassifications": true } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json index 6c10f84bbc17..7bc0050cdbf9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json @@ -5,6 +5,7 @@ "keywords": null, "limit": 10, "filter": { + "kind": "CollectionIdFilter", "collectionId": "collectionName" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json index 4180c50799e1..7e405380bc97 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json @@ -4,6 +4,7 @@ "searchRequest": { "keywords": null, "filter": { + "kind": "ObjectTypeFilter", "objectType": "Tables" }, "limit": 10, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json index 7687c14e90fb..3d7c7df01515 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json @@ -5,8 +5,10 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { + "kind": "FileExtensionFilter", "fileExtension": "txt" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json index bc25305cc75f..88ba90fac05a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json @@ -5,16 +5,21 @@ "keywords": "", "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Glossary terms" }, { + "kind": "OrFilter", "or": [ { + "kind": "GlossaryFilter", "glossaryType": "AtlasGlossary" }, { + "kind": "GlossaryFilter", "glossaryType": "AtlasGlossaryTerm" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json index 7c4e797a0be8..e6dca741f27e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json @@ -5,8 +5,10 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { + "kind": "IdFilter", "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json index 4b861a28b2fb..839bc83a3a4d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json @@ -5,8 +5,10 @@ "keywords": null, "limit": 10, "filter": { + "kind": "NotFilter", "not": { - "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + "kind": "ClassificationFilter", + "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" } } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json index c741d8fb1bc2..b82032c0fc01 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json @@ -5,33 +5,40 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ - [ - { - "objectType": "Dashboards" - }, - { - "objectType": "Data pipelines" - }, - { - "objectType": "Files" - }, - { - "objectType": "Folders" - }, - { - "objectType": "Glossary terms" - }, - { - "objectType": "Reports" - }, - { - "objectType": "Stored procedures" - }, - { - "objectType": "Tables" - } - ] + { + "kind": "ObjectTypeFilter", + "objectType": "Dashboards" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Data pipelines" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Files" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Folders" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Glossary terms" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Reports" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Stored procedures" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Tables" + } ] } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json index 1946af0bda97..7243a95ba583 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json index 37cbd7af29b0..01f0d6d8cfc5 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json index 9d4d92d9a531..a32c0f26224b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json index 705f0bfdf7ff..11480b40e5a3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json @@ -5,14 +5,17 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "CreateTimeFilter", "createTime": { "operator": "lt", "timeThreshold": 1545580800000 } }, { + "kind": "UpdateTimeFilter", "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json index f7aac26f09f1..c9dd6fab158c 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json @@ -4,19 +4,25 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { + "kind": "NotFilter", "not": { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": "size", "operator": "eq", "attributeValue": 0 }, { + "kind": "AttributeFilter", "attributeName": "fileSize", "operator": "eq", "attributeValue": 0 @@ -25,8 +31,10 @@ } }, { + "kind": "NotFilter", "not": { - "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + "kind": "ClassificationFilter", + "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" } } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json index 5f02b441bfb6..a447c0782037 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json @@ -5,15 +5,19 @@ "keywords": "", "limit": 3, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "TermFilter", "term": "ExampleTerm" }, { + "kind": "TermFilter", "term": "ExampleTerm", "glossary": "GlossaryName" }, { + "kind": "TermFilter", "termGuid": "" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json index 473133d7d26f..4317a10b6773 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json @@ -5,9 +5,11 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path", + "kind": "TypeFilter", + "typeName": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json index 95ec0ed6f307..4540166424ee 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -4,9 +4,11 @@ "suggestRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path", + "kind": "TypeFilter", + "typeName": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 857038d037cf..f9e168b8e096 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -2158,11 +2158,25 @@ model ScanInfoFilter extends SearchFilter { model GlossaryFilter extends SearchFilter { @doc("Glossary filter for search") kind: "GlossaryFilter"; - @doc("Glossary type. Either AtlasGlossary or AtlasGlossaryType") glossaryType: string; } +@doc("Glossary term filter for search") +model TermFilter extends SearchFilter { + @doc("Term filter for search") + kind: "TermFilter"; + + @doc("Glossary name") + glossary?: string; + + @doc("Term name") + term?: string; + + @doc("Term name") + termGuid?: string; +} + @doc("Id filter for search") model IdFilter extends SearchFilter { @doc("Id filter for search") diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 2c6462c735ab..555ee4e7b9ac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -4,9 +4,11 @@ "autoCompleteRequest": { "keywords": "exa", "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path", + "kind": "TypeFilter", + "typeName": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 24ef568e34e7..4ce2b6deb104 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index 858d8fec1f54..e3390d1ef012 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -5,11 +5,14 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" }, { + "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index 2175edbbaa01..f36aad63f5d6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -5,23 +5,29 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" }, { + "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" }, { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { + "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "prefix", "attributeValue": "https://" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index 15afdce1337f..86290bbcb119 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -5,86 +5,114 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "AssetTypeFilter", "assetType": "SQL Server" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Server" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Database" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Data Warehouse" }, { + "kind": "AssetTypeFilter", "assetType": "Azure SQL Managed Instance" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Storage Account" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Blob Storage" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Files" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Table Storage" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen1" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen2" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Cosmos DB" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Factory" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Cognitive Search" }, { + "kind": "AssetTypeFilter", "assetType": "Power BI" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Explorer" }, { + "kind": "AssetTypeFilter", "assetType": "Amazon S3" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Data Share" }, { + "kind": "AssetTypeFilter", "assetType": "Teradata" }, { + "kind": "AssetTypeFilter", "assetType": "SAP S4HANA" }, { + "kind": "AssetTypeFilter", "assetType": "SAP ECC" }, { + "kind": "AssetTypeFilter", "assetType": "SQL Server Integration Services" }, { + "kind": "AssetTypeFilter", "assetType": "hive" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Database for MySQL" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Database for MariaDB" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Database for PostgreSQL" }, { + "kind": "AssetTypeFilter", "assetType": "Azure Synapse Analytics" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 3baee531460e..8d2fffbdbe6c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -5,18 +5,22 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { + "kind": "AttributeFilter", "attributeName": "createTime", "operator": "ge", "attributeValue": 1545580800000 }, { + "kind": "AttributeFilter", "attributeName": "modifiedTime", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 1920ea21bd36..8440b75e8bb0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -5,23 +5,28 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|contains|prefix", "attributeValue": "string value" }, { + "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|gt|ge|lt|le", "attributeValue": 123 }, { + "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne", "attributeValue": true }, { + "kind": "AttributeFilter", "attributeName": ".", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 6b1c6113741e..e4acf8953fd9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -5,6 +5,7 @@ "keywords": null, "limit": 10, "filter": { + "kind": "ClassificationFilter", "classification": "MICROSOFT.PERSONAL.EMAIL", "includeSubClassifications": true } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 6c10f84bbc17..7bc0050cdbf9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -5,6 +5,7 @@ "keywords": null, "limit": 10, "filter": { + "kind": "CollectionIdFilter", "collectionId": "collectionName" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index 4180c50799e1..7e405380bc97 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -4,6 +4,7 @@ "searchRequest": { "keywords": null, "filter": { + "kind": "ObjectTypeFilter", "objectType": "Tables" }, "limit": 10, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 7687c14e90fb..3d7c7df01515 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -5,8 +5,10 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { + "kind": "FileExtensionFilter", "fileExtension": "txt" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index bc25305cc75f..88ba90fac05a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -5,16 +5,21 @@ "keywords": "", "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Glossary terms" }, { + "kind": "OrFilter", "or": [ { + "kind": "GlossaryFilter", "glossaryType": "AtlasGlossary" }, { + "kind": "GlossaryFilter", "glossaryType": "AtlasGlossaryTerm" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index 7c4e797a0be8..e6dca741f27e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -5,8 +5,10 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { + "kind": "IdFilter", "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 4b861a28b2fb..839bc83a3a4d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -5,8 +5,10 @@ "keywords": null, "limit": 10, "filter": { + "kind": "NotFilter", "not": { - "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + "kind": "ClassificationFilter", + "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" } } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index c741d8fb1bc2..b82032c0fc01 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -5,33 +5,40 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ - [ - { - "objectType": "Dashboards" - }, - { - "objectType": "Data pipelines" - }, - { - "objectType": "Files" - }, - { - "objectType": "Folders" - }, - { - "objectType": "Glossary terms" - }, - { - "objectType": "Reports" - }, - { - "objectType": "Stored procedures" - }, - { - "objectType": "Tables" - } - ] + { + "kind": "ObjectTypeFilter", + "objectType": "Dashboards" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Data pipelines" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Files" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Folders" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Glossary terms" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Reports" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Stored procedures" + }, + { + "kind": "ObjectTypeFilter", + "objectType": "Tables" + } ] } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index 1946af0bda97..7243a95ba583 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 37cbd7af29b0..01f0d6d8cfc5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 9d4d92d9a531..a32c0f26224b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -4,12 +4,15 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "entityType": "azure_blob_path" + "kind": "TypeFilter", + "typeName": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index 705f0bfdf7ff..11480b40e5a3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -5,14 +5,17 @@ "keywords": null, "limit": 10, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "CreateTimeFilter", "createTime": { "operator": "lt", "timeThreshold": 1545580800000 } }, { + "kind": "UpdateTimeFilter", "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index f7aac26f09f1..c9dd6fab158c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -4,19 +4,25 @@ "searchRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { + "kind": "ObjectTypeFilter", "objectType": "Files" }, { + "kind": "NotFilter", "not": { + "kind": "OrFilter", "or": [ { + "kind": "AttributeFilter", "attributeName": "size", "operator": "eq", "attributeValue": 0 }, { + "kind": "AttributeFilter", "attributeName": "fileSize", "operator": "eq", "attributeValue": 0 @@ -25,8 +31,10 @@ } }, { + "kind": "NotFilter", "not": { - "classification": "MICROSOFT.SYSTEM.TEMP_FILE" + "kind": "ClassificationFilter", + "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" } } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 5f02b441bfb6..a447c0782037 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -5,15 +5,19 @@ "keywords": "", "limit": 3, "filter": { + "kind": "OrFilter", "or": [ { + "kind": "TermFilter", "term": "ExampleTerm" }, { + "kind": "TermFilter", "term": "ExampleTerm", "glossary": "GlossaryName" }, { + "kind": "TermFilter", "termGuid": "" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index 473133d7d26f..4317a10b6773 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -5,9 +5,11 @@ "keywords": null, "limit": 10, "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path", + "kind": "TypeFilter", + "typeName": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index 95ec0ed6f307..4540166424ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -4,9 +4,11 @@ "suggestRequest": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { - "entityType": "azure_blob_path", + "kind": "TypeFilter", + "typeName": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 68957d786311..0eba6a93bc6e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -8972,6 +8972,30 @@ } } }, + "TermFilter": { + "type": "object", + "description": "Glossary term filter for search", + "properties": { + "glossary": { + "type": "string", + "description": "Glossary name" + }, + "term": { + "type": "string", + "description": "Term name" + }, + "termGuid": { + "type": "string", + "description": "Term name" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "TermFilter" + }, "TermSearchResultValue": { "type": "object", "description": "The context.", From 9155626f7db1caa830b6f7c02f5fc05bfed27cd0 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 7 Dec 2023 10:49:58 +0800 Subject: [PATCH 057/132] update search filter --- .../2023-09-01/Discovery_AutoComplete.json | 4 +- .../examples/2023-09-01/Discovery_Query.json | 4 +- .../2023-09-01/Discovery_Query_And.json | 4 +- .../Discovery_Query_AndOrNested.json | 4 +- .../2023-09-01/Discovery_Query_Not.json | 2 +- ...very_Query_PaginationContinuationPage.json | 4 +- .../Discovery_Query_PaginationFirstPage.json | 4 +- .../Discovery_Query_PaginationLastPage.json | 4 +- .../2023-09-01/Discovery_Query_Taxonomy.json | 2 +- .../2023-09-01/Discovery_Query_Type.json | 4 +- .../2023-09-01/Discovery_Suggest.json | 4 +- .../models.tsp | 13 ++--- .../examples/Discovery_AutoComplete.json | 4 +- .../2023-09-01/examples/Discovery_Query.json | 4 +- .../examples/Discovery_Query_And.json | 4 +- .../examples/Discovery_Query_AndOrNested.json | 4 +- .../examples/Discovery_Query_Not.json | 2 +- ...very_Query_PaginationContinuationPage.json | 4 +- .../Discovery_Query_PaginationFirstPage.json | 4 +- .../Discovery_Query_PaginationLastPage.json | 4 +- .../examples/Discovery_Query_Taxonomy.json | 2 +- .../examples/Discovery_Query_Type.json | 4 +- .../examples/Discovery_Suggest.json | 4 +- .../stable/2023-09-01/openapi.json | 51 +++++++++---------- 24 files changed, 72 insertions(+), 72 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json index 555ee4e7b9ac..c72ac2ff8bc7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json @@ -7,8 +7,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path", + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json index 4ce2b6deb104..492831046ac5 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json index e3390d1ef012..7e22975d4398 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json @@ -8,8 +8,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" }, { "kind": "AttributeFilter", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json index f36aad63f5d6..3a9ae834aca7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json @@ -8,8 +8,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" }, { "kind": "AttributeFilter", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json index 839bc83a3a4d..f83d9c4fe8ff 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json @@ -8,7 +8,7 @@ "kind": "NotFilter", "not": { "kind": "ClassificationFilter", - "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json index 7243a95ba583..b31d7c5ec0c5 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json index 01f0d6d8cfc5..9850911bcf03 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json index a32c0f26224b..5662bc6bfdcb 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json index c9dd6fab158c..bd3d05a55ad5 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json @@ -34,7 +34,7 @@ "kind": "NotFilter", "not": { "kind": "ClassificationFilter", - "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json index 4317a10b6773..3d26b95cffed 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json @@ -8,8 +8,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path", + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json index 4540166424ee..b39d1fb4f0ef 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -7,8 +7,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path", + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index f9e168b8e096..2a15e21d1be1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -2035,8 +2035,9 @@ model AttributeFilter extends SearchFilter { @doc("Operator") operator: SearchFilterOperator; + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("Attribute value") - attributeValue: string; + attributeValue: unknown; } @doc("Classification type filter for search") @@ -2045,7 +2046,7 @@ model ClassificationFilter extends SearchFilter { kind: "ClassificationFilter"; @doc("Classification name") - classificationName: string; + classification: string; @doc("Whether to include sub classifications") includeSubClassifications?: boolean; @@ -2186,13 +2187,13 @@ model IdFilter extends SearchFilter { id: string; } -@doc("Type filter for search") -model TypeFilter extends SearchFilter { +@doc("Entity type filter for search") +model EntityTypeFilter extends SearchFilter { @doc("Type filter for search") - kind: "TypeFilter"; + kind: "EntityTypeFilter"; @doc("Type name") - typeName: string; + entityType: string; @doc("Whether to include sub types") includeSubTypes?: boolean; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 555ee4e7b9ac..c72ac2ff8bc7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -7,8 +7,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path", + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 4ce2b6deb104..492831046ac5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index e3390d1ef012..7e22975d4398 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -8,8 +8,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" }, { "kind": "AttributeFilter", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index f36aad63f5d6..3a9ae834aca7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -8,8 +8,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" }, { "kind": "AttributeFilter", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 839bc83a3a4d..f83d9c4fe8ff 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -8,7 +8,7 @@ "kind": "NotFilter", "not": { "kind": "ClassificationFilter", - "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index 7243a95ba583..b31d7c5ec0c5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 01f0d6d8cfc5..9850911bcf03 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index a32c0f26224b..5662bc6bfdcb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -11,8 +11,8 @@ "objectType": "Files" }, { - "kind": "TypeFilter", - "typeName": "azure_blob_path" + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path" } ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index c9dd6fab158c..bd3d05a55ad5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -34,7 +34,7 @@ "kind": "NotFilter", "not": { "kind": "ClassificationFilter", - "classificationName": "MICROSOFT.SYSTEM.TEMP_FILE" + "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index 4317a10b6773..3d26b95cffed 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -8,8 +8,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path", + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index 4540166424ee..b39d1fb4f0ef 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -7,8 +7,8 @@ "kind": "AndFilter", "and": [ { - "kind": "TypeFilter", - "typeName": "azure_blob_path", + "kind": "EntityTypeFilter", + "entityType": "azure_blob_path", "includeSubTypes": false } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 0eba6a93bc6e..fe645835f07f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -7243,7 +7243,6 @@ "description": "Operator" }, "attributeValue": { - "type": "string", "description": "Attribute value" } }, @@ -7433,7 +7432,7 @@ "type": "object", "description": "Classification type filter for search", "properties": { - "classificationName": { + "classification": { "type": "string", "description": "Classification name" }, @@ -7443,7 +7442,7 @@ } }, "required": [ - "classificationName" + "classification" ], "allOf": [ { @@ -7668,6 +7667,29 @@ } } }, + "EntityTypeFilter": { + "type": "object", + "description": "Entity type filter for search", + "properties": { + "entityType": { + "type": "string", + "description": "Type name" + }, + "includeSubTypes": { + "type": "boolean", + "description": "Whether to include sub types" + } + }, + "required": [ + "entityType" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchFilter" + } + ], + "x-ms-discriminator-value": "EntityTypeFilter" + }, "ExistsFilter": { "type": "object", "description": "Exists filter for search", @@ -9251,29 +9273,6 @@ ] } }, - "TypeFilter": { - "type": "object", - "description": "Type filter for search", - "properties": { - "typeName": { - "type": "string", - "description": "Type name" - }, - "includeSubTypes": { - "type": "boolean", - "description": "Whether to include sub types" - } - }, - "required": [ - "typeName" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "TypeFilter" - }, "Typedef": { "type": "string", "description": "Type", From 52aed9ca6596e15bc6c5b6df161e596c805a7930 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 7 Dec 2023 11:53:27 +0800 Subject: [PATCH 058/132] update model name --- .../models.tsp | 37 ++- .../routes.tsp | 38 ++-- .../stable/2023-09-01/openapi.json | 212 ++++++++---------- 3 files changed, 123 insertions(+), 164 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 2a15e21d1be1..8c76c198a2a2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -114,18 +114,6 @@ enum StatusAtlasRelationship { DELETED, } -@doc("Direction") -enum Direction { - @doc("both") - BOTH, - - @doc("input") - INPUT, - - @doc("output") - OUTPUT, -} - @doc("Lineage direction") enum LineageDirection { @doc("input") @@ -223,7 +211,7 @@ enum RelationshipCategory { } @doc("Type") -enum Typedef { +enum TypeDef { @doc("enum") `enum`, @@ -458,8 +446,8 @@ model AtlasEntityExtInfo { referredEntities?: Record; } -@doc("The mutation response of entity.") -model EntityMutationResponse { +@doc("The mutation response result of entity.") +model EntityMutationResult { @doc("A map of GUID assignments with entities.") guidAssignments?: Record; @@ -529,8 +517,8 @@ model AtlasEntitiesWithExtInfo { entities?: AtlasEntity[]; } -@doc("The request for classification association.") -model ClassificationAssociateRequest { +@doc("The request content for classification association.") +model ClassificationAssociateContent { @doc(""" An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. @@ -576,8 +564,8 @@ model AtlasEntityHeaders { guidHeaderMap?: Record; } -@doc("example") -model BulkImportResponse { +@doc("Bulk import result") +model BulkImportResult { @doc("failed importInfoList") failedImportInfoList?: ImportInfo[]; @@ -600,8 +588,8 @@ model ImportInfo { remarks?: string; } -@doc("MoveEntitiesRequest") -model MoveEntitiesRequest { +@doc("MoveEntitiesContent") +model MoveEntitiesContent { @doc("An array of entity guids to be moved to target collection.") entityGuids?: string[]; } @@ -930,7 +918,7 @@ model AtlasGlossaryExtInfo { } @doc("The search query of advanced search request.") -model SearchRequest { +model SearchContent { @doc("The keywords applied to all searchable fields.") keywords?: string; @@ -1210,7 +1198,7 @@ Expert or Steward for a glossary term. } @doc("The query of suggest request.") -model SuggestRequest { +model SuggestContent { @doc(""" 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 @@ -1319,7 +1307,7 @@ AtlasGlossaryCategory. } @doc("The query of autocomplete request.") -model AutoCompleteRequest { +model AutoCompleteContent { @doc(""" The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. @@ -2159,6 +2147,7 @@ model ScanInfoFilter extends SearchFilter { model GlossaryFilter extends SearchFilter { @doc("Glossary filter for search") kind: "GlossaryFilter"; + @doc("Glossary type. Either AtlasGlossary or AtlasGlossaryType") glossaryType: string; } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 1666aea0cba9..709261561c26 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -95,7 +95,7 @@ need to move an entity to another collection. @body entity: AtlasEntityWithExtInfo; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -159,7 +159,7 @@ entities. @body entities: AtlasEntitiesWithExtInfo; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -180,7 +180,7 @@ attributes. }) guid: string[]; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -193,7 +193,7 @@ attributes. { @doc("The request to associate a classification to multiple entities.") @body - request: ClassificationAssociateRequest; + request: ClassificationAssociateContent; }, void, {}, @@ -248,7 +248,7 @@ Null updates are not possible. @body body: unknown; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -263,7 +263,7 @@ Null updates are not possible. @path guid: string; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -444,7 +444,7 @@ be changed to other unique attributes) @body atlasEntityWithExtInfo: AtlasEntityWithExtInfo; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -479,7 +479,7 @@ be changed to other unique attributes) @query("attr:qualifiedName") attr?: string; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -769,7 +769,7 @@ default is false. @doc("InputStream of file") uploadedInputStream: bytes; }, - BulkImportResponse, + BulkImportResult, MultipartFormDataRequestHeadersTraits >; @@ -972,9 +972,9 @@ be changed to other unique attributes) @doc("Entity guids to be moved to target collection.") @body - moveEntitiesRequest: MoveEntitiesRequest; + moveEntitiesRequest: MoveEntitiesContent; }, - EntityMutationResponse, + EntityMutationResult, {}, AtlasErrorResponse >; @@ -1686,7 +1686,7 @@ interface Discovery { { @doc("An object specifying the search criteria.") @body - searchRequest: SearchRequest; + searchRequest: SearchContent; }, SearchResult, {}, @@ -1701,7 +1701,7 @@ interface Discovery { { @doc("An object specifying the suggest criteria.") @body - suggestRequest: SuggestRequest; + suggestRequest: SuggestContent; }, SuggestResult, {}, @@ -1716,7 +1716,7 @@ interface Discovery { { @doc("An object specifying the autocomplete criteria.") @body - autoCompleteRequest: AutoCompleteRequest; + autoCompleteRequest: AutoCompleteContent; }, AutoCompleteResult, {}, @@ -1742,7 +1742,7 @@ interface Lineage { @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") @query - direction: Direction; + direction: LineageDirection; }, AtlasLineageInfo, {}, @@ -1761,7 +1761,7 @@ interface Lineage { @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") @query - direction: Direction; + direction: LineageDirection; @doc("The offset for pagination purpose.") @query @@ -1809,7 +1809,7 @@ GET @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") @query - direction: Direction; + direction: LineageDirection; @doc(""" The qualified name of the entity. (This is only an example. qualifiedName can @@ -2140,7 +2140,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type?: Typedef; + type?: TypeDef; }, AtlasTypesDef, {}, @@ -2215,7 +2215,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type?: Typedef; + type?: TypeDef; }, OkResponse, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index fe645835f07f..6deb60c9d999 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -113,7 +113,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -251,7 +251,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -290,7 +290,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -321,7 +321,7 @@ "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { - "$ref": "#/definitions/ClassificationAssociateRequest" + "$ref": "#/definitions/ClassificationAssociateContent" } } ], @@ -467,7 +467,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/BulkImportResponse" + "$ref": "#/definitions/BulkImportResult" } }, "default": { @@ -601,7 +601,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -636,7 +636,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -1327,7 +1327,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -1370,7 +1370,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -3169,19 +3169,14 @@ "required": true, "type": "string", "enum": [ - "BOTH", "INPUT", - "OUTPUT" + "OUTPUT", + "BOTH" ], "x-ms-enum": { - "name": "Direction", + "name": "LineageDirection", "modelAsString": true, "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, { "name": "INPUT", "value": "INPUT", @@ -3191,6 +3186,11 @@ "name": "OUTPUT", "value": "OUTPUT", "description": "output" + }, + { + "name": "BOTH", + "value": "BOTH", + "description": "both" } ] } @@ -3247,19 +3247,14 @@ "required": true, "type": "string", "enum": [ - "BOTH", "INPUT", - "OUTPUT" + "OUTPUT", + "BOTH" ], "x-ms-enum": { - "name": "Direction", + "name": "LineageDirection", "modelAsString": true, "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, { "name": "INPUT", "value": "INPUT", @@ -3269,6 +3264,11 @@ "name": "OUTPUT", "value": "OUTPUT", "description": "output" + }, + { + "name": "BOTH", + "value": "BOTH", + "description": "both" } ] } @@ -4035,7 +4035,7 @@ "term_template" ], "x-ms-enum": { - "name": "Typedef", + "name": "TypeDef", "modelAsString": true, "values": [ { @@ -4240,7 +4240,7 @@ "term_template" ], "x-ms-enum": { - "name": "Typedef", + "name": "TypeDef", "modelAsString": true, "values": [ { @@ -4323,7 +4323,7 @@ "description": "Entity guids to be moved to target collection.", "required": true, "schema": { - "$ref": "#/definitions/MoveEntitiesRequest" + "$ref": "#/definitions/MoveEntitiesContent" } } ], @@ -4331,7 +4331,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { @@ -4370,19 +4370,14 @@ "required": true, "type": "string", "enum": [ - "BOTH", "INPUT", - "OUTPUT" + "OUTPUT", + "BOTH" ], "x-ms-enum": { - "name": "Direction", + "name": "LineageDirection", "modelAsString": true, "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, { "name": "INPUT", "value": "INPUT", @@ -4392,6 +4387,11 @@ "name": "OUTPUT", "value": "OUTPUT", "description": "output" + }, + { + "name": "BOTH", + "value": "BOTH", + "description": "both" } ] } @@ -4448,7 +4448,7 @@ "description": "An object specifying the autocomplete criteria.", "required": true, "schema": { - "$ref": "#/definitions/AutoCompleteRequest" + "$ref": "#/definitions/AutoCompleteContent" } } ], @@ -4487,7 +4487,7 @@ "description": "An object specifying the search criteria.", "required": true, "schema": { - "$ref": "#/definitions/SearchRequest" + "$ref": "#/definitions/SearchContent" } } ], @@ -4586,7 +4586,7 @@ "description": "An object specifying the suggest criteria.", "required": true, "schema": { - "$ref": "#/definitions/SuggestRequest" + "$ref": "#/definitions/SuggestContent" } } ], @@ -7258,7 +7258,7 @@ ], "x-ms-discriminator-value": "AttributeFilter" }, - "AutoCompleteRequest": { + "AutoCompleteContent": { "type": "object", "description": "The query of autocomplete request.", "properties": { @@ -7310,9 +7310,9 @@ "format": "uuid", "description": "Universally Unique Identifier" }, - "BulkImportResponse": { + "BulkImportResult": { "type": "object", - "description": "example", + "description": "Bulk import result", "properties": { "failedImportInfoList": { "type": "array", @@ -7392,9 +7392,9 @@ ] } }, - "ClassificationAssociateRequest": { + "ClassificationAssociateContent": { "type": "object", - "description": "The request for classification association.", + "description": "The request content for classification association.", "properties": { "classification": { "$ref": "#/definitions/AtlasClassification", @@ -7586,36 +7586,6 @@ } } }, - "Direction": { - "type": "string", - "description": "Direction", - "enum": [ - "BOTH", - "INPUT", - "OUTPUT" - ], - "x-ms-enum": { - "name": "Direction", - "modelAsString": true, - "values": [ - { - "name": "BOTH", - "value": "BOTH", - "description": "both" - }, - { - "name": "INPUT", - "value": "INPUT", - "description": "input" - }, - { - "name": "OUTPUT", - "value": "OUTPUT", - "description": "output" - } - ] - } - }, "DomainIdFilter": { "type": "object", "description": "Domain id filter for search", @@ -7635,9 +7605,9 @@ ], "x-ms-discriminator-value": "DomainIdFilter" }, - "EntityMutationResponse": { + "EntityMutationResult": { "type": "object", - "description": "The mutation response of entity.", + "description": "The mutation response result of entity.", "properties": { "guidAssignments": { "type": "object", @@ -7884,9 +7854,9 @@ } } }, - "MoveEntitiesRequest": { + "MoveEntitiesContent": { "type": "object", - "description": "MoveEntitiesRequest", + "description": "MoveEntitiesContent", "properties": { "entityGuids": { "type": "array", @@ -8268,6 +8238,45 @@ ], "x-ms-discriminator-value": "ScanInfoFilter" }, + "SearchContent": { + "type": "object", + "description": "The search query of advanced search request.", + "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\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchRequestTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, "SearchFacetItem": { "type": "object", "description": "The content of a search facet result item.", @@ -8535,45 +8544,6 @@ } } }, - "SearchRequest": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchRequestTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, "SearchRequestTaxonomySetting": { "type": "object", "description": "Taxonomy setting for search request", @@ -8844,7 +8814,7 @@ ] } }, - "SuggestRequest": { + "SuggestContent": { "type": "object", "description": "The query of suggest request.", "properties": { @@ -9273,7 +9243,7 @@ ] } }, - "Typedef": { + "TypeDef": { "type": "string", "description": "Type", "enum": [ @@ -9285,7 +9255,7 @@ "term_template" ], "x-ms-enum": { - "name": "Typedef", + "name": "TypeDef", "modelAsString": true, "values": [ { From 52827f6c28df5b975f26e3b2d7ed5d3ad129db60 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 7 Dec 2023 13:18:47 +0800 Subject: [PATCH 059/132] updated --- .../models.tsp | 16 ++--- .../stable/2023-09-01/openapi.json | 69 +++++++++---------- 2 files changed, 42 insertions(+), 43 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 8c76c198a2a2..d5d77c70ba8e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -19,7 +19,7 @@ enum BusinessAttributeUpdateBehavior { } @doc("Status - can be active or deleted") -enum Status { +enum EntityStatus { @doc("The status is active.") ACTIVE, @@ -127,7 +127,7 @@ enum LineageDirection { } @doc("Cardinality") -enum Cardinality { +enum CardinalityValue { @doc("single") SINGLE, @@ -331,7 +331,7 @@ model AtlasEntity { Status of the entity - can be active or deleted. Deleted entities are not removed. """) - status?: Status; + status?: EntityStatus; @doc("The update time of the record.") updateTime?: int64; @@ -360,7 +360,7 @@ model AtlasClassification { Status of the entity - can be active or deleted. Deleted entities are not removed. """) - entityStatus?: Status; + entityStatus?: EntityStatus; @doc("Determines if propagations will be removed on entity deletion.") removePropagationsOnEntityDelete?: boolean; @@ -490,7 +490,7 @@ model AtlasEntityHeader { Status of the entity - can be active or deleted. Deleted entities are not removed. """) - status?: Status; + status?: EntityStatus; } @doc("An error response from the service") @@ -870,7 +870,7 @@ model AtlasRelatedObjectId { Status of the entity - can be active or deleted. Deleted entities are not removed. """) - entityStatus?: Status; + entityStatus?: EntityStatus; @doc("Relationship type") relationshipType?: string; @@ -1460,7 +1460,7 @@ model AtlasStructDef { @doc("class that captures details of a struct-attribute.") model AtlasAttributeDef { @doc("single-valued attribute or multi-valued attribute.") - cardinality?: Cardinality; + cardinality?: CardinalityValue; @doc("An array of constraints.") constraints?: AtlasConstraintDef[]; @@ -1824,7 +1824,7 @@ it is the container end of the relationship. """) model AtlasRelationshipEndDef { @doc("single-valued attribute or multi-valued attribute.") - cardinality?: Cardinality; + cardinality?: CardinalityValue; @doc("The description of the relationship end definition.") description?: string; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 6deb60c9d999..af09b385533d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -459,8 +459,7 @@ "in": "formData", "description": "InputStream of file", "required": true, - "type": "string", - "format": "byte" + "type": "file" } ], "responses": { @@ -4775,7 +4774,7 @@ "description": "class that captures details of a struct-attribute.", "properties": { "cardinality": { - "$ref": "#/definitions/Cardinality", + "$ref": "#/definitions/CardinalityValue", "description": "single-valued attribute or multi-valued attribute." }, "constraints": { @@ -5013,7 +5012,7 @@ "description": "The GUID of the entity." }, "entityStatus": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/EntityStatus", "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "removePropagationsOnEntityDelete": { @@ -5290,7 +5289,7 @@ "additionalProperties": {} }, "status": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/EntityStatus", "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "updateTime": { @@ -5497,7 +5496,7 @@ "x-ms-identifiers": [] }, "status": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/EntityStatus", "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." } } @@ -6417,7 +6416,7 @@ "description": "The display text." }, "entityStatus": { - "$ref": "#/definitions/Status", + "$ref": "#/definitions/EntityStatus", "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "relationshipType": { @@ -6548,7 +6547,7 @@ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { "cardinality": { - "$ref": "#/definitions/Cardinality", + "$ref": "#/definitions/CardinalityValue", "description": "single-valued attribute or multi-valued attribute." }, "constraints": { @@ -6715,7 +6714,7 @@ "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { "cardinality": { - "$ref": "#/definitions/Cardinality", + "$ref": "#/definitions/CardinalityValue", "description": "single-valued attribute or multi-valued attribute." }, "description": { @@ -7362,7 +7361,7 @@ ] } }, - "Cardinality": { + "CardinalityValue": { "type": "string", "description": "Cardinality", "enum": [ @@ -7371,7 +7370,7 @@ "SET" ], "x-ms-enum": { - "name": "Cardinality", + "name": "CardinalityValue", "modelAsString": true, "values": [ { @@ -7637,6 +7636,30 @@ } } }, + "EntityStatus": { + "type": "string", + "description": "Status - can be active or deleted", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "DELETED", + "value": "DELETED", + "description": "The status is deleted." + } + ] + } + }, "EntityTypeFilter": { "type": "object", "description": "Entity type filter for search", @@ -8766,30 +8789,6 @@ ] } }, - "Status": { - "type": "string", - "description": "Status - can be active or deleted", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true, - "values": [ - { - "name": "ACTIVE", - "value": "ACTIVE", - "description": "The status is active." - }, - { - "name": "DELETED", - "value": "DELETED", - "description": "The status is deleted." - } - ] - } - }, "StatusAtlasRelationship": { "type": "string", "description": "Status for atlas relationship", From 71cad01600784b9c2f550fa48f6b3ffafda2977e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 8 Dec 2023 10:15:00 +0800 Subject: [PATCH 060/132] update client.tsp --- .../{routes.tsp => client.tsp} | 9 +++++---- .../purview/Azure.Analytics.Purview.DataMap/main.tsp | 2 +- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 2 +- .../stable/2023-09-01/openapi.json | 6 +++--- 4 files changed, 10 insertions(+), 9 deletions(-) rename specification/purview/Azure.Analytics.Purview.DataMap/{routes.tsp => client.tsp} (99%) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp similarity index 99% rename from specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp rename to specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 709261561c26..f2480a3928df 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -4,6 +4,7 @@ import "@typespec/http"; import "@typespec/versioning"; import "@typespec/rest"; import "./models.tsp"; +import "./main.tsp"; using TypeSpec.Rest; using TypeSpec.Http; @@ -13,10 +14,6 @@ using Azure.Core.Traits; using Azure.Core.Traits.Private; using Azure.ClientGenerator.Core; -@client({ - name: "PurviewDataMapClient", - service: PurviewDataMap, -}) namespace PurviewDataMap; model OkResponse { @@ -61,6 +58,10 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr contentType: "multipart/form-data"; }>; +@client({ + name: "PurviewDataMapClient", + service: PurviewDataMap, +}) @operationGroup interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 33b774fd1f62..47fd9ddcf6cd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -1,6 +1,6 @@ import "@typespec/rest"; import "@typespec/http"; -import "./routes.tsp"; +import "./client.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index d5d77c70ba8e..94ce8d40c80e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -837,7 +837,7 @@ model PurviewObjectId { @doc("Reference to an object-instance of a type - like entity.") model AtlasObjectId { @doc("The GUID of the object.") - guid?: Azure.Core.uuid; + guid?: string; @doc("The name of the type.") typeName?: string; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index af09b385533d..a69eebbe2b7a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -6354,7 +6354,7 @@ "description": "Reference to an object-instance of a type - like entity.", "properties": { "guid": { - "$ref": "#/definitions/Azure.Core.uuid", + "type": "string", "description": "The GUID of the object." }, "typeName": { @@ -6399,7 +6399,7 @@ "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", "properties": { "guid": { - "$ref": "#/definitions/Azure.Core.uuid", + "type": "string", "description": "The GUID of the object." }, "typeName": { @@ -8102,7 +8102,7 @@ "description": "PurviewObjectId", "properties": { "guid": { - "$ref": "#/definitions/Azure.Core.uuid", + "type": "string", "description": "The GUID of the object." }, "typeName": { From 5b6d26ef86b291676dda8f6b97ac1b1a7895b797 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 8 Dec 2023 16:32:37 +0800 Subject: [PATCH 061/132] Update client.tsp --- .../client.tsp | 28 ++++++++++++++----- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index f2480a3928df..a1e02e82b809 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -59,10 +59,9 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr }>; @client({ - name: "PurviewDataMapClient", + name: "EntityClient", service: PurviewDataMap, }) -@operationGroup interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -981,7 +980,10 @@ be changed to other unique attributes) >; } -@operationGroup +@client({ + name: "GlossaryClient", + service: PurviewDataMap, +}) interface Glossary { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" @@ -1677,7 +1679,10 @@ to get pagination result. >; } -@operationGroup +@client({ + name: "DiscoveryClient", + service: PurviewDataMap, +}) interface Discovery { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @doc("Get data using search.") @@ -1725,7 +1730,10 @@ interface Discovery { >; } -@operationGroup +@client({ + name: "LineageClient", + service: PurviewDataMap, +}) interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get lineage info of the entity specified by GUID.") @@ -1825,7 +1833,10 @@ be changed to other unique attributes) >; } -@operationGroup +@client({ + name: "RelationshipClient", + service: PurviewDataMap, +}) interface Relationship { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Create a new relationship between entities.") @@ -1898,7 +1909,10 @@ be created. >; } -@operationGroup +@client({ + name: "TypeClient", + service: PurviewDataMap, +}) interface Type { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the businessMetadata definition for the given guid.") From a08914f7f5c9b8efdc30e53108c09fc27c7d1719 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 8 Dec 2023 17:23:57 +0800 Subject: [PATCH 062/132] update client.tsp --- .../client.tsp | 2299 +---------------- .../Azure.Analytics.Purview.DataMap/main.tsp | 2 +- .../routes.tsp | 2245 ++++++++++++++++ 3 files changed, 2282 insertions(+), 2264 deletions(-) create mode 100644 specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index a1e02e82b809..46d13a4db873 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -1,2269 +1,42 @@ -import "@azure-tools/typespec-azure-core"; -import "@azure-tools/typespec-client-generator-core"; -import "@typespec/http"; -import "@typespec/versioning"; -import "@typespec/rest"; -import "./models.tsp"; import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; -using TypeSpec.Rest; -using TypeSpec.Http; -using TypeSpec.Versioning; -using Azure.Core; -using Azure.Core.Traits; -using Azure.Core.Traits.Private; using Azure.ClientGenerator.Core; namespace PurviewDataMap; -model OkResponse { - @statusCode - status: 200; - - @body - data: T; -} - -op AtlasImportOperation< - TParams extends TypeSpec.Reflection.Model, - TResponse extends TypeSpec.Reflection.Model, - Traits extends TypeSpec.Reflection.Model = {}, - TraitContexts extends TraitContext = TraitContext.Undefined -> is Azure.Core.Foundations.Operation< - TParams & - TraitProperties< - Traits & - NoConditionalRequests & - NoRepeatableRequests & - NoClientRequestId, - TraitLocation.Parameters, - TraitContext.Action - >, - TResponse & - TraitProperties< - Traits & - NoConditionalRequests & - NoRepeatableRequests & - NoClientRequestId, - TraitLocation.Response, - TraitContext.Action - >, - Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, - AtlasErrorResponse ->; - -alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ - @doc("The content type for the operation. Always multipart/form-data for this operation.") - @header("content-type") - contentType: "multipart/form-data"; -}>; - -@client({ - name: "EntityClient", - service: PurviewDataMap, -}) -interface Entity { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Create or update an entity. -Existing entity is matched using its unique guid if -supplied or by its unique attributes eg: qualifiedName. -Map and array of -collections are not well supported. E.g., array>, array>. -For each contact type, the maximum number of contacts is 20. -""") - @route("/atlas/v2/entity") - @post - createOrUpdate is Azure.Core.Foundations.Operation< - { - @doc(""" -Used to define the update behavior for business attributes when updating -entities. -""") - @query - businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; - - @doc(""" -The collection where entities will be moved to. Only specify a value if you -need to move an entity to another collection. -""") - @query - collectionId?: string; - - @doc("Atlas entity with extended information.") - @body - entity: AtlasEntityWithExtInfo; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" - @doc("List entities in bulk identified by its GUIDs.") - @route("/atlas/v2/entity/bulk") - @get - listByGuids is Azure.Core.Foundations.Operation< - { - @doc("An array of GUIDs of entities to list.") - @query({ - format: "multi", - }) - guid: string[]; - - @doc("Whether to return minimal information for referred entities.") - @query - minExtInfo?: boolean; - - @doc("Whether to ignore relationship attributes.") - @query - ignoreRelationships?: boolean; - }, - AtlasEntitiesWithExtInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Create or update entities in bulk. -Existing entity is matched using its unique -guid if supplied or by its unique attributes eg: qualifiedName. -Map and array -of collections are not well supported. E.g., array>, -array>. -For each contact type, the maximum number of contacts -is 20. -""") - @route("/atlas/v2/entity/bulk") - @post - bulkCreateOrUpdate is Azure.Core.Foundations.Operation< - { - @doc(""" -The collection where entities will be moved to. Only specify a value if you -need to move an entity to another collection. -""") - @query - collectionId?: string; - - @doc(""" -Used to define the update behavior for business attributes when updating -entities. -""") - @query - businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; - - @doc("An array of entities to create or update.") - @body - entities: AtlasEntitiesWithExtInfo; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Delete a list of entities in bulk identified by their GUIDs or unique -attributes. -""") - @route("/atlas/v2/entity/bulk") - @delete - bulkDelete is Azure.Core.Foundations.Operation< - { - @doc("An array of GUIDs of entities to delete.") - @query({ - format: "multi", - }) - guid: string[]; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Associate a classification to multiple entities in bulk.") - @route("/atlas/v2/entity/bulk/classification") - @post - addClassification is Azure.Core.Foundations.Operation< - { - @doc("The request to associate a classification to multiple entities.") - @body - request: ClassificationAssociateContent; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get complete definition of an entity given its GUID.") - @route("/atlas/v2/entity/guid/{guid}") - @get - get is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("Whether to return minimal information for referred entities.") - @query - minExtInfo?: boolean; - - @doc("Whether to ignore relationship attributes.") - @query - ignoreRelationships?: boolean; - }, - AtlasEntityWithExtInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Update entity partially - create or update entity attribute identified by its -GUID. -Supports only primitive attribute type and entity references. -It does not support updating complex types like arrays, and maps. -Null updates are not possible. -""") - @route("/atlas/v2/entity/guid/{guid}") - @put - partialUpdateAttributeByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("The name of the attribute.") - @query - name: string; - - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" - @doc("The value of the attribute.") - @body - body: unknown; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete an entity identified by its GUID.") - @route("/atlas/v2/entity/guid/{guid}") - @delete - delete is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get classification for a given entity represented by a GUID.") - @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") - @get - getClassification is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("The name of the classification.") - @path - classificationName: string; - }, - AtlasClassification, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete a given classification from an existing entity represented by a GUID.") - @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") - @delete - removeClassification is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("The name of the classification.") - @path - classificationName: string; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("List classifications for a given entity represented by a GUID.") - @route("/atlas/v2/entity/guid/{guid}/classifications") - @get - getClassifications is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - }, - AtlasClassifications, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Add classifications to an existing entity represented by a GUID.") - @route("/atlas/v2/entity/guid/{guid}/classifications") - @post - addClassifications is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("An array of classifications to be added.") - @body - classifications: AtlasClassification[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Update classifications to an existing entity represented by a guid.") - @route("/atlas/v2/entity/guid/{guid}/classifications") - @put - updateClassifications is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("An array of classifications to be updated.") - @body - classifications: AtlasClassification[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get complete definition of an entity given its type and unique attribute. - -In -addition to the typeName path parameter, attribute key-value pair(s) can be -provided in the following format: -attr:\\=. - -NOTE: The -attrName and attrValue should be unique across entities, eg. -qualifiedName. - -The REST request would look something like this: -GET -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") - @get - getByUniqueAttributes is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc("Whether to return minimal information for referred entities.") - @query - minExtInfo?: boolean; - - @doc("Whether to ignore relationship attributes.") - @query - ignoreRelationships?: boolean; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - }, - AtlasEntityWithExtInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Update entity partially - Allow a subset of attributes to be updated on an -entity which is identified by its type and unique attribute eg: -Referenceable.qualifiedName. Null updates are not possible. - -In addition to the -typeName path parameter, attribute key-value pair(s) can be provided in the -following format: - -attr:=. -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: -PUT -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") - @put - partialUpdateByUniqueAttributes is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - - @doc("Atlas entity with extended information.") - @body - atlasEntityWithExtInfo: AtlasEntityWithExtInfo; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Delete an entity identified by its type and unique attributes. -In addition to -the typeName path parameter, attribute key-value pair(s) can be provided in the -following format: -attr:\\=\\. -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: -DELETE -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") - @delete - deleteByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Delete a given classification from an entity identified by its type and unique -attributes. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") - @delete - removeClassificationByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc("The name of the classification.") - @path - classificationName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Add classification to the entity identified by its type and unique attributes.") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") - @post - addClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - - @doc("An array of classification to be added.") - @body - atlasClassificationArray: AtlasClassification[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Update classification on an entity identified by its type and unique attributes.") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") - @put - updateClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - - @doc("An array of classification to be updated.") - @body - atlasClassificationArray: AtlasClassification[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Set classifications on entities in bulk.") - @route("/atlas/v2/entity/bulk/setClassifications") - @post - bulkSetClassifications is Azure.Core.Foundations.Operation< - { - @doc("Atlas entity headers.") - @body - entityHeaders: AtlasEntityHeaders; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/casing-style" "This is Atlas API behavior" - @doc(""" -Bulk API to retrieve list of entities identified by its unique attributes. -In -addition to the typeName path parameter, attribute key-value pair(s) can be -provided in the following -format - -typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\ - -NOTE: -The attrName should be an unique attribute for the given entity-type. -The REST -request would look something like this - -GET -/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 - -Note: -at least one unique attribute must be provided. -""") - @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") - @get - listByUniqueAttributes is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc("Whether to return minimal information for referred entities.") - @query - minExtInfo?: boolean; - - @doc("Whether to ignore relationship attributes.") - @query - ignoreRelationships?: boolean; - - @doc(""" -Qualified name of an entity. E.g. to find 2 entities you can set -attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an -example. qualifiedName can be changed to other unique attributes) -""") - @query - `attr_N:qualifiedName`?: string; - }, - AtlasEntitiesWithExtInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get entity header given its GUID.") - @route("/atlas/v2/entity/guid/{guid}/header") - @get - getHeader is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - }, - AtlasEntityHeader, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Remove business metadata from an entity.") - @route("/atlas/v2/entity/guid/{guid}/businessmetadata") - @delete - removeBusinessMetadata is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @doc("Business metadata payload") - @body - businessMetadata: Record>; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Add business metadata to an entity.") - @route("/atlas/v2/entity/guid/{guid}/businessmetadata") - @post - addOrUpdateBusinessMetadata is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc(""" -Whether to overwrite the existing business metadata on the entity or not, -default is false. -""") - @query - isOverwrite?: boolean; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @doc("BusinessMetadata payload") - @body - businessMetadata: Record>; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" - @doc("Delete business metadata attributes from an entity.") - @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") - @delete - removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< - { - @doc("BusinessMetadata name") - @path - bmName: string; - - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @doc("Business metadata attribute payload") - @body - businessMetadataAttributes: Record; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @doc("Add or update business metadata attributes.") - @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") - @post - addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< - { - @doc("BusinessMetadata name") - @path - bmName: string; - - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" - @doc("Business metadata attribute payload") - @body - businessMetadataAttributes: Record; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") - @route("/atlas/v2/entity/businessmetadata/import/template") - @get - getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation< - {}, - { - @header contentType: "application/octet-stream"; - @body template: bytes; - }, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Upload the file for creating Business Metadata in BULK") - @route("/atlas/v2/entity/businessmetadata/import") - @post - importBusinessMetadata is AtlasImportOperation< - { - @doc("InputStream of file") - uploadedInputStream: bytes; - }, - BulkImportResult, - MultipartFormDataRequestHeadersTraits - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete given labels to a given entity.") - @route("/atlas/v2/entity/guid/{guid}/labels") - @delete - removeLabels is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("set of labels to be deleted") - @body - body: string[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Set labels to a given entity.") - @route("/atlas/v2/entity/guid/{guid}/labels") - @post - setLabels is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("set of labels to be set to the entity") - @body - body: string[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Add given labels to a given entity.") - @route("/atlas/v2/entity/guid/{guid}/labels") - @put - addLabel is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("set of labels to be added") - @body - body: string[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Delete given labels to a given entity identified by its type and unique -attribute. - -If labels is null/empty, no labels will be removed. - -If any labels -in labels set are non-existing labels, they will be ignored, only existing -labels will be removed. In addition to the typeName path parameter, attribute -key-value pair(s) can be provided in the following format: -attr:=. NOTE: The attrName and attrValue should be unique -across entities, eg. qualifiedName. The REST request would look something like -this: DELETE -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") - @delete - removeLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - - @doc("set of labels to be deleted") - @body - body: string[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Set labels to a given entity identified by its type and unique attributes. - -If -labels is null/empty, existing labels will all be removed. - -In addition to the -typeName path parameter, attribute key-value pair(s) can be provided in the -following format: attr:=. - -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: POST -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") - @post - setLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - - @doc("set of labels to be set") - @body - body: string[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Add given labels to a given entity identified by its type and unique -attributes. - -If labels is null/empty, no labels will be added. - -In addition to -the typeName path parameter, attribute key-value pair(s) can be provided in the -following format: attr:=. - -NOTE: The attrName and -attrValue should be unique across entities, eg. qualifiedName. - -The REST -request would look something like this: PUT -/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") - @put - addLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - - @doc("set of labels to be added") - @body - body: string[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Move existing entities to the target collection.") - @route("/entity/moveTo") - @post - moveEntitiesToCollection is Azure.Core.Foundations.Operation< - { - @doc("The collection where entities will be moved to.") - @query - collectionId: string; - - @doc("Entity guids to be moved to target collection.") - @body - moveEntitiesRequest: MoveEntitiesContent; - }, - EntityMutationResult, - {}, - AtlasErrorResponse - >; -} - -@client({ - name: "GlossaryClient", - service: PurviewDataMap, -}) -interface Glossary { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get all glossaries. Recommend using limit/offset to get pagination result. -Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories -separately using - - 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' -and - - 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'. -""") - @route("/atlas/v2/glossary") - @get - list is Azure.Core.Foundations.Operation< - { - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - - @doc("Whether ignore terms and categories") - @query - ignoreTermsAndCategories?: boolean; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Create a glossary.") - @route("/atlas/v2/glossary") - @post - create is Azure.Core.Foundations.Operation< - { - @doc(""" -Glossary definition, terms & categories can be anchored to a glossary. -Using -the anchor attribute when creating the Term/Category. -""") - @body - atlasGlossary: AtlasGlossary; - }, - AtlasGlossary, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Create glossary category in bulk.") - @route("/atlas/v2/glossary/categories") - @post - createCategories is Azure.Core.Foundations.Operation< - { - @doc("An array of glossary category definitions to be created.") - @body - glossaryCategory: AtlasGlossaryCategory[]; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Create a glossary category.") - @route("/atlas/v2/glossary/category") - @post - createCategory is Azure.Core.Foundations.Operation< - { - @doc(""" -The glossary category definition. A category must be anchored to a Glossary -when creating. -Optionally, terms belonging to the category and the hierarchy -can also be defined during creation. -""") - @body - glossaryCategory: AtlasGlossaryCategory; - }, - AtlasGlossaryCategory, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get specific glossary category by its GUID.") - @route("/atlas/v2/glossary/category/{categoryGuid}") - @get - getCategory is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the category.") - @path - categoryGuid: string; - }, - AtlasGlossaryCategory, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Update the given glossary category by its GUID.") - @route("/atlas/v2/glossary/category/{categoryGuid}") - @put - updateCategory is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the category.") - @path - categoryGuid: string; - - @doc("The glossary category to be updated.") - @body - glossaryCategory: AtlasGlossaryCategory; - }, - AtlasGlossaryCategory, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete a glossary category.") - @route("/atlas/v2/glossary/category/{categoryGuid}") - @delete - deleteCategory is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the category.") - @path - categoryGuid: string; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" - @doc(""" -Update the glossary category partially. So far we only supports partial -updating shortDescription and longDescription for category. -""") - @route("/atlas/v2/glossary/category/{categoryGuid}/partial") - @put - partialUpdateCategory is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the category.") - @path - categoryGuid: string; - - @doc(""" -A map containing keys as attribute names and values as corresponding attribute -values for partial update. -""") - @body - partialUpdates: unknown; - }, - AtlasGlossaryCategory, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get all related categories (parent and children). Limit, offset, and sort -parameters are currently not being enabled and won't work even they are passed. -""") - @route("/atlas/v2/glossary/category/{categoryGuid}/related") - @get - listRelatedCategories is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the category.") - @path - categoryGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse>, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get all terms associated with the specific category.") - @route("/atlas/v2/glossary/category/{categoryGuid}/terms") - @get - listCategoryTerms is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the category.") - @path - categoryGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Create a glossary term.") - @route("/atlas/v2/glossary/term") - @post - createTerm is Azure.Core.Foundations.Operation< - { - @doc("Whether include term hierarchy") - @query - includeTermHierarchy?: boolean; - - @doc(""" -The glossary term definition. A term must be anchored to a Glossary at the time -of creation. -Optionally it can be categorized as well. -""") - @body - glossaryTerm: AtlasGlossaryTerm; - }, - AtlasGlossaryTerm, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get a specific glossary term by its GUID. ") - @route("/atlas/v2/glossary/term/{termGuid}") - @get - getTerm is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - }, - AtlasGlossaryTerm, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Update the given glossary term by its GUID.") - @route("/atlas/v2/glossary/term/{termGuid}") - @put - updateTerm is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - - @doc("Whether include term hierarchy") - @query - includeTermHierarchy?: boolean; - - @doc("The glossary term to be updated.") - @body - glossaryTerm: AtlasGlossaryTerm; - }, - AtlasGlossaryTerm, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete a glossary term.") - @route("/atlas/v2/glossary/term/{termGuid}") - @delete - deleteTerm is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" - @doc(""" -Update the glossary term partially. So far we only supports partial updating -shortDescription, longDescription, abbreviation, usage and status for term. -""") - @route("/atlas/v2/glossary/term/{termGuid}/partial") - @put - partialUpdateTerm is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - - @doc("Whether include term hierarchy") - @query - includeTermHierarchy?: boolean; - - @doc(""" -A map containing keys as attribute names and values as corresponding attribute -values to be updated. -""") - @body - partialUpdates: unknown; - }, - AtlasGlossaryTerm, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Create glossary terms in bulk.") - @route("/atlas/v2/glossary/terms") - @post - createTerms is Azure.Core.Foundations.Operation< - { - @doc("Whether include term hierarchy") - @query - includeTermHierarchy?: boolean; - - @doc("An array of glossary term definitions to be created in bulk.") - @body - glossaryTerm: AtlasGlossaryTerm[]; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -List all related objects assigned with the specified term. Recommend using -limit/offset to get pagination result. -""") - @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") - @get - listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Assign the given term to the provided list of related objects. Recommend using -small batches with multiple API calls. - -[Entities Create Or Update -operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) -is an alternative to assign a term to multiple entities. -""") - @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") - @post - assignTermToEntities is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - - @doc("An array of related object IDs to which the term has to be associated.") - @body - relatedObjectIds: AtlasRelatedObjectId[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete the term assignment for the given list of related objects.") - @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") - @delete - deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - - @doc("An array of related object IDs from which the term has to be dissociated.") - @body - relatedObjectIds: AtlasRelatedObjectId[]; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get all related terms for a specific term by its GUID. Limit, offset, and sort -parameters are currently not being enabled and won't work even they are passed. -""") - @route("/atlas/v2/glossary/terms/{termGuid}/related") - @get - listRelatedTerms is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary term.") - @path - termGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse>, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get a specific Glossary by its GUID.") - @route("/atlas/v2/glossary/{glossaryGuid}") - @get - get is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - }, - AtlasGlossary, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Update the given glossary.") - @route("/atlas/v2/glossary/{glossaryGuid}") - @put - update is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - - @doc("Whether ignore terms and categories") - @query - ignoreTermsAndCategories?: boolean; - - @doc("The glossary definition to be updated.") - @body - updatedGlossary: AtlasGlossary; - }, - AtlasGlossary, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Delete a glossary. Will delete underlying terms/categories together. Recommend -separate delete terms and categories. -""") - @route("/atlas/v2/glossary/{glossaryGuid}") - @delete - delete is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get the categories belonging to a specific glossary. Recommend using -limit/offset to get pagination result. -""") - @route("/atlas/v2/glossary/{glossaryGuid}/categories") - @get - listCategories is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get the category headers belonging to a specific glossary. Recommend using -limit/offset to get pagination result. -""") - @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") - @get - listCategoriesHeaders is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get a specific glossary with detailed information. This API is not -recommend. - -Recommend to fetch terms/categories details separately using - -GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and - -GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. -""") - @route("/atlas/v2/glossary/{glossaryGuid}/detailed") - @get - getDetailed is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - }, - AtlasGlossaryExtInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" - @doc(""" -Update the glossary partially. Some properties such as qualifiedName are not -allowed to be updated. - -So far we only supports partial updating -shortDescription, longDescription, language and usage for glossary. - -Recommend -using 'ignoreTermsAndCategories=true' to reduce response body size. -""") - @route("/atlas/v2/glossary/{glossaryGuid}/partial") - @put - partialUpdate is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - - @doc("Whether ignore terms and categories") - @query - ignoreTermsAndCategories?: boolean; - - @doc(""" -A map containing keys as attribute names and values as corresponding attribute -values. -""") - @body - partialUpdates: unknown; - }, - AtlasGlossary, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get terms belonging to a specific glossary. Recommend using limit/offset to get -pagination result. -""") - @route("/atlas/v2/glossary/{glossaryGuid}/terms") - @get - listTerms is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Get term headers belonging to a specific glossary. Recommend using limit/offset -to get pagination result. -""") - @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") - @get - listTermHeaders is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier for glossary.") - @path - glossaryGuid: string; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The sort order, ASC (default) or DESC.") - @query - sort?: string; - }, - OkResponse, - {}, - AtlasErrorResponse - >; -} - -@client({ - name: "DiscoveryClient", - service: PurviewDataMap, -}) -interface Discovery { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Get data using search.") - @route("/search/query") - @post - query is Azure.Core.Foundations.Operation< - { - @doc("An object specifying the search criteria.") - @body - searchRequest: SearchContent; - }, - SearchResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Get search suggestions by query criteria.") - @route("/search/suggest") - @post - suggest is Azure.Core.Foundations.Operation< - { - @doc("An object specifying the suggest criteria.") - @body - suggestRequest: SuggestContent; - }, - SuggestResult, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Get auto complete options.") - @route("/search/autocomplete") - @post - autoComplete is Azure.Core.Foundations.Operation< - { - @doc("An object specifying the autocomplete criteria.") - @body - autoCompleteRequest: AutoCompleteContent; - }, - AutoCompleteResult, - {}, - AtlasErrorResponse - >; -} - -@client({ - name: "LineageClient", - service: PurviewDataMap, -}) -interface Lineage { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get lineage info of the entity specified by GUID.") - @route("/atlas/v2/lineage/{guid}") - @get - get is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("The number of hops for lineage.") - @query - depth?: int32; - - @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") - @query - direction: LineageDirection; - }, - AtlasLineageInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Return immediate next page lineage info about entity with pagination") - @route("/lineage/{guid}/next/") - @get - getNextPage is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - - @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") - @query - direction: LineageDirection; - - @doc("The offset for pagination purpose.") - @query - offset?: int32; - - @doc("The page size - by default there is no paging.") - @query - limit?: int32; - }, - AtlasLineageInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Return lineage info about entity. - -In addition to the typeName path parameter, -attribute key-value pair(s) can be provided in the following -format - -attr:[attrName]=[attrValue] - -NOTE: The attrName and attrValue should be -unique across entities, eg. qualifiedName. - -The REST request would look -something like this: - -GET -/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. -""") - @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") - @get - getByUniqueAttribute is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - typeName: string; - - @doc("The number of hops for lineage.") - @query - depth?: int32; - - @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") - @query - direction: LineageDirection; - - @doc(""" -The qualified name of the entity. (This is only an example. qualifiedName can -be changed to other unique attributes) -""") - @query("attr:qualifiedName") - attr?: string; - }, - AtlasLineageInfo, - {}, - AtlasErrorResponse - >; -} - -@client({ - name: "RelationshipClient", - service: PurviewDataMap, -}) -interface Relationship { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Create a new relationship between entities.") - @route("/atlas/v2/relationship") - @post - create is Azure.Core.Foundations.Operation< - { - @doc(""" -The AtlasRelationship object containing the information for the relationship to -be created. -""") - @body - relationship: AtlasRelationship; - }, - AtlasRelationship, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Update an existing relationship between entities.") - @route("/atlas/v2/relationship") - @put - update is Azure.Core.Foundations.Operation< - { - @doc(""" -The AtlasRelationship object containing the information for the relationship to -be created. -""") - @body - relationship: AtlasRelationship; - }, - AtlasRelationship, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get relationship information between entities by its GUID.") - @route("/atlas/v2/relationship/guid/{guid}") - @get - get is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the relationship.") - @path - guid: string; - - @doc("Limits whether includes extended information.") - @query - extendedInfo?: boolean; - }, - AtlasRelationshipWithExtInfo, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete a relationship between entities by its GUID.") - @route("/atlas/v2/relationship/guid/{guid}") - @delete - delete is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the relationship.") - @path - guid: string; - }, - void, - {}, - AtlasErrorResponse - >; -} - -@client({ - name: "TypeClient", - service: PurviewDataMap, -}) -interface Type { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the businessMetadata definition for the given guid.") - @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") - @get - getBusinessMetadataDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("businessMetadata guid") - @path - guid: string; - }, - AtlasBusinessMetadataDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the businessMetadata definition by it's name (unique).") - @route("/atlas/v2/types/businessmetadatadef/name/{name}") - @get - getBusinessMetadataDefByName is Azure.Core.Foundations.Operation< - { - @doc("businessMetadata name") - @path - name: string; - }, - AtlasBusinessMetadataDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the classification definition for the given GUID.") - @route("/atlas/v2/types/classificationdef/guid/{guid}") - @get - getClassificationDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the classification.") - @path - guid: string; - }, - AtlasClassificationDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the classification definition by its name (unique).") - @route("/atlas/v2/types/classificationdef/name/{name}") - @get - getClassificationDefByName is Azure.Core.Foundations.Operation< - { - @doc("The name of the classification.") - @path - name: string; - }, - AtlasClassificationDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the Entity definition for the given GUID.") - @route("/atlas/v2/types/entitydef/guid/{guid}") - @get - getEntityDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the entity.") - @path - guid: string; - }, - AtlasEntityDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the entity definition by its name (unique).") - @route("/atlas/v2/types/entitydef/name/{name}") - @get - getEntityDefByName is Azure.Core.Foundations.Operation< - { - @doc("The name of the entity.") - @path - name: string; - }, - AtlasEntityDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the enum definition for the given GUID.") - @route("/atlas/v2/types/enumdef/guid/{guid}") - @get - getEnumDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the enum.") - @path - guid: string; - }, - AtlasEnumDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the enum definition by its name (unique).") - @route("/atlas/v2/types/enumdef/name/{name}") - @get - getEnumDefByName is Azure.Core.Foundations.Operation< - { - @doc("The name of the enum.") - @path - name: string; - }, - AtlasEnumDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the relationship definition for the given GUID.") - @route("/atlas/v2/types/relationshipdef/guid/{guid}") - @get - getRelationshipDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the relationship.") - @path - guid: string; - }, - AtlasRelationshipDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the relationship definition by its name (unique).") - @route("/atlas/v2/types/relationshipdef/name/{name}") - @get - getRelationshipDefByName is Azure.Core.Foundations.Operation< - { - @doc("The name of the relationship.") - @path - name: string; - }, - AtlasRelationshipDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the struct definition for the given GUID.") - @route("/atlas/v2/types/structdef/guid/{guid}") - @get - getStructDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the struct.") - @path - guid: string; - }, - AtlasStructDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the struct definition by its name (unique).") - @route("/atlas/v2/types/structdef/name/{name}") - @get - getStructDefByName is Azure.Core.Foundations.Operation< - { - @doc("The name of the struct.") - @path - name: string; - }, - AtlasStructDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the type definition for the given GUID.") - @route("/atlas/v2/types/typedef/guid/{guid}") - @get - getByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the type.") - @path - guid: string; - }, - AtlasTypeDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Get the type definition by its name (unique).") - @route("/atlas/v2/types/typedef/name/{name}") - @get - getByName is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - name: string; - }, - AtlasTypeDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete API for type identified by its name.") - @route("/atlas/v2/types/typedef/name/{name}") - @delete - delete is Azure.Core.Foundations.Operation< - { - @doc("The name of the type.") - @path - name: string; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("List all type definitions in bulk.") - @route("/atlas/v2/types/typedefs") - @get - list is Azure.Core.Foundations.Operation< - { - @doc(""" -Whether include termtemplatedef when return all typedefs. -This is always true -when search filter type=term_template -""") - @query - includeTermTemplate?: boolean; - - @doc("Typedef name as search filter when get typedefs.") - @query - type?: TypeDef; - }, - AtlasTypesDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Create all atlas type definitions in bulk, only new definitions will be -created. -Any changes to the existing definitions will be discarded. -""") - @route("/atlas/v2/types/typedefs") - @post - bulkCreate is Azure.Core.Foundations.Operation< - { - @doc("A composite wrapper object with corresponding lists of the type definition.") - @body - typesDef: AtlasTypesDef; - }, - AtlasTypesDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc(""" -Update all types in bulk, changes detected in the type definitions would be -persisted. -""") - @route("/atlas/v2/types/typedefs") - @put - bulkUpdate is Azure.Core.Foundations.Operation< - { - @doc("A composite object that captures all type definition changes.") - @body - typesDef: AtlasTypesDef; - }, - AtlasTypesDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("Delete API for all types in bulk.") - @route("/atlas/v2/types/typedefs") - @delete - bulkDelete is Azure.Core.Foundations.Operation< - { - @doc("A composite object that captures all types to be deleted") - @body - typesDef: AtlasTypesDef; - }, - void, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" - @doc("List all type definitions returned as a list of minimal information header.") - @route("/atlas/v2/types/typedefs/headers") - @get - listHeaders is Azure.Core.Foundations.Operation< - { - @doc(""" -Whether include termtemplatedef when return all typedefs. -This is always true -when search filter type=term_template -""") - @query - includeTermTemplate?: boolean; - - @doc("Typedef name as search filter when get typedefs.") - @query - type?: TypeDef; - }, - OkResponse, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Get the term template definition for the given GUID.") - @route("/types/termtemplatedef/guid/{guid}") - @get - getTermTemplateDefByGuid is Azure.Core.Foundations.Operation< - { - @doc("The globally unique identifier of the term template.") - @path - guid: string; - }, - TermTemplateDef, - {}, - AtlasErrorResponse - >; - - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" - @doc("Get the term template definition by its name (unique).") - @route("/types/termtemplatedef/name/{name}") - @get - getTermTemplateDefByName is Azure.Core.Foundations.Operation< - { - @doc("The unique name of the term template.") - @path - name: string; - }, - TermTemplateDef, - {}, - AtlasErrorResponse - >; -} +@@client(Entity, + { + name: "EntityClient", + } +); + +@@client(Discovery, + { + name: "DiscoveryClient", + } +); + +@@client(Relationship, + { + name: "RelationshipClient", + } +); + +@@client(Glossary, + { + name: "GlossaryClient", + } +); + +@@client(Type, + { + name: "TypeClient", + } +); + +@@client(Lineage, + { + name: "LineageClient", + } +); \ No newline at end of file diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 47fd9ddcf6cd..33b774fd1f62 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -1,6 +1,6 @@ import "@typespec/rest"; import "@typespec/http"; -import "./client.tsp"; +import "./routes.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp new file mode 100644 index 000000000000..b0da3229dda2 --- /dev/null +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -0,0 +1,2245 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@typespec/rest"; +import "./models.tsp"; +import "./main.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; +using Azure.Core.Traits.Private; +using Azure.ClientGenerator.Core; + +namespace PurviewDataMap; + +model OkResponse { + @statusCode + status: 200; + + @body + data: T; +} + +op AtlasImportOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse extends TypeSpec.Reflection.Model, + Traits extends TypeSpec.Reflection.Model = {}, + TraitContexts extends TraitContext = TraitContext.Undefined +> is Azure.Core.Foundations.Operation< + TParams & + TraitProperties< + Traits & + NoConditionalRequests & + NoRepeatableRequests & + NoClientRequestId, + TraitLocation.Parameters, + TraitContext.Action + >, + TResponse & + TraitProperties< + Traits & + NoConditionalRequests & + NoRepeatableRequests & + NoClientRequestId, + TraitLocation.Response, + TraitContext.Action + >, + Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, + AtlasErrorResponse +>; + +alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ + @doc("The content type for the operation. Always multipart/form-data for this operation.") + @header("content-type") + contentType: "multipart/form-data"; +}>; + +interface Entity { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Create or update an entity. +Existing entity is matched using its unique guid if +supplied or by its unique attributes eg: qualifiedName. +Map and array of +collections are not well supported. E.g., array>, array>. +For each contact type, the maximum number of contacts is 20. +""") + @route("/atlas/v2/entity") + @post + createOrUpdate is Azure.Core.Foundations.Operation< + { + @doc(""" +Used to define the update behavior for business attributes when updating +entities. +""") + @query + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; + + @doc(""" +The collection where entities will be moved to. Only specify a value if you +need to move an entity to another collection. +""") + @query + collectionId?: string; + + @doc("Atlas entity with extended information.") + @body + entity: AtlasEntityWithExtInfo; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" + @doc("List entities in bulk identified by its GUIDs.") + @route("/atlas/v2/entity/bulk") + @get + listByGuids is Azure.Core.Foundations.Operation< + { + @doc("An array of GUIDs of entities to list.") + @query({ + format: "multi", + }) + guid: string[]; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + }, + AtlasEntitiesWithExtInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Create or update entities in bulk. +Existing entity is matched using its unique +guid if supplied or by its unique attributes eg: qualifiedName. +Map and array +of collections are not well supported. E.g., array>, +array>. +For each contact type, the maximum number of contacts +is 20. +""") + @route("/atlas/v2/entity/bulk") + @post + bulkCreateOrUpdate is Azure.Core.Foundations.Operation< + { + @doc(""" +The collection where entities will be moved to. Only specify a value if you +need to move an entity to another collection. +""") + @query + collectionId?: string; + + @doc(""" +Used to define the update behavior for business attributes when updating +entities. +""") + @query + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; + + @doc("An array of entities to create or update.") + @body + entities: AtlasEntitiesWithExtInfo; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Delete a list of entities in bulk identified by their GUIDs or unique +attributes. +""") + @route("/atlas/v2/entity/bulk") + @delete + bulkDelete is Azure.Core.Foundations.Operation< + { + @doc("An array of GUIDs of entities to delete.") + @query({ + format: "multi", + }) + guid: string[]; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Associate a classification to multiple entities in bulk.") + @route("/atlas/v2/entity/bulk/classification") + @post + addClassification is Azure.Core.Foundations.Operation< + { + @doc("The request to associate a classification to multiple entities.") + @body + request: ClassificationAssociateContent; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get complete definition of an entity given its GUID.") + @route("/atlas/v2/entity/guid/{guid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + }, + AtlasEntityWithExtInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Update entity partially - create or update entity attribute identified by its +GUID. +Supports only primitive attribute type and entity references. +It does not support updating complex types like arrays, and maps. +Null updates are not possible. +""") + @route("/atlas/v2/entity/guid/{guid}") + @put + partialUpdateAttributeByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the attribute.") + @query + name: string; + + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc("The value of the attribute.") + @body + body: unknown; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete an entity identified by its GUID.") + @route("/atlas/v2/entity/guid/{guid}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get classification for a given entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") + @get + getClassification is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the classification.") + @path + classificationName: string; + }, + AtlasClassification, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete a given classification from an existing entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") + @delete + removeClassification is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The name of the classification.") + @path + classificationName: string; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("List classifications for a given entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @get + getClassifications is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasClassifications, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Add classifications to an existing entity represented by a GUID.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @post + addClassifications is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("An array of classifications to be added.") + @body + classifications: AtlasClassification[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update classifications to an existing entity represented by a guid.") + @route("/atlas/v2/entity/guid/{guid}/classifications") + @put + updateClassifications is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("An array of classifications to be updated.") + @body + classifications: AtlasClassification[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get complete definition of an entity given its type and unique attribute. + +In +addition to the typeName path parameter, attribute key-value pair(s) can be +provided in the following format: +attr:\\=. + +NOTE: The +attrName and attrValue should be unique across entities, eg. +qualifiedName. + +The REST request would look something like this: +GET +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @get + getByUniqueAttributes is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + }, + AtlasEntityWithExtInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Update entity partially - Allow a subset of attributes to be updated on an +entity which is identified by its type and unique attribute eg: +Referenceable.qualifiedName. Null updates are not possible. + +In addition to the +typeName path parameter, attribute key-value pair(s) can be provided in the +following format: + +attr:=. +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: +PUT +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @put + partialUpdateByUniqueAttributes is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + + @doc("Atlas entity with extended information.") + @body + atlasEntityWithExtInfo: AtlasEntityWithExtInfo; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Delete an entity identified by its type and unique attributes. +In addition to +the typeName path parameter, attribute key-value pair(s) can be provided in the +following format: +attr:\\=\\. +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: +DELETE +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") + @delete + deleteByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Delete a given classification from an entity identified by its type and unique +attributes. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") + @delete + removeClassificationByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("The name of the classification.") + @path + classificationName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Add classification to the entity identified by its type and unique attributes.") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") + @post + addClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + + @doc("An array of classification to be added.") + @body + atlasClassificationArray: AtlasClassification[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update classification on an entity identified by its type and unique attributes.") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") + @put + updateClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + + @doc("An array of classification to be updated.") + @body + atlasClassificationArray: AtlasClassification[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Set classifications on entities in bulk.") + @route("/atlas/v2/entity/bulk/setClassifications") + @post + bulkSetClassifications is Azure.Core.Foundations.Operation< + { + @doc("Atlas entity headers.") + @body + entityHeaders: AtlasEntityHeaders; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is Atlas API behavior" + @doc(""" +Bulk API to retrieve list of entities identified by its unique attributes. +In +addition to the typeName path parameter, attribute key-value pair(s) can be +provided in the following +format + +typeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\ + +NOTE: +The attrName should be an unique attribute for the given entity-type. +The REST +request would look something like this + +GET +/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 + +Note: +at least one unique attribute must be provided. +""") + @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") + @get + listByUniqueAttributes is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("Whether to return minimal information for referred entities.") + @query + minExtInfo?: boolean; + + @doc("Whether to ignore relationship attributes.") + @query + ignoreRelationships?: boolean; + + @doc(""" +Qualified name of an entity. E.g. to find 2 entities you can set +attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an +example. qualifiedName can be changed to other unique attributes) +""") + @query + `attr_N:qualifiedName`?: string; + }, + AtlasEntitiesWithExtInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get entity header given its GUID.") + @route("/atlas/v2/entity/guid/{guid}/header") + @get + getHeader is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasEntityHeader, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Remove business metadata from an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata") + @delete + removeBusinessMetadata is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata payload") + @body + businessMetadata: Record>; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Add business metadata to an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata") + @post + addOrUpdateBusinessMetadata is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc(""" +Whether to overwrite the existing business metadata on the entity or not, +default is false. +""") + @query + isOverwrite?: boolean; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("BusinessMetadata payload") + @body + businessMetadata: Record>; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" + @doc("Delete business metadata attributes from an entity.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") + @delete + removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + { + @doc("BusinessMetadata name") + @path + bmName: string; + + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata attribute payload") + @body + businessMetadataAttributes: Record; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Add or update business metadata attributes.") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") + @post + addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + { + @doc("BusinessMetadata name") + @path + bmName: string; + + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + @doc("Business metadata attribute payload") + @body + businessMetadataAttributes: Record; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") + @route("/atlas/v2/entity/businessmetadata/import/template") + @get + getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation< + {}, + { + @header contentType: "application/octet-stream"; + @body template: bytes; + }, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Upload the file for creating Business Metadata in BULK") + @route("/atlas/v2/entity/businessmetadata/import") + @post + importBusinessMetadata is AtlasImportOperation< + { + @doc("InputStream of file") + uploadedInputStream: bytes; + }, + BulkImportResult, + MultipartFormDataRequestHeadersTraits + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete given labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @delete + removeLabels is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be deleted") + @body + body: string[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Set labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @post + setLabels is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be set to the entity") + @body + body: string[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Add given labels to a given entity.") + @route("/atlas/v2/entity/guid/{guid}/labels") + @put + addLabel is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("set of labels to be added") + @body + body: string[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Delete given labels to a given entity identified by its type and unique +attribute. + +If labels is null/empty, no labels will be removed. + +If any labels +in labels set are non-existing labels, they will be ignored, only existing +labels will be removed. In addition to the typeName path parameter, attribute +key-value pair(s) can be provided in the following format: +attr:=. NOTE: The attrName and attrValue should be unique +across entities, eg. qualifiedName. The REST request would look something like +this: DELETE +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @delete + removeLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + + @doc("set of labels to be deleted") + @body + body: string[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Set labels to a given entity identified by its type and unique attributes. + +If +labels is null/empty, existing labels will all be removed. + +In addition to the +typeName path parameter, attribute key-value pair(s) can be provided in the +following format: attr:=. + +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: POST +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @post + setLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + + @doc("set of labels to be set") + @body + body: string[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Add given labels to a given entity identified by its type and unique +attributes. + +If labels is null/empty, no labels will be added. + +In addition to +the typeName path parameter, attribute key-value pair(s) can be provided in the +following format: attr:=. + +NOTE: The attrName and +attrValue should be unique across entities, eg. qualifiedName. + +The REST +request would look something like this: PUT +/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") + @put + addLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + + @doc("set of labels to be added") + @body + body: string[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Move existing entities to the target collection.") + @route("/entity/moveTo") + @post + moveEntitiesToCollection is Azure.Core.Foundations.Operation< + { + @doc("The collection where entities will be moved to.") + @query + collectionId: string; + + @doc("Entity guids to be moved to target collection.") + @body + moveEntitiesRequest: MoveEntitiesContent; + }, + EntityMutationResult, + {}, + AtlasErrorResponse + >; +} + +interface Glossary { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get all glossaries. Recommend using limit/offset to get pagination result. +Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories +separately using + + 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' +and + + 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'. +""") + @route("/atlas/v2/glossary") + @get + list is Azure.Core.Foundations.Operation< + { + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories?: boolean; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create a glossary.") + @route("/atlas/v2/glossary") + @post + create is Azure.Core.Foundations.Operation< + { + @doc(""" +Glossary definition, terms & categories can be anchored to a glossary. +Using +the anchor attribute when creating the Term/Category. +""") + @body + atlasGlossary: AtlasGlossary; + }, + AtlasGlossary, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create glossary category in bulk.") + @route("/atlas/v2/glossary/categories") + @post + createCategories is Azure.Core.Foundations.Operation< + { + @doc("An array of glossary category definitions to be created.") + @body + glossaryCategory: AtlasGlossaryCategory[]; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create a glossary category.") + @route("/atlas/v2/glossary/category") + @post + createCategory is Azure.Core.Foundations.Operation< + { + @doc(""" +The glossary category definition. A category must be anchored to a Glossary +when creating. +Optionally, terms belonging to the category and the hierarchy +can also be defined during creation. +""") + @body + glossaryCategory: AtlasGlossaryCategory; + }, + AtlasGlossaryCategory, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get specific glossary category by its GUID.") + @route("/atlas/v2/glossary/category/{categoryGuid}") + @get + getCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + }, + AtlasGlossaryCategory, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update the given glossary category by its GUID.") + @route("/atlas/v2/glossary/category/{categoryGuid}") + @put + updateCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc("The glossary category to be updated.") + @body + glossaryCategory: AtlasGlossaryCategory; + }, + AtlasGlossaryCategory, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete a glossary category.") + @route("/atlas/v2/glossary/category/{categoryGuid}") + @delete + deleteCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc(""" +Update the glossary category partially. So far we only supports partial +updating shortDescription and longDescription for category. +""") + @route("/atlas/v2/glossary/category/{categoryGuid}/partial") + @put + partialUpdateCategory is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values for partial update. +""") + @body + partialUpdates: unknown; + }, + AtlasGlossaryCategory, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get all related categories (parent and children). Limit, offset, and sort +parameters are currently not being enabled and won't work even they are passed. +""") + @route("/atlas/v2/glossary/category/{categoryGuid}/related") + @get + listRelatedCategories is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse>, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get all terms associated with the specific category.") + @route("/atlas/v2/glossary/category/{categoryGuid}/terms") + @get + listCategoryTerms is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the category.") + @path + categoryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create a glossary term.") + @route("/atlas/v2/glossary/term") + @post + createTerm is Azure.Core.Foundations.Operation< + { + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + + @doc(""" +The glossary term definition. A term must be anchored to a Glossary at the time +of creation. +Optionally it can be categorized as well. +""") + @body + glossaryTerm: AtlasGlossaryTerm; + }, + AtlasGlossaryTerm, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get a specific glossary term by its GUID. ") + @route("/atlas/v2/glossary/term/{termGuid}") + @get + getTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + }, + AtlasGlossaryTerm, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update the given glossary term by its GUID.") + @route("/atlas/v2/glossary/term/{termGuid}") + @put + updateTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + + @doc("The glossary term to be updated.") + @body + glossaryTerm: AtlasGlossaryTerm; + }, + AtlasGlossaryTerm, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete a glossary term.") + @route("/atlas/v2/glossary/term/{termGuid}") + @delete + deleteTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc(""" +Update the glossary term partially. So far we only supports partial updating +shortDescription, longDescription, abbreviation, usage and status for term. +""") + @route("/atlas/v2/glossary/term/{termGuid}/partial") + @put + partialUpdateTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values to be updated. +""") + @body + partialUpdates: unknown; + }, + AtlasGlossaryTerm, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create glossary terms in bulk.") + @route("/atlas/v2/glossary/terms") + @post + createTerms is Azure.Core.Foundations.Operation< + { + @doc("Whether include term hierarchy") + @query + includeTermHierarchy?: boolean; + + @doc("An array of glossary term definitions to be created in bulk.") + @body + glossaryTerm: AtlasGlossaryTerm[]; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +List all related objects assigned with the specified term. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @get + listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Assign the given term to the provided list of related objects. Recommend using +small batches with multiple API calls. + +[Entities Create Or Update +operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) +is an alternative to assign a term to multiple entities. +""") + @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @post + assignTermToEntities is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("An array of related object IDs to which the term has to be associated.") + @body + relatedObjectIds: AtlasRelatedObjectId[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete the term assignment for the given list of related objects.") + @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @delete + deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("An array of related object IDs from which the term has to be dissociated.") + @body + relatedObjectIds: AtlasRelatedObjectId[]; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get all related terms for a specific term by its GUID. Limit, offset, and sort +parameters are currently not being enabled and won't work even they are passed. +""") + @route("/atlas/v2/glossary/terms/{termGuid}/related") + @get + listRelatedTerms is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary term.") + @path + termGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse>, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get a specific Glossary by its GUID.") + @route("/atlas/v2/glossary/{glossaryGuid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + }, + AtlasGlossary, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update the given glossary.") + @route("/atlas/v2/glossary/{glossaryGuid}") + @put + update is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories?: boolean; + + @doc("The glossary definition to be updated.") + @body + updatedGlossary: AtlasGlossary; + }, + AtlasGlossary, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Delete a glossary. Will delete underlying terms/categories together. Recommend +separate delete terms and categories. +""") + @route("/atlas/v2/glossary/{glossaryGuid}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get the categories belonging to a specific glossary. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/categories") + @get + listCategories is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get the category headers belonging to a specific glossary. Recommend using +limit/offset to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") + @get + listCategoriesHeaders is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get a specific glossary with detailed information. This API is not +recommend. + +Recommend to fetch terms/categories details separately using + +GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and + +GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/detailed") + @get + getDetailed is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + }, + AtlasGlossaryExtInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" + @doc(""" +Update the glossary partially. Some properties such as qualifiedName are not +allowed to be updated. + +So far we only supports partial updating +shortDescription, longDescription, language and usage for glossary. + +Recommend +using 'ignoreTermsAndCategories=true' to reduce response body size. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/partial") + @put + partialUpdate is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("Whether ignore terms and categories") + @query + ignoreTermsAndCategories?: boolean; + + @doc(""" +A map containing keys as attribute names and values as corresponding attribute +values. +""") + @body + partialUpdates: unknown; + }, + AtlasGlossary, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get terms belonging to a specific glossary. Recommend using limit/offset to get +pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/terms") + @get + listTerms is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Get term headers belonging to a specific glossary. Recommend using limit/offset +to get pagination result. +""") + @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") + @get + listTermHeaders is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier for glossary.") + @path + glossaryGuid: string; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The sort order, ASC (default) or DESC.") + @query + sort?: string; + }, + OkResponse, + {}, + AtlasErrorResponse + >; +} + +interface Discovery { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get data using search.") + @route("/search/query") + @post + query is Azure.Core.Foundations.Operation< + { + @doc("An object specifying the search criteria.") + @body + searchRequest: SearchContent; + }, + SearchResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get search suggestions by query criteria.") + @route("/search/suggest") + @post + suggest is Azure.Core.Foundations.Operation< + { + @doc("An object specifying the suggest criteria.") + @body + suggestRequest: SuggestContent; + }, + SuggestResult, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get auto complete options.") + @route("/search/autocomplete") + @post + autoComplete is Azure.Core.Foundations.Operation< + { + @doc("An object specifying the autocomplete criteria.") + @body + autoCompleteRequest: AutoCompleteContent; + }, + AutoCompleteResult, + {}, + AtlasErrorResponse + >; +} + +interface Lineage { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get lineage info of the entity specified by GUID.") + @route("/atlas/v2/lineage/{guid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The number of hops for lineage.") + @query + depth?: int32; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: LineageDirection; + }, + AtlasLineageInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Return immediate next page lineage info about entity with pagination") + @route("/lineage/{guid}/next/") + @get + getNextPage is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: LineageDirection; + + @doc("The offset for pagination purpose.") + @query + offset?: int32; + + @doc("The page size - by default there is no paging.") + @query + limit?: int32; + }, + AtlasLineageInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Return lineage info about entity. + +In addition to the typeName path parameter, +attribute key-value pair(s) can be provided in the following +format + +attr:[attrName]=[attrValue] + +NOTE: The attrName and attrValue should be +unique across entities, eg. qualifiedName. + +The REST request would look +something like this: + +GET +/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. +""") + @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") + @get + getByUniqueAttribute is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + typeName: string; + + @doc("The number of hops for lineage.") + @query + depth?: int32; + + @doc("The direction of the lineage, which could be INPUT, OUTPUT or BOTH.") + @query + direction: LineageDirection; + + @doc(""" +The qualified name of the entity. (This is only an example. qualifiedName can +be changed to other unique attributes) +""") + @query("attr:qualifiedName") + attr?: string; + }, + AtlasLineageInfo, + {}, + AtlasErrorResponse + >; +} + +interface Relationship { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Create a new relationship between entities.") + @route("/atlas/v2/relationship") + @post + create is Azure.Core.Foundations.Operation< + { + @doc(""" +The AtlasRelationship object containing the information for the relationship to +be created. +""") + @body + relationship: AtlasRelationship; + }, + AtlasRelationship, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Update an existing relationship between entities.") + @route("/atlas/v2/relationship") + @put + update is Azure.Core.Foundations.Operation< + { + @doc(""" +The AtlasRelationship object containing the information for the relationship to +be created. +""") + @body + relationship: AtlasRelationship; + }, + AtlasRelationship, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get relationship information between entities by its GUID.") + @route("/atlas/v2/relationship/guid/{guid}") + @get + get is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + + @doc("Limits whether includes extended information.") + @query + extendedInfo?: boolean; + }, + AtlasRelationshipWithExtInfo, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete a relationship between entities by its GUID.") + @route("/atlas/v2/relationship/guid/{guid}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + }, + void, + {}, + AtlasErrorResponse + >; +} + +interface Type { + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the businessMetadata definition for the given guid.") + @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") + @get + getBusinessMetadataDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("businessMetadata guid") + @path + guid: string; + }, + AtlasBusinessMetadataDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the businessMetadata definition by it's name (unique).") + @route("/atlas/v2/types/businessmetadatadef/name/{name}") + @get + getBusinessMetadataDefByName is Azure.Core.Foundations.Operation< + { + @doc("businessMetadata name") + @path + name: string; + }, + AtlasBusinessMetadataDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the classification definition for the given GUID.") + @route("/atlas/v2/types/classificationdef/guid/{guid}") + @get + getClassificationDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the classification.") + @path + guid: string; + }, + AtlasClassificationDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the classification definition by its name (unique).") + @route("/atlas/v2/types/classificationdef/name/{name}") + @get + getClassificationDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the classification.") + @path + name: string; + }, + AtlasClassificationDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the Entity definition for the given GUID.") + @route("/atlas/v2/types/entitydef/guid/{guid}") + @get + getEntityDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the entity.") + @path + guid: string; + }, + AtlasEntityDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the entity definition by its name (unique).") + @route("/atlas/v2/types/entitydef/name/{name}") + @get + getEntityDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the entity.") + @path + name: string; + }, + AtlasEntityDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the enum definition for the given GUID.") + @route("/atlas/v2/types/enumdef/guid/{guid}") + @get + getEnumDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the enum.") + @path + guid: string; + }, + AtlasEnumDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the enum definition by its name (unique).") + @route("/atlas/v2/types/enumdef/name/{name}") + @get + getEnumDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the enum.") + @path + name: string; + }, + AtlasEnumDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the relationship definition for the given GUID.") + @route("/atlas/v2/types/relationshipdef/guid/{guid}") + @get + getRelationshipDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the relationship.") + @path + guid: string; + }, + AtlasRelationshipDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the relationship definition by its name (unique).") + @route("/atlas/v2/types/relationshipdef/name/{name}") + @get + getRelationshipDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the relationship.") + @path + name: string; + }, + AtlasRelationshipDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the struct definition for the given GUID.") + @route("/atlas/v2/types/structdef/guid/{guid}") + @get + getStructDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the struct.") + @path + guid: string; + }, + AtlasStructDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the struct definition by its name (unique).") + @route("/atlas/v2/types/structdef/name/{name}") + @get + getStructDefByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the struct.") + @path + name: string; + }, + AtlasStructDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the type definition for the given GUID.") + @route("/atlas/v2/types/typedef/guid/{guid}") + @get + getByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the type.") + @path + guid: string; + }, + AtlasTypeDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Get the type definition by its name (unique).") + @route("/atlas/v2/types/typedef/name/{name}") + @get + getByName is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + name: string; + }, + AtlasTypeDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete API for type identified by its name.") + @route("/atlas/v2/types/typedef/name/{name}") + @delete + delete is Azure.Core.Foundations.Operation< + { + @doc("The name of the type.") + @path + name: string; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("List all type definitions in bulk.") + @route("/atlas/v2/types/typedefs") + @get + list is Azure.Core.Foundations.Operation< + { + @doc(""" +Whether include termtemplatedef when return all typedefs. +This is always true +when search filter type=term_template +""") + @query + includeTermTemplate?: boolean; + + @doc("Typedef name as search filter when get typedefs.") + @query + type?: TypeDef; + }, + AtlasTypesDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Create all atlas type definitions in bulk, only new definitions will be +created. +Any changes to the existing definitions will be discarded. +""") + @route("/atlas/v2/types/typedefs") + @post + bulkCreate is Azure.Core.Foundations.Operation< + { + @doc("A composite wrapper object with corresponding lists of the type definition.") + @body + typesDef: AtlasTypesDef; + }, + AtlasTypesDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc(""" +Update all types in bulk, changes detected in the type definitions would be +persisted. +""") + @route("/atlas/v2/types/typedefs") + @put + bulkUpdate is Azure.Core.Foundations.Operation< + { + @doc("A composite object that captures all type definition changes.") + @body + typesDef: AtlasTypesDef; + }, + AtlasTypesDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("Delete API for all types in bulk.") + @route("/atlas/v2/types/typedefs") + @delete + bulkDelete is Azure.Core.Foundations.Operation< + { + @doc("A composite object that captures all types to be deleted") + @body + typesDef: AtlasTypesDef; + }, + void, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + @doc("List all type definitions returned as a list of minimal information header.") + @route("/atlas/v2/types/typedefs/headers") + @get + listHeaders is Azure.Core.Foundations.Operation< + { + @doc(""" +Whether include termtemplatedef when return all typedefs. +This is always true +when search filter type=term_template +""") + @query + includeTermTemplate?: boolean; + + @doc("Typedef name as search filter when get typedefs.") + @query + type?: TypeDef; + }, + OkResponse, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get the term template definition for the given GUID.") + @route("/types/termtemplatedef/guid/{guid}") + @get + getTermTemplateDefByGuid is Azure.Core.Foundations.Operation< + { + @doc("The globally unique identifier of the term template.") + @path + guid: string; + }, + TermTemplateDef, + {}, + AtlasErrorResponse + >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" + @doc("Get the term template definition by its name (unique).") + @route("/types/termtemplatedef/name/{name}") + @get + getTermTemplateDefByName is Azure.Core.Foundations.Operation< + { + @doc("The unique name of the term template.") + @path + name: string; + }, + TermTemplateDef, + {}, + AtlasErrorResponse + >; +} From 968711e763355a58f89a81983c5d3b3a1e988072 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 8 Dec 2023 17:27:59 +0800 Subject: [PATCH 063/132] Update client.tsp --- .../purview/Azure.Analytics.Purview.DataMap/client.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 46d13a4db873..014aac6b874f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -39,4 +39,4 @@ namespace PurviewDataMap; { name: "LineageClient", } -); \ No newline at end of file +); From e53b11aa7c66ddc55656e5bde096a35cc0a64935 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 8 Dec 2023 18:15:19 +0800 Subject: [PATCH 064/132] update client.tsp --- .../client.tsp | 186 ++++++++++++++---- .../Azure.Analytics.Purview.DataMap/main.tsp | 2 +- .../stable/2023-09-01/openapi.json | 2 +- 3 files changed, 151 insertions(+), 39 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 014aac6b874f..407681bb9146 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -2,41 +2,153 @@ import "./main.tsp"; import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; +using PurviewDataMap; -namespace PurviewDataMap; - -@@client(Entity, - { - name: "EntityClient", - } -); - -@@client(Discovery, - { - name: "DiscoveryClient", - } -); - -@@client(Relationship, - { - name: "RelationshipClient", - } -); - -@@client(Glossary, - { - name: "GlossaryClient", - } -); - -@@client(Type, - { - name: "TypeClient", - } -); - -@@client(Lineage, - { - name: "LineageClient", - } -); +@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) +@TypeSpec.Versioning.useDependency(PurviewDataMap.ApiVersions.v2023_09_01) +namespace Customizations; + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@client({ + name: "EntityClient", + service: PurviewDataMap, +}) +interface EntityClient { + createOrUpdate is PurviewDataMap.Entity.createOrUpdate; + listByGuids is PurviewDataMap.Entity.listByGuids; + bulkCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate; + bulkDelete is PurviewDataMap.Entity.bulkDelete; + addClassification is PurviewDataMap.Entity.addClassification; + get is PurviewDataMap.Entity.get; + partialUpdateAttributeByGuid is PurviewDataMap.Entity.partialUpdateAttributeByGuid; + delete is PurviewDataMap.Entity.delete; + getClassification is PurviewDataMap.Entity.getClassification; + removeClassification is PurviewDataMap.Entity.removeClassification; + getClassifications is PurviewDataMap.Entity.getClassifications; + addClassifications is PurviewDataMap.Entity.addClassifications; + updateClassifications is PurviewDataMap.Entity.updateClassifications; + getByUniqueAttributes is PurviewDataMap.Entity.getByUniqueAttributes; + partialUpdateByUniqueAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; + deleteByUniqueAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; + removeClassificationByUniqueAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; + addClassificationsByUniqueAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; + updateClassificationsByUniqueAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute; + bulkSetClassifications is PurviewDataMap.Entity.bulkSetClassifications; + listByUniqueAttributes is PurviewDataMap.Entity.listByUniqueAttributes; + getHeader is PurviewDataMap.Entity.getHeader; + removeBusinessMetadata is PurviewDataMap.Entity.removeBusinessMetadata; + addOrUpdateBusinessMetadata is PurviewDataMap.Entity.addOrUpdateBusinessMetadata; + removeBusinessMetadataAttributes is PurviewDataMap.Entity.removeBusinessMetadataAttributes; + addOrUpdateBusinessMetadataAttributes is PurviewDataMap.Entity.addOrUpdateBusinessMetadataAttributes; + getSampleBusinessMetadataTemplate is PurviewDataMap.Entity.getSampleBusinessMetadataTemplate; + #suppress "@azure-tools/typespec-azure-core/byos" "This is Atlas API" + importBusinessMetadata is PurviewDataMap.Entity.importBusinessMetadata; + removeLabels is PurviewDataMap.Entity.removeLabels; + setLabels is PurviewDataMap.Entity.setLabels; + addLabel is PurviewDataMap.Entity.addLabel; + removeLabelsByUniqueAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute; + setLabelsByUniqueAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute; + addLabelsByUniqueAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute; + moveEntitiesToCollection is PurviewDataMap.Entity.moveEntitiesToCollection; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@client({ + name: "GlossaryClient", + service: PurviewDataMap, +}) +interface GlossaryClient { + list is PurviewDataMap.Glossary.list; + create is PurviewDataMap.Glossary.create; + createCategories is PurviewDataMap.Glossary.createCategories; + createCategory is PurviewDataMap.Glossary.createCategory; + getCategory is PurviewDataMap.Glossary.getCategory; + updateCategory is PurviewDataMap.Glossary.updateCategory; + deleteCategory is PurviewDataMap.Glossary.deleteCategory; + partialUpdateCategory is PurviewDataMap.Glossary.partialUpdateCategory; + listRelatedCategories is PurviewDataMap.Glossary.listRelatedCategories; + listCategoryTerms is PurviewDataMap.Glossary.listCategoryTerms; + createTerm is PurviewDataMap.Glossary.createTerm; + getTerm is PurviewDataMap.Glossary.getTerm; + updateTerm is PurviewDataMap.Glossary.updateTerm; + deleteTerm is PurviewDataMap.Glossary.deleteTerm; + partialUpdateTerm is PurviewDataMap.Glossary.partialUpdateTerm; + createTerms is PurviewDataMap.Glossary.createTerms; + listEntitiesAssignedWithTerm is PurviewDataMap.Glossary.listEntitiesAssignedWithTerm; + assignTermToEntities is PurviewDataMap.Glossary.assignTermToEntities; + deleteTermAssignmentFromEntities is PurviewDataMap.Glossary.deleteTermAssignmentFromEntities; + listRelatedTerms is PurviewDataMap.Glossary.listRelatedTerms; + get is PurviewDataMap.Glossary.get; + update is PurviewDataMap.Glossary.update; + delete is PurviewDataMap.Glossary.delete; + listCategories is PurviewDataMap.Glossary.listCategories; + listCategoriesHeaders is PurviewDataMap.Glossary.listCategoriesHeaders; + getDetailed is PurviewDataMap.Glossary.getDetailed; + partialUpdate is PurviewDataMap.Glossary.partialUpdate; + listTerms is PurviewDataMap.Glossary.listTerms; + listTermHeaders is PurviewDataMap.Glossary.listTermHeaders; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@client({ + name: "DiscoveryClient", + service: PurviewDataMap, +}) +interface DiscoveryClient { + query is PurviewDataMap.Discovery.query; + suggest is PurviewDataMap.Discovery.suggest; + autoComplete is PurviewDataMap.Discovery.autoComplete; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@client({ + name: "LineageClient", + service: PurviewDataMap, +}) +interface LineageClient { + get is PurviewDataMap.Lineage.get; + getNextPage is PurviewDataMap.Lineage.getNextPage; + getByUniqueAttribute is PurviewDataMap.Lineage.getByUniqueAttribute; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@client({ + name: "RelationshipClient", + service: PurviewDataMap, +}) +interface RelationshipClient { + create is PurviewDataMap.Relationship.create; + update is PurviewDataMap.Relationship.update; + get is PurviewDataMap.Relationship.get; + delete is PurviewDataMap.Relationship.delete; +} + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@client({ + name: "TypeClient", + service: PurviewDataMap, +}) +interface TypeClient { + getBusinessMetadataDefByGuid is PurviewDataMap.Type.getBusinessMetadataDefByGuid; + getBusinessMetadataDefByName is PurviewDataMap.Type.getBusinessMetadataDefByName; + getClassificationDefByGuid is PurviewDataMap.Type.getClassificationDefByGuid; + getClassificationDefByName is PurviewDataMap.Type.getClassificationDefByName; + getEntityDefByGuid is PurviewDataMap.Type.getEntityDefByGuid; + getEntityDefByName is PurviewDataMap.Type.getEntityDefByName; + getEnumDefByGuid is PurviewDataMap.Type.getEnumDefByGuid; + getEnumDefByName is PurviewDataMap.Type.getEnumDefByName; + getRelationshipDefByGuid is PurviewDataMap.Type.getRelationshipDefByGuid; + getRelationshipDefByName is PurviewDataMap.Type.getRelationshipDefByName; + getStructDefByGuid is PurviewDataMap.Type.getStructDefByGuid; + getStructDefByName is PurviewDataMap.Type.getStructDefByName; + getByGuid is PurviewDataMap.Type.getByGuid; + getByName is PurviewDataMap.Type.getByName; + delete is PurviewDataMap.Type.delete; + list is PurviewDataMap.Type.list; + bulkCreate is PurviewDataMap.Type.bulkCreate; + bulkUpdate is PurviewDataMap.Type.bulkUpdate; + bulkDelete is PurviewDataMap.Type.bulkDelete; + listHeaders is PurviewDataMap.Type.listHeaders; + getTermTemplateDefByGuid is PurviewDataMap.Type.getTermTemplateDefByGuid; + getTermTemplateDefByName is PurviewDataMap.Type.getTermTemplateDefByName; +} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 33b774fd1f62..c81cca066884 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -30,7 +30,7 @@ namespace PurviewDataMap; enum ApiVersions { @doc("2023-09-01 service API version") @useDependency(Azure.Core.Versions.v1_0_Preview_2) - `2023-09-01`, + v2023_09_01: "2023-09-01", } #suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index a69eebbe2b7a..d5317fa2c631 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -4743,7 +4743,7 @@ "modelAsString": true, "values": [ { - "name": "2023-09-01", + "name": "v2023_09_01", "value": "2023-09-01", "description": "2023-09-01 service API version" } From 5ad675198599b5a050fa8a217e6e12afe2cddba4 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Mon, 11 Dec 2023 09:28:09 +0800 Subject: [PATCH 065/132] update --- .../client.tsp | 1 - .../Azure.Analytics.Purview.DataMap/main.tsp | 6 +-- .../stable/2023-09-01/openapi.json | 48 +++++++++---------- 3 files changed, 27 insertions(+), 28 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 407681bb9146..a970a126fb05 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -4,7 +4,6 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; using PurviewDataMap; -@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) @TypeSpec.Versioning.useDependency(PurviewDataMap.ApiVersions.v2023_09_01) namespace Customizations; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index c81cca066884..bce8cdfcc91c 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -22,7 +22,7 @@ discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service. """) -@useAuth(AADToken) +@useAuth(AuthToken) @versioned(ApiVersions) namespace PurviewDataMap; @@ -33,9 +33,9 @@ enum ApiVersions { v2023_09_01: "2023-09-01", } -#suppress "@azure-tools/typespec-azure-core/casing-style" "It follows the rule" + @doc("The Azure Active Directory OAuth2 Flow") -model AADToken +model AuthToken is OAuth2Auth<[ { type: OAuth2FlowType.implicit; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index d5317fa2c631..ddede6c15c82 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -33,13 +33,13 @@ ], "security": [ { - "AADToken": [ + "AuthToken": [ "https://purview.azure.net/.default" ] } ], "securityDefinitions": { - "AADToken": { + "AuthToken": { "type": "oauth2", "description": "The Azure Active Directory OAuth2 Flow", "flow": "implicit", @@ -4686,28 +4686,6 @@ } }, "definitions": { - "AADToken": { - "type": "object", - "description": "The Azure Active Directory OAuth2 Flow", - "properties": { - "type": { - "type": "string", - "description": "OAuth2 authentication", - "enum": [ - "oauth2" - ] - }, - "flows": { - "type": "array", - "description": "Supported OAuth2 flows", - "items": {} - } - }, - "required": [ - "type", - "flows" - ] - }, "AndFilter": { "type": "object", "description": "And filter for search", @@ -7257,6 +7235,28 @@ ], "x-ms-discriminator-value": "AttributeFilter" }, + "AuthToken": { + "type": "object", + "description": "The Azure Active Directory OAuth2 Flow", + "properties": { + "type": { + "type": "string", + "description": "OAuth2 authentication", + "enum": [ + "oauth2" + ] + }, + "flows": { + "type": "array", + "description": "Supported OAuth2 flows", + "items": {} + } + }, + "required": [ + "type", + "flows" + ] + }, "AutoCompleteContent": { "type": "object", "description": "The query of autocomplete request.", From c14af8ed8cf91c1cac08c74f95c30877ce0d76c8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Mon, 11 Dec 2023 11:11:48 +0800 Subject: [PATCH 066/132] Update main.tsp --- specification/purview/Azure.Analytics.Purview.DataMap/main.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index bce8cdfcc91c..46cd30d5611a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -33,7 +33,6 @@ enum ApiVersions { v2023_09_01: "2023-09-01", } - @doc("The Azure Active Directory OAuth2 Flow") model AuthToken is OAuth2Auth<[ From ed67e086007321dbe9dcd19f4fd1f66df268dd25 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 19 Dec 2023 17:00:53 +0800 Subject: [PATCH 067/132] Rename models by comments rename xxContent to xxOptions rename ContactBasic rename SearchRequsetTaxonomySetting --- .../models.tsp | 22 +++++++++---------- .../routes.tsp | 10 ++++----- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 94ce8d40c80e..faf095fc5e08 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -343,7 +343,7 @@ removed. version?: int64; @doc("The dictionary of contacts for entities. Key could be Expert or Owner.") - contacts?: Record; + contacts?: Record; } @doc(""" @@ -428,8 +428,8 @@ model AtlasTermAssignmentHeader { termGuid?: Azure.Core.uuid; } -@doc("ContactBasic") -model ContactBasic { +@doc("ContactInfo") +model ContactInfo { @doc("Azure Active Directory object Id.") id?: string; @@ -518,7 +518,7 @@ model AtlasEntitiesWithExtInfo { } @doc("The request content for classification association.") -model ClassificationAssociateContent { +model ClassificationAssociateOptions { @doc(""" An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. @@ -589,7 +589,7 @@ model ImportInfo { } @doc("MoveEntitiesContent") -model MoveEntitiesContent { +model MoveEntitiesOptions { @doc("An array of entity guids to be moved to target collection.") entityGuids?: string[]; } @@ -754,7 +754,7 @@ model AtlasGlossaryTerm { resources?: ResourceLink[]; @doc("The dictionary of contacts for terms. Key could be Expert or Steward.") - contacts?: Record; + contacts?: Record; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use Recode to model Map" @doc(""" @@ -918,7 +918,7 @@ model AtlasGlossaryExtInfo { } @doc("The search query of advanced search request.") -model SearchContent { +model SearchOptions { @doc("The keywords applied to all searchable fields.") keywords?: string; @@ -946,7 +946,7 @@ batch, and will return new token in each response unless there's no more data. facets?: SearchFacetItem[]; @doc("The taxonomy setting for search.") - taxonomySetting?: SearchRequestTaxonomySetting; + taxonomySetting?: SearchTaxonomySetting; } @doc("The content of a search facet result item.") @@ -980,7 +980,7 @@ enum SearchSortOrder { } @doc("Taxonomy setting for search request") -model SearchRequestTaxonomySetting { +model SearchTaxonomySetting { @doc("Asset types") assetTypes?: string[]; @@ -1198,7 +1198,7 @@ Expert or Steward for a glossary term. } @doc("The query of suggest request.") -model SuggestContent { +model SuggestOptions { @doc(""" 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 @@ -1307,7 +1307,7 @@ AtlasGlossaryCategory. } @doc("The query of autocomplete request.") -model AutoCompleteContent { +model AutoCompleteOptions { @doc(""" The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters. diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index b0da3229dda2..21cefa9aa189 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -189,7 +189,7 @@ attributes. { @doc("The request to associate a classification to multiple entities.") @body - request: ClassificationAssociateContent; + request: ClassificationAssociateOptions; }, void, {}, @@ -968,7 +968,7 @@ be changed to other unique attributes) @doc("Entity guids to be moved to target collection.") @body - moveEntitiesRequest: MoveEntitiesContent; + moveEntitiesRequest: MoveEntitiesOptions; }, EntityMutationResult, {}, @@ -1680,7 +1680,7 @@ interface Discovery { { @doc("An object specifying the search criteria.") @body - searchRequest: SearchContent; + searchRequest: SearchOptions; }, SearchResult, {}, @@ -1695,7 +1695,7 @@ interface Discovery { { @doc("An object specifying the suggest criteria.") @body - suggestRequest: SuggestContent; + suggestRequest: SuggestOptions; }, SuggestResult, {}, @@ -1710,7 +1710,7 @@ interface Discovery { { @doc("An object specifying the autocomplete criteria.") @body - autoCompleteRequest: AutoCompleteContent; + autoCompleteRequest: AutoCompleteOptions; }, AutoCompleteResult, {}, From b40f219488a84298c63c7dee6665c1cbca110f3b Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 19 Dec 2023 17:02:35 +0800 Subject: [PATCH 068/132] Update openapi.json --- .../stable/2023-09-01/openapi.json | 146 +++++++++--------- 1 file changed, 73 insertions(+), 73 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index ddede6c15c82..70011122d506 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -321,7 +321,7 @@ "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { - "$ref": "#/definitions/ClassificationAssociateContent" + "$ref": "#/definitions/ClassificationAssociateOptions" } } ], @@ -4322,7 +4322,7 @@ "description": "Entity guids to be moved to target collection.", "required": true, "schema": { - "$ref": "#/definitions/MoveEntitiesContent" + "$ref": "#/definitions/MoveEntitiesOptions" } } ], @@ -4447,7 +4447,7 @@ "description": "An object specifying the autocomplete criteria.", "required": true, "schema": { - "$ref": "#/definitions/AutoCompleteContent" + "$ref": "#/definitions/AutoCompleteOptions" } } ], @@ -4486,7 +4486,7 @@ "description": "An object specifying the search criteria.", "required": true, "schema": { - "$ref": "#/definitions/SearchContent" + "$ref": "#/definitions/SearchOptions" } } ], @@ -4585,7 +4585,7 @@ "description": "An object specifying the suggest criteria.", "required": true, "schema": { - "$ref": "#/definitions/SuggestContent" + "$ref": "#/definitions/SuggestOptions" } } ], @@ -5289,7 +5289,7 @@ "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", "additionalProperties": { "items": { - "$ref": "#/definitions/ContactBasic" + "$ref": "#/definitions/ContactInfo" }, "type": "array" } @@ -6129,7 +6129,7 @@ "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", "additionalProperties": { "items": { - "$ref": "#/definitions/ContactBasic" + "$ref": "#/definitions/ContactInfo" }, "type": "array" } @@ -7257,7 +7257,7 @@ "flows" ] }, - "AutoCompleteContent": { + "AutoCompleteOptions": { "type": "object", "description": "The query of autocomplete request.", "properties": { @@ -7391,7 +7391,7 @@ ] } }, - "ClassificationAssociateContent": { + "ClassificationAssociateOptions": { "type": "object", "description": "The request content for classification association.", "properties": { @@ -7469,20 +7469,6 @@ ], "x-ms-discriminator-value": "CollectionIdFilter" }, - "ContactBasic": { - "type": "object", - "description": "ContactBasic", - "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." - } - } - }, "ContactFilter": { "type": "object", "description": "Contact filter for search", @@ -7503,6 +7489,20 @@ ], "x-ms-discriminator-value": "ContactFilter" }, + "ContactInfo": { + "type": "object", + "description": "ContactInfo", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, "ContactSearchResultValue": { "type": "object", "description": "The contact in the search and suggest result.", @@ -7877,7 +7877,7 @@ } } }, - "MoveEntitiesContent": { + "MoveEntitiesOptions": { "type": "object", "description": "MoveEntitiesContent", "properties": { @@ -8261,45 +8261,6 @@ ], "x-ms-discriminator-value": "ScanInfoFilter" }, - "SearchContent": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchRequestTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, "SearchFacetItem": { "type": "object", "description": "The content of a search facet result item.", @@ -8567,20 +8528,42 @@ } } }, - "SearchRequestTaxonomySetting": { + "SearchOptions": { "type": "object", - "description": "Taxonomy setting for search request", + "description": "The search query of advanced search request.", "properties": { - "assetTypes": { + "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\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, and will return new token in each response unless there's no more data." + }, + "orderby": { "type": "array", - "description": "Asset types", + "description": "The sort order of search results, can specify multiple fields.", + "items": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", "items": { - "type": "string" - } + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] }, - "facet": { - "$ref": "#/definitions/SearchFacetItem", - "description": "The content of a search facet result item." + "taxonomySetting": { + "$ref": "#/definitions/SearchTaxonomySetting", + "description": "The taxonomy setting for search." } } }, @@ -8759,6 +8742,23 @@ ] } }, + "SearchTaxonomySetting": { + "type": "object", + "description": "Taxonomy setting for search request", + "properties": { + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, "SortType": { "type": "string", "description": "Type for sorting", @@ -8813,7 +8813,7 @@ ] } }, - "SuggestContent": { + "SuggestOptions": { "type": "object", "description": "The query of suggest request.", "properties": { From 73cc3ccbc0f8bc9aa27df2fea9482d2b20676f71 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 19 Dec 2023 17:24:48 +0800 Subject: [PATCH 069/132] client/method renaming list->get bulk -> batch remove unique using operation group guid -> id --- .../client.tsp | 127 ++++++++---------- 1 file changed, 56 insertions(+), 71 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index a970a126fb05..a6ba9d69fce4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -9,31 +9,32 @@ namespace Customizations; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @client({ - name: "EntityClient", + name: "DataMapClient", service: PurviewDataMap, }) -interface EntityClient { +@operationGroup +interface Entity { createOrUpdate is PurviewDataMap.Entity.createOrUpdate; - listByGuids is PurviewDataMap.Entity.listByGuids; - bulkCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate; - bulkDelete is PurviewDataMap.Entity.bulkDelete; + getByIds is PurviewDataMap.Entity.listByGuids; + batchCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate; + batchDelete is PurviewDataMap.Entity.bulkDelete; addClassification is PurviewDataMap.Entity.addClassification; get is PurviewDataMap.Entity.get; - partialUpdateAttributeByGuid is PurviewDataMap.Entity.partialUpdateAttributeByGuid; + partialUpdateAttributeById is PurviewDataMap.Entity.partialUpdateAttributeByGuid; delete is PurviewDataMap.Entity.delete; getClassification is PurviewDataMap.Entity.getClassification; removeClassification is PurviewDataMap.Entity.removeClassification; getClassifications is PurviewDataMap.Entity.getClassifications; addClassifications is PurviewDataMap.Entity.addClassifications; updateClassifications is PurviewDataMap.Entity.updateClassifications; - getByUniqueAttributes is PurviewDataMap.Entity.getByUniqueAttributes; - partialUpdateByUniqueAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; - deleteByUniqueAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; - removeClassificationByUniqueAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; - addClassificationsByUniqueAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; - updateClassificationsByUniqueAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute; - bulkSetClassifications is PurviewDataMap.Entity.bulkSetClassifications; - listByUniqueAttributes is PurviewDataMap.Entity.listByUniqueAttributes; + getByAttributes is PurviewDataMap.Entity.getByUniqueAttributes; + partialUpdateByAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; + deleteByAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; + removeClassificationByAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; + addClassificationsByAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; + updateClassificationsByAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute; + batchSetClassifications is PurviewDataMap.Entity.bulkSetClassifications; + batchGetByAttributes is PurviewDataMap.Entity.listByUniqueAttributes; getHeader is PurviewDataMap.Entity.getHeader; removeBusinessMetadata is PurviewDataMap.Entity.removeBusinessMetadata; addOrUpdateBusinessMetadata is PurviewDataMap.Entity.addOrUpdateBusinessMetadata; @@ -45,19 +46,16 @@ interface EntityClient { removeLabels is PurviewDataMap.Entity.removeLabels; setLabels is PurviewDataMap.Entity.setLabels; addLabel is PurviewDataMap.Entity.addLabel; - removeLabelsByUniqueAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute; - setLabelsByUniqueAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute; - addLabelsByUniqueAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute; + removeLabelsByAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute; + setLabelsByAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute; + addLabelsByAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute; moveEntitiesToCollection is PurviewDataMap.Entity.moveEntitiesToCollection; } #suppress "@azure-tools/typespec-azure-core/use-standard-operations" -@client({ - name: "GlossaryClient", - service: PurviewDataMap, -}) -interface GlossaryClient { - list is PurviewDataMap.Glossary.list; +@operationGroup +interface Glossary { + batchGet is PurviewDataMap.Glossary.list; create is PurviewDataMap.Glossary.create; createCategories is PurviewDataMap.Glossary.createCategories; createCategory is PurviewDataMap.Glossary.createCategory; @@ -65,57 +63,47 @@ interface GlossaryClient { updateCategory is PurviewDataMap.Glossary.updateCategory; deleteCategory is PurviewDataMap.Glossary.deleteCategory; partialUpdateCategory is PurviewDataMap.Glossary.partialUpdateCategory; - listRelatedCategories is PurviewDataMap.Glossary.listRelatedCategories; - listCategoryTerms is PurviewDataMap.Glossary.listCategoryTerms; + getRelatedCategories is PurviewDataMap.Glossary.listRelatedCategories; + getCategoryTerms is PurviewDataMap.Glossary.listCategoryTerms; createTerm is PurviewDataMap.Glossary.createTerm; getTerm is PurviewDataMap.Glossary.getTerm; updateTerm is PurviewDataMap.Glossary.updateTerm; deleteTerm is PurviewDataMap.Glossary.deleteTerm; partialUpdateTerm is PurviewDataMap.Glossary.partialUpdateTerm; createTerms is PurviewDataMap.Glossary.createTerms; - listEntitiesAssignedWithTerm is PurviewDataMap.Glossary.listEntitiesAssignedWithTerm; + getEntitiesAssignedWithTerm is PurviewDataMap.Glossary.listEntitiesAssignedWithTerm; assignTermToEntities is PurviewDataMap.Glossary.assignTermToEntities; deleteTermAssignmentFromEntities is PurviewDataMap.Glossary.deleteTermAssignmentFromEntities; - listRelatedTerms is PurviewDataMap.Glossary.listRelatedTerms; + getRelatedTerms is PurviewDataMap.Glossary.listRelatedTerms; get is PurviewDataMap.Glossary.get; update is PurviewDataMap.Glossary.update; delete is PurviewDataMap.Glossary.delete; - listCategories is PurviewDataMap.Glossary.listCategories; - listCategoriesHeaders is PurviewDataMap.Glossary.listCategoriesHeaders; + getCategories is PurviewDataMap.Glossary.listCategories; + getCategoriesHeaders is PurviewDataMap.Glossary.listCategoriesHeaders; getDetailed is PurviewDataMap.Glossary.getDetailed; partialUpdate is PurviewDataMap.Glossary.partialUpdate; - listTerms is PurviewDataMap.Glossary.listTerms; - listTermHeaders is PurviewDataMap.Glossary.listTermHeaders; + getTerms is PurviewDataMap.Glossary.listTerms; + getTermHeaders is PurviewDataMap.Glossary.listTermHeaders; } #suppress "@azure-tools/typespec-azure-core/use-standard-operations" -@client({ - name: "DiscoveryClient", - service: PurviewDataMap, -}) -interface DiscoveryClient { +@operationGroup +interface Discovery { query is PurviewDataMap.Discovery.query; suggest is PurviewDataMap.Discovery.suggest; autoComplete is PurviewDataMap.Discovery.autoComplete; } #suppress "@azure-tools/typespec-azure-core/use-standard-operations" -@client({ - name: "LineageClient", - service: PurviewDataMap, -}) -interface LineageClient { +@operationGroup +interface Lineage { get is PurviewDataMap.Lineage.get; getNextPage is PurviewDataMap.Lineage.getNextPage; getByUniqueAttribute is PurviewDataMap.Lineage.getByUniqueAttribute; } #suppress "@azure-tools/typespec-azure-core/use-standard-operations" -@client({ - name: "RelationshipClient", - service: PurviewDataMap, -}) -interface RelationshipClient { +interface Relationship { create is PurviewDataMap.Relationship.create; update is PurviewDataMap.Relationship.update; get is PurviewDataMap.Relationship.get; @@ -123,31 +111,28 @@ interface RelationshipClient { } #suppress "@azure-tools/typespec-azure-core/use-standard-operations" -@client({ - name: "TypeClient", - service: PurviewDataMap, -}) -interface TypeClient { - getBusinessMetadataDefByGuid is PurviewDataMap.Type.getBusinessMetadataDefByGuid; - getBusinessMetadataDefByName is PurviewDataMap.Type.getBusinessMetadataDefByName; - getClassificationDefByGuid is PurviewDataMap.Type.getClassificationDefByGuid; - getClassificationDefByName is PurviewDataMap.Type.getClassificationDefByName; - getEntityDefByGuid is PurviewDataMap.Type.getEntityDefByGuid; - getEntityDefByName is PurviewDataMap.Type.getEntityDefByName; - getEnumDefByGuid is PurviewDataMap.Type.getEnumDefByGuid; - getEnumDefByName is PurviewDataMap.Type.getEnumDefByName; - getRelationshipDefByGuid is PurviewDataMap.Type.getRelationshipDefByGuid; - getRelationshipDefByName is PurviewDataMap.Type.getRelationshipDefByName; - getStructDefByGuid is PurviewDataMap.Type.getStructDefByGuid; - getStructDefByName is PurviewDataMap.Type.getStructDefByName; - getByGuid is PurviewDataMap.Type.getByGuid; +@operationGroup +interface TypeDefinition { + getBusinessMetadataById is PurviewDataMap.Type.getBusinessMetadataDefByGuid; + getBusinessMetadataByName is PurviewDataMap.Type.getBusinessMetadataDefByName; + getClassificationById is PurviewDataMap.Type.getClassificationDefByGuid; + getClassificationByName is PurviewDataMap.Type.getClassificationDefByName; + getEntityById is PurviewDataMap.Type.getEntityDefByGuid; + getEntityByName is PurviewDataMap.Type.getEntityDefByName; + getEnumById is PurviewDataMap.Type.getEnumDefByGuid; + getEnumByName is PurviewDataMap.Type.getEnumDefByName; + getRelationshipById is PurviewDataMap.Type.getRelationshipDefByGuid; + getRelationshipByName is PurviewDataMap.Type.getRelationshipDefByName; + getStructById is PurviewDataMap.Type.getStructDefByGuid; + getStructByName is PurviewDataMap.Type.getStructDefByName; + getById is PurviewDataMap.Type.getByGuid; getByName is PurviewDataMap.Type.getByName; delete is PurviewDataMap.Type.delete; - list is PurviewDataMap.Type.list; - bulkCreate is PurviewDataMap.Type.bulkCreate; - bulkUpdate is PurviewDataMap.Type.bulkUpdate; - bulkDelete is PurviewDataMap.Type.bulkDelete; - listHeaders is PurviewDataMap.Type.listHeaders; - getTermTemplateDefByGuid is PurviewDataMap.Type.getTermTemplateDefByGuid; - getTermTemplateDefByName is PurviewDataMap.Type.getTermTemplateDefByName; + get is PurviewDataMap.Type.list; + batchCreate is PurviewDataMap.Type.bulkCreate; + batchUpdate is PurviewDataMap.Type.bulkUpdate; + batchDelete is PurviewDataMap.Type.bulkDelete; + getHeaders is PurviewDataMap.Type.listHeaders; + getTermTemplateById is PurviewDataMap.Type.getTermTemplateDefByGuid; + getTermTemplateByName is PurviewDataMap.Type.getTermTemplateDefByName; } From a0637c8a9f5a0d189623c5aeb284b6c18639a89c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 21 Dec 2023 13:47:33 +0800 Subject: [PATCH 070/132] Update client.tsp --- .../purview/Azure.Analytics.Purview.DataMap/client.tsp | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index a6ba9d69fce4..41a11e15bcd9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -5,13 +5,13 @@ using Azure.ClientGenerator.Core; using PurviewDataMap; @TypeSpec.Versioning.useDependency(PurviewDataMap.ApiVersions.v2023_09_01) -namespace Customizations; - -#suppress "@azure-tools/typespec-azure-core/use-standard-operations" @client({ name: "DataMapClient", service: PurviewDataMap, }) +namespace Customizations; + +#suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup interface Entity { createOrUpdate is PurviewDataMap.Entity.createOrUpdate; @@ -103,6 +103,7 @@ interface Lineage { } #suppress "@azure-tools/typespec-azure-core/use-standard-operations" +@operationGroup interface Relationship { create is PurviewDataMap.Relationship.create; update is PurviewDataMap.Relationship.update; From 9b750b78b0c9e80cddae29abdb33b4c29b49e301 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 21 Dec 2023 14:09:50 +0800 Subject: [PATCH 071/132] fix casing problem --- .../models.tsp | 118 ++++++------ .../stable/2023-09-01/openapi.json | 172 +++++++++--------- 2 files changed, 145 insertions(+), 145 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index faf095fc5e08..ff97909f083d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -9,85 +9,85 @@ namespace PurviewDataMap; @doc("Enum for business attribute update behavior") enum BusinessAttributeUpdateBehavior { @doc("Ignore the business attribute payload for update.") - ignore, + Ignore: "ignore", @doc("Replace all the business attributes using the payload.") - replace, + Replace: "replace", @doc("Merge the business attributes. Business attributes will not be updated if not provided.") - merge, + Merge: "merge", } @doc("Status - can be active or deleted") enum EntityStatus { @doc("The status is active.") - ACTIVE, + Active: "ACTIVE", @doc("The status is deleted.") - DELETED, + Deleted: "DELETED", } @doc("Status for term assignment") enum AtlasTermAssignmentStatus { @doc("The status is discovered.") - DISCOVERED, + Discovered: "DISCOVERED", @doc("The status is proposed.") - PROPOSED, + Proposed: "PROPOSED", @doc("The status is imported.") - IMPORTED, + Imported: "IMPORTED", @doc("The status is validated.") - VALIDATED, + Validated: "VALIDATED", @doc("The status is deprecated.") - DEPRECATED, + Deprecated: "DEPRECATED", @doc("The status is obsolete.") - OBSOLETE, + Obsolete: "OBSOLETE", @doc("Other status.") - OTHER, + Other: "OTHER", } @doc("Type for sorting") enum SortType { @doc("No sorting order") - NONE, + None: "NONE", @doc("Use ascending order for sorting") - ASC, + Ascend: "ASC", @doc("Use descending order for sorting") - DESC, + Descend: "DESC", } @doc("Status for import") enum ImportStatus { @doc("Success") - SUCCESS, + Success: "SUCCESS", @doc("Failed") - FAILED, + Failed: "FAILED", } @doc("Status for atlas term relationship") enum AtlasTermRelationshipStatus { @doc("draft") - DRAFT, + Draft: "DRAFT", @doc("active") - ACTIVE, + Active: "ACTIVE", @doc("deprecated") - DEPRECATED, + Deprecated: "DEPRECATED", @doc("obsolete") - OBSOLETE, + Obsolete: "OBSOLETE", @doc("other") - OTHER, + Other: "OTHER", } @doc("Status for term") @@ -108,127 +108,127 @@ enum TermStatus { @doc("Status for atlas relationship") enum StatusAtlasRelationship { @doc("active") - ACTIVE, + Active: "ACTIVE", @doc("deleted") - DELETED, + Deleted: "DELETED", } @doc("Lineage direction") enum LineageDirection { @doc("input") - INPUT, + Input: "INPUT", @doc("output") - OUTPUT, + Output: "OUTPUT", @doc("both") - BOTH, + Both: "BOTH", } @doc("Cardinality") enum CardinalityValue { @doc("single") - SINGLE, + Single: "SINGLE", @doc("list") - LIST, + List: "LIST", @doc("set") - SET, + Set: "SET", } @doc("Type Category") enum TypeCategory { @doc("primitive") - PRIMITIVE, + Primitive: "PRIMITIVE", @doc("object id type") - OBJECT_ID_TYPE, + ObjectIdType: "OBJECT_ID_TYPE", @doc("enum") - ENUM, + Enum: "ENUM", @doc("struct") - STRUCT, + Struct: "STRUCT", @doc("classification") - CLASSIFICATION, + Classification: "CLASSIFICATION", @doc("entity") - ENTITY, + Entity: "ENTITY", @doc("array") - ARRAY, + Array: "ARRAY", @doc("map") - MAP, + Map: "MAP", @doc("relationship") - RELATIONSHIP, + Relationship: "RELATIONSHIP", @doc("term template") - TERM_TEMPLATE, + TermTemplate: "TERM_TEMPLATE", } @doc("Rounding Mode") enum RoundingMode { @doc("up") - UP, + Up: "UP", @doc("down") - DOWN, + Down: "DOWN", @doc("ceiling") - CEILING, + Ceiling: "CEILING", @doc("floor") - FLOOR, + Floor: "FLOOR", @doc("half up") - HALF_UP, + HalfUp: "HALF_UP", @doc("half down") - HALF_DOWN, + HalfDown: "HALF_DOWN", @doc("half even") - HALF_EVEN, + HalfEven: "HALF_EVEN", @doc("unnecessary") - UNNECESSARY, + Unnecessary: "UNNECESSARY", } @doc("Relationship Category") enum RelationshipCategory { @doc("association") - ASSOCIATION, + Association: "ASSOCIATION", @doc("aggregation") - AGGREGATION, + Aggregation: "AGGREGATION", @doc("composition") - COMPOSITION, + Composition: "COMPOSITION", } @doc("Type") enum TypeDef { @doc("enum") - `enum`, + Enum: "enum", @doc("entity") - entity, + Entity: "entity", @doc("classification") - classification, + Classification: "classification", @doc("relationship") - relationship, + Relationship: "relationship", @doc("struct") - struct, + Struct: "struct", @doc("term template") - term_template, + TermTemplate: "term_template", } @doc("Search Filter Operator") @@ -973,10 +973,10 @@ model SearchFacetSort { @doc("Search sort order") enum SearchSortOrder { @doc("Use ascending order for sorting") - asc, + Ascend: "asc", @doc("Use descending order for sorting") - desc, + Descend: "desc", } @doc("Taxonomy setting for search request") diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 70011122d506..98c1d17a622a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -75,17 +75,17 @@ "modelAsString": true, "values": [ { - "name": "ignore", + "name": "Ignore", "value": "ignore", "description": "Ignore the business attribute payload for update." }, { - "name": "replace", + "name": "Replace", "value": "replace", "description": "Replace all the business attributes using the payload." }, { - "name": "merge", + "name": "Merge", "value": "merge", "description": "Merge the business attributes. Business attributes will not be updated if not provided." } @@ -220,17 +220,17 @@ "modelAsString": true, "values": [ { - "name": "ignore", + "name": "Ignore", "value": "ignore", "description": "Ignore the business attribute payload for update." }, { - "name": "replace", + "name": "Replace", "value": "replace", "description": "Replace all the business attributes using the payload." }, { - "name": "merge", + "name": "Merge", "value": "merge", "description": "Merge the business attributes. Business attributes will not be updated if not provided." } @@ -3177,17 +3177,17 @@ "modelAsString": true, "values": [ { - "name": "INPUT", + "name": "Input", "value": "INPUT", "description": "input" }, { - "name": "OUTPUT", + "name": "Output", "value": "OUTPUT", "description": "output" }, { - "name": "BOTH", + "name": "Both", "value": "BOTH", "description": "both" } @@ -3255,17 +3255,17 @@ "modelAsString": true, "values": [ { - "name": "INPUT", + "name": "Input", "value": "INPUT", "description": "input" }, { - "name": "OUTPUT", + "name": "Output", "value": "OUTPUT", "description": "output" }, { - "name": "BOTH", + "name": "Both", "value": "BOTH", "description": "both" } @@ -4038,32 +4038,32 @@ "modelAsString": true, "values": [ { - "name": "enum", + "name": "Enum", "value": "enum", "description": "enum" }, { - "name": "entity", + "name": "Entity", "value": "entity", "description": "entity" }, { - "name": "classification", + "name": "Classification", "value": "classification", "description": "classification" }, { - "name": "relationship", + "name": "Relationship", "value": "relationship", "description": "relationship" }, { - "name": "struct", + "name": "Struct", "value": "struct", "description": "struct" }, { - "name": "term_template", + "name": "TermTemplate", "value": "term_template", "description": "term template" } @@ -4243,32 +4243,32 @@ "modelAsString": true, "values": [ { - "name": "enum", + "name": "Enum", "value": "enum", "description": "enum" }, { - "name": "entity", + "name": "Entity", "value": "entity", "description": "entity" }, { - "name": "classification", + "name": "Classification", "value": "classification", "description": "classification" }, { - "name": "relationship", + "name": "Relationship", "value": "relationship", "description": "relationship" }, { - "name": "struct", + "name": "Struct", "value": "struct", "description": "struct" }, { - "name": "term_template", + "name": "TermTemplate", "value": "term_template", "description": "term template" } @@ -4378,17 +4378,17 @@ "modelAsString": true, "values": [ { - "name": "INPUT", + "name": "Input", "value": "INPUT", "description": "input" }, { - "name": "OUTPUT", + "name": "Output", "value": "OUTPUT", "description": "output" }, { - "name": "BOTH", + "name": "Both", "value": "BOTH", "description": "both" } @@ -6889,37 +6889,37 @@ "modelAsString": true, "values": [ { - "name": "DISCOVERED", + "name": "Discovered", "value": "DISCOVERED", "description": "The status is discovered." }, { - "name": "PROPOSED", + "name": "Proposed", "value": "PROPOSED", "description": "The status is proposed." }, { - "name": "IMPORTED", + "name": "Imported", "value": "IMPORTED", "description": "The status is imported." }, { - "name": "VALIDATED", + "name": "Validated", "value": "VALIDATED", "description": "The status is validated." }, { - "name": "DEPRECATED", + "name": "Deprecated", "value": "DEPRECATED", "description": "The status is deprecated." }, { - "name": "OBSOLETE", + "name": "Obsolete", "value": "OBSOLETE", "description": "The status is obsolete." }, { - "name": "OTHER", + "name": "Other", "value": "OTHER", "description": "Other status." } @@ -6967,27 +6967,27 @@ "modelAsString": true, "values": [ { - "name": "DRAFT", + "name": "Draft", "value": "DRAFT", "description": "draft" }, { - "name": "ACTIVE", + "name": "Active", "value": "ACTIVE", "description": "active" }, { - "name": "DEPRECATED", + "name": "Deprecated", "value": "DEPRECATED", "description": "deprecated" }, { - "name": "OBSOLETE", + "name": "Obsolete", "value": "OBSOLETE", "description": "obsolete" }, { - "name": "OTHER", + "name": "Other", "value": "OTHER", "description": "other" } @@ -7344,17 +7344,17 @@ "modelAsString": true, "values": [ { - "name": "ignore", + "name": "Ignore", "value": "ignore", "description": "Ignore the business attribute payload for update." }, { - "name": "replace", + "name": "Replace", "value": "replace", "description": "Replace all the business attributes using the payload." }, { - "name": "merge", + "name": "Merge", "value": "merge", "description": "Merge the business attributes. Business attributes will not be updated if not provided." } @@ -7374,17 +7374,17 @@ "modelAsString": true, "values": [ { - "name": "SINGLE", + "name": "Single", "value": "SINGLE", "description": "single" }, { - "name": "LIST", + "name": "List", "value": "LIST", "description": "list" }, { - "name": "SET", + "name": "Set", "value": "SET", "description": "set" } @@ -7648,12 +7648,12 @@ "modelAsString": true, "values": [ { - "name": "ACTIVE", + "name": "Active", "value": "ACTIVE", "description": "The status is active." }, { - "name": "DELETED", + "name": "Deleted", "value": "DELETED", "description": "The status is deleted." } @@ -7794,12 +7794,12 @@ "modelAsString": true, "values": [ { - "name": "SUCCESS", + "name": "Success", "value": "SUCCESS", "description": "Success" }, { - "name": "FAILED", + "name": "Failed", "value": "FAILED", "description": "Failed" } @@ -7842,17 +7842,17 @@ "modelAsString": true, "values": [ { - "name": "INPUT", + "name": "Input", "value": "INPUT", "description": "input" }, { - "name": "OUTPUT", + "name": "Output", "value": "OUTPUT", "description": "output" }, { - "name": "BOTH", + "name": "Both", "value": "BOTH", "description": "both" } @@ -8150,17 +8150,17 @@ "modelAsString": true, "values": [ { - "name": "ASSOCIATION", + "name": "Association", "value": "ASSOCIATION", "description": "association" }, { - "name": "AGGREGATION", + "name": "Aggregation", "value": "AGGREGATION", "description": "aggregation" }, { - "name": "COMPOSITION", + "name": "Composition", "value": "COMPOSITION", "description": "composition" } @@ -8199,42 +8199,42 @@ "modelAsString": true, "values": [ { - "name": "UP", + "name": "Up", "value": "UP", "description": "up" }, { - "name": "DOWN", + "name": "Down", "value": "DOWN", "description": "down" }, { - "name": "CEILING", + "name": "Ceiling", "value": "CEILING", "description": "ceiling" }, { - "name": "FLOOR", + "name": "Floor", "value": "FLOOR", "description": "floor" }, { - "name": "HALF_UP", + "name": "HalfUp", "value": "HALF_UP", "description": "half up" }, { - "name": "HALF_DOWN", + "name": "HalfDown", "value": "HALF_DOWN", "description": "half down" }, { - "name": "HALF_EVEN", + "name": "HalfEven", "value": "HALF_EVEN", "description": "half even" }, { - "name": "UNNECESSARY", + "name": "Unnecessary", "value": "UNNECESSARY", "description": "unnecessary" } @@ -8730,12 +8730,12 @@ "modelAsString": true, "values": [ { - "name": "asc", + "name": "Ascend", "value": "asc", "description": "Use ascending order for sorting" }, { - "name": "desc", + "name": "Descend", "value": "desc", "description": "Use descending order for sorting" } @@ -8772,17 +8772,17 @@ "modelAsString": true, "values": [ { - "name": "NONE", + "name": "None", "value": "NONE", "description": "No sorting order" }, { - "name": "ASC", + "name": "Ascend", "value": "ASC", "description": "Use ascending order for sorting" }, { - "name": "DESC", + "name": "Descend", "value": "DESC", "description": "Use descending order for sorting" } @@ -8801,12 +8801,12 @@ "modelAsString": true, "values": [ { - "name": "ACTIVE", + "name": "Active", "value": "ACTIVE", "description": "active" }, { - "name": "DELETED", + "name": "Deleted", "value": "DELETED", "description": "deleted" } @@ -9190,52 +9190,52 @@ "modelAsString": true, "values": [ { - "name": "PRIMITIVE", + "name": "Primitive", "value": "PRIMITIVE", "description": "primitive" }, { - "name": "OBJECT_ID_TYPE", + "name": "ObjectIdType", "value": "OBJECT_ID_TYPE", "description": "object id type" }, { - "name": "ENUM", + "name": "Enum", "value": "ENUM", "description": "enum" }, { - "name": "STRUCT", + "name": "Struct", "value": "STRUCT", "description": "struct" }, { - "name": "CLASSIFICATION", + "name": "Classification", "value": "CLASSIFICATION", "description": "classification" }, { - "name": "ENTITY", + "name": "Entity", "value": "ENTITY", "description": "entity" }, { - "name": "ARRAY", + "name": "Array", "value": "ARRAY", "description": "array" }, { - "name": "MAP", + "name": "Map", "value": "MAP", "description": "map" }, { - "name": "RELATIONSHIP", + "name": "Relationship", "value": "RELATIONSHIP", "description": "relationship" }, { - "name": "TERM_TEMPLATE", + "name": "TermTemplate", "value": "TERM_TEMPLATE", "description": "term template" } @@ -9258,32 +9258,32 @@ "modelAsString": true, "values": [ { - "name": "enum", + "name": "Enum", "value": "enum", "description": "enum" }, { - "name": "entity", + "name": "Entity", "value": "entity", "description": "entity" }, { - "name": "classification", + "name": "Classification", "value": "classification", "description": "classification" }, { - "name": "relationship", + "name": "Relationship", "value": "relationship", "description": "relationship" }, { - "name": "struct", + "name": "Struct", "value": "struct", "description": "struct" }, { - "name": "term_template", + "name": "TermTemplate", "value": "term_template", "description": "term template" } From 936b6e189dd6e23eb540517dfb3bdd0beb404b7c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 21 Dec 2023 14:38:47 +0800 Subject: [PATCH 072/132] update comments --- ...y_AddClassificationsByUniqueAttribute.json | 2 +- .../Entity_AddLabelsByUniqueAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../Entity_RemoveBusinessAttribute.json | 2 +- .../Glossary_AssignTermToEntities.json | 2 +- .../examples/2023-09-01/Glossary_Delete.json | 2 +- .../2023-09-01/Glossary_DeleteCategory.json | 2 +- .../2023-09-01/Glossary_DeleteTerm.json | 2 +- .../examples/2023-09-01/Glossary_Get.json | 2 +- .../2023-09-01/Glossary_GetCategory.json | 2 +- .../2023-09-01/Glossary_GetDetailed.json | 2 +- .../examples/2023-09-01/Glossary_GetTerm.json | 2 +- .../Glossary_GetTermWithoutAssets.json | 2 +- .../2023-09-01/Glossary_ListCategories.json | 2 +- .../Glossary_ListCategoriesHeaders.json | 2 +- .../Glossary_ListCategoryTerms.json | 2 +- ...Glossary_ListEntitiesAssignedWithTerm.json | 2 +- .../Glossary_ListRelatedCategories.json | 2 +- .../2023-09-01/Glossary_ListRelatedTerms.json | 2 +- .../2023-09-01/Glossary_ListTermHeaders.json | 2 +- .../2023-09-01/Glossary_ListTerms.json | 2 +- .../2023-09-01/Glossary_PartialUpdate.json | 2 +- .../Glossary_PartialUpdateCategory.json | 2 +- .../Glossary_PartialUpdateTerm.json | 2 +- ...sary_RemoveTermAssignmentFromEntities.json | 2 +- .../examples/2023-09-01/Glossary_Update.json | 2 +- .../2023-09-01/Glossary_UpdateCategory.json | 2 +- .../models.tsp | 4 +- .../routes.tsp | 112 ++++---- ...y_AddClassificationsByUniqueAttribute.json | 2 +- .../Entity_AddLabelsByUniqueAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../Entity_RemoveBusinessAttribute.json | 2 +- .../Glossary_AssignTermToEntities.json | 2 +- .../2023-09-01/examples/Glossary_Delete.json | 2 +- .../examples/Glossary_DeleteCategory.json | 2 +- .../examples/Glossary_DeleteTerm.json | 2 +- .../2023-09-01/examples/Glossary_Get.json | 2 +- .../examples/Glossary_GetCategory.json | 2 +- .../examples/Glossary_GetDetailed.json | 2 +- .../2023-09-01/examples/Glossary_GetTerm.json | 2 +- .../Glossary_GetTermWithoutAssets.json | 2 +- .../examples/Glossary_ListCategories.json | 2 +- .../Glossary_ListCategoriesHeaders.json | 2 +- .../examples/Glossary_ListCategoryTerms.json | 2 +- ...Glossary_ListEntitiesAssignedWithTerm.json | 2 +- .../Glossary_ListRelatedCategories.json | 2 +- .../examples/Glossary_ListRelatedTerms.json | 2 +- .../examples/Glossary_ListTermHeaders.json | 2 +- .../examples/Glossary_ListTerms.json | 2 +- .../examples/Glossary_PartialUpdate.json | 2 +- .../Glossary_PartialUpdateCategory.json | 2 +- .../examples/Glossary_PartialUpdateTerm.json | 2 +- ...sary_RemoveTermAssignmentFromEntities.json | 2 +- .../2023-09-01/examples/Glossary_Update.json | 2 +- .../examples/Glossary_UpdateCategory.json | 2 +- .../stable/2023-09-01/openapi.json | 248 +++++++++--------- 57 files changed, 236 insertions(+), 236 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json index 9ceb5785ba20..a5eea86a2b97 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "classifications": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json index 3a2bc5a3f537..2f9db0a93175 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "body": [ + "labels": [ "label3" ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json index 5070f91d5d4f..34b3e5816cf3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json index d6f0c4b6c41d..53accfbf687d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json index f5805466ff13..6ad1b726af7d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", "relatedObjectIds": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json index 66d0c8e21a8d..88b82510fb9f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json index 814f4a434f6f..c281cd4c2450 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json index edfc59de8017..7fa8e97b845a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_DeleteTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json index 1f99715ebf1e..6e1aaeaa5786 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json index 230d037dad82..1de42a99f57e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json index d302e7e999a8..0345a931a976 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json index 9b89e65e50f1..3b574ac3e20f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json index e6bcb016215a..3bedbf11a9a4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json index ca06ec508a72..30e8cf73dbfd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json index ebd4d7c6acc9..a04eb3cba127 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json index 091df398e96c..e1a99139221b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json index d2be6d8d0f3c..99c872e87c99 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json index ddd15b9191e1..2e845fcb0944 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json index 33619369a434..56999a9dd79a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json index 24dbbdef0dfd..6bcfbe8c9fc9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json index ddf242126dcd..583aa635b462 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json index 6b1d846fd25e..b5dfeca34a18 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "partialUpdates": { "longDescription": "Example Long Description" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json index b1b3b5eb05b7..fcd86785e556 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", + "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", "partialUpdates": { "longDescription": "Example Long Description" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json index e2bc0df64883..cb5542825495 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "partialUpdates": { "longDescription": "Example Long Descrition" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json index 46c653fe9fb3..1dd9519f670c 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", "relatedObjectIds": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json index 4eabcf439a58..06919b479bae 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "updatedGlossary": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json index a195f431da37..cb450401bbc5 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "glossaryCategory": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index ff97909f083d..e67921764a74 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -232,7 +232,7 @@ enum TypeDef { } @doc("Search Filter Operator") -enum SearchFilterOperator { +enum FilterOperator { @doc("equal") eq, @@ -2021,7 +2021,7 @@ model AttributeFilter extends SearchFilter { attributeName: string; @doc("Operator") - operator: SearchFilterOperator; + operator: FilterOperator; #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("Attribute value") diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 21cefa9aa189..58b05d4d31d3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -529,7 +529,7 @@ be changed to other unique attributes) @doc("An array of classification to be added.") @body - atlasClassificationArray: AtlasClassification[]; + classifications: AtlasClassification[]; }, void, {}, @@ -694,13 +694,13 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" @doc("Delete business metadata attributes from an entity.") - @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") @delete removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< { @doc("BusinessMetadata name") @path - bmName: string; + businessMetadataName: string; @doc("The globally unique identifier of the entity.") @path @@ -719,13 +719,13 @@ default is false. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Add or update business metadata attributes.") - @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}") + @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") @post addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< { @doc("BusinessMetadata name") @path - bmName: string; + businessMetadataName: string; @doc("The globally unique identifier of the entity.") @path @@ -949,7 +949,7 @@ be changed to other unique attributes) @doc("set of labels to be added") @body - body: string[]; + labels: string[]; }, void, {}, @@ -983,10 +983,10 @@ Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using - 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' + 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and - 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'. + 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. """) @route("/atlas/v2/glossary") @get @@ -1071,13 +1071,13 @@ can also be defined during creation. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get specific glossary category by its GUID.") - @route("/atlas/v2/glossary/category/{categoryGuid}") + @route("/atlas/v2/glossary/category/{categoryId}") @get getCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path - categoryGuid: string; + categoryId: string; }, AtlasGlossaryCategory, {}, @@ -1086,13 +1086,13 @@ can also be defined during creation. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary category by its GUID.") - @route("/atlas/v2/glossary/category/{categoryGuid}") + @route("/atlas/v2/glossary/category/{categoryId}") @put updateCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path - categoryGuid: string; + categoryId: string; @doc("The glossary category to be updated.") @body @@ -1105,13 +1105,13 @@ can also be defined during creation. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a glossary category.") - @route("/atlas/v2/glossary/category/{categoryGuid}") + @route("/atlas/v2/glossary/category/{categoryId}") @delete deleteCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path - categoryGuid: string; + categoryId: string; }, void, {}, @@ -1124,13 +1124,13 @@ can also be defined during creation. Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category. """) - @route("/atlas/v2/glossary/category/{categoryGuid}/partial") + @route("/atlas/v2/glossary/category/{categoryId}/partial") @put partialUpdateCategory is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path - categoryGuid: string; + categoryId: string; @doc(""" A map containing keys as attribute names and values as corresponding attribute @@ -1149,13 +1149,13 @@ values for partial update. Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. """) - @route("/atlas/v2/glossary/category/{categoryGuid}/related") + @route("/atlas/v2/glossary/category/{categoryId}/related") @get listRelatedCategories is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path - categoryGuid: string; + categoryId: string; @doc("The page size - by default there is no paging.") @query @@ -1176,13 +1176,13 @@ parameters are currently not being enabled and won't work even they are passed. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get all terms associated with the specific category.") - @route("/atlas/v2/glossary/category/{categoryGuid}/terms") + @route("/atlas/v2/glossary/category/{categoryId}/terms") @get listCategoryTerms is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier of the category.") @path - categoryGuid: string; + categoryId: string; @doc("The page size - by default there is no paging.") @query @@ -1226,13 +1226,13 @@ Optionally it can be categorized as well. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get a specific glossary term by its GUID. ") - @route("/atlas/v2/glossary/term/{termGuid}") + @route("/atlas/v2/glossary/term/{termId}") @get getTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; }, AtlasGlossaryTerm, {}, @@ -1241,13 +1241,13 @@ Optionally it can be categorized as well. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary term by its GUID.") - @route("/atlas/v2/glossary/term/{termGuid}") + @route("/atlas/v2/glossary/term/{termId}") @put updateTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; @doc("Whether include term hierarchy") @query @@ -1264,13 +1264,13 @@ Optionally it can be categorized as well. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete a glossary term.") - @route("/atlas/v2/glossary/term/{termGuid}") + @route("/atlas/v2/glossary/term/{termId}") @delete deleteTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; }, void, {}, @@ -1283,13 +1283,13 @@ Optionally it can be categorized as well. Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term. """) - @route("/atlas/v2/glossary/term/{termGuid}/partial") + @route("/atlas/v2/glossary/term/{termId}/partial") @put partialUpdateTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; @doc("Whether include term hierarchy") @query @@ -1332,13 +1332,13 @@ values to be updated. List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result. """) - @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @get listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; @doc("The page size - by default there is no paging.") @query @@ -1367,13 +1367,13 @@ small batches with multiple API calls. operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities. """) - @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @post assignTermToEntities is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; @doc("An array of related object IDs to which the term has to be associated.") @body @@ -1387,13 +1387,13 @@ is an alternative to assign a term to multiple entities. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete the term assignment for the given list of related objects.") - @route("/atlas/v2/glossary/terms/{termGuid}/assignedEntities") + @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @delete deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; @doc("An array of related object IDs from which the term has to be dissociated.") @body @@ -1409,13 +1409,13 @@ is an alternative to assign a term to multiple entities. Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. """) - @route("/atlas/v2/glossary/terms/{termGuid}/related") + @route("/atlas/v2/glossary/terms/{termId}/related") @get listRelatedTerms is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary term.") @path - termGuid: string; + termId: string; @doc("The page size - by default there is no paging.") @query @@ -1436,13 +1436,13 @@ parameters are currently not being enabled and won't work even they are passed. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get a specific Glossary by its GUID.") - @route("/atlas/v2/glossary/{glossaryGuid}") + @route("/atlas/v2/glossary/{glossaryId}") @get get is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; }, AtlasGlossary, {}, @@ -1451,13 +1451,13 @@ parameters are currently not being enabled and won't work even they are passed. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Update the given glossary.") - @route("/atlas/v2/glossary/{glossaryGuid}") + @route("/atlas/v2/glossary/{glossaryId}") @put update is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; @doc("Whether ignore terms and categories") @query @@ -1477,13 +1477,13 @@ parameters are currently not being enabled and won't work even they are passed. Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories. """) - @route("/atlas/v2/glossary/{glossaryGuid}") + @route("/atlas/v2/glossary/{glossaryId}") @delete delete is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; }, void, {}, @@ -1495,13 +1495,13 @@ separate delete terms and categories. Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) - @route("/atlas/v2/glossary/{glossaryGuid}/categories") + @route("/atlas/v2/glossary/{glossaryId}/categories") @get listCategories is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; @doc("The page size - by default there is no paging.") @query @@ -1525,13 +1525,13 @@ limit/offset to get pagination result. Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) - @route("/atlas/v2/glossary/{glossaryGuid}/categories/headers") + @route("/atlas/v2/glossary/{glossaryId}/categories/headers") @get listCategoriesHeaders is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; @doc("The page size - by default there is no paging.") @query @@ -1557,17 +1557,17 @@ recommend. Recommend to fetch terms/categories details separately using -GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and +GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and -GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories. +GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. """) - @route("/atlas/v2/glossary/{glossaryGuid}/detailed") + @route("/atlas/v2/glossary/{glossaryId}/detailed") @get getDetailed is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; }, AtlasGlossaryExtInfo, {}, @@ -1586,13 +1586,13 @@ shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size. """) - @route("/atlas/v2/glossary/{glossaryGuid}/partial") + @route("/atlas/v2/glossary/{glossaryId}/partial") @put partialUpdate is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; @doc("Whether ignore terms and categories") @query @@ -1615,13 +1615,13 @@ values. Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) - @route("/atlas/v2/glossary/{glossaryGuid}/terms") + @route("/atlas/v2/glossary/{glossaryId}/terms") @get listTerms is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; @doc("The page size - by default there is no paging.") @query @@ -1645,13 +1645,13 @@ pagination result. Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. """) - @route("/atlas/v2/glossary/{glossaryGuid}/terms/headers") + @route("/atlas/v2/glossary/{glossaryId}/terms/headers") @get listTermHeaders is Azure.Core.Foundations.Operation< { @doc("The globally unique identifier for glossary.") @path - glossaryGuid: string; + glossaryId: string; @doc("The page size - by default there is no paging.") @query diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index 9ceb5785ba20..a5eea86a2b97 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "classifications": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 3a2bc5a3f537..2f9db0a93175 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "body": [ + "labels": [ "label3" ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 5070f91d5d4f..34b3e5816cf3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index d6f0c4b6c41d..53accfbf687d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "businessMetadataAttributes": { "bizAttr1": "bizAttr1" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index f5805466ff13..6ad1b726af7d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", "relatedObjectIds": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 66d0c8e21a8d..88b82510fb9f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index 814f4a434f6f..c281cd4c2450 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index edfc59de8017..7fa8e97b845a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 1f99715ebf1e..6e1aaeaa5786 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 230d037dad82..1de42a99f57e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index d302e7e999a8..0345a931a976 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index 9b89e65e50f1..3b574ac3e20f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index e6bcb016215a..3bedbf11a9a4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index ca06ec508a72..30e8cf73dbfd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index ebd4d7c6acc9..a04eb3cba127 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index 091df398e96c..e1a99139221b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index d2be6d8d0f3c..99c872e87c99 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index ddd15b9191e1..2e845fcb0944 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index 33619369a434..56999a9dd79a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 24dbbdef0dfd..6bcfbe8c9fc9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index ddf242126dcd..583aa635b462 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index 6b1d846fd25e..b5dfeca34a18 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "partialUpdates": { "longDescription": "Example Long Description" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index b1b3b5eb05b7..fcd86785e556 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", + "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", "partialUpdates": { "longDescription": "Example Long Description" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index e2bc0df64883..cb5542825495 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "partialUpdates": { "longDescription": "Example Long Descrition" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index 46c653fe9fb3..1dd9519f670c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", "relatedObjectIds": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index 4eabcf439a58..06919b479bae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "updatedGlossary": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index a195f431da37..cb450401bbc5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "glossaryCategory": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 98c1d17a622a..47f7cfaad048 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -751,7 +751,7 @@ } } }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { "post": { "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", "description": "Add or update business metadata attributes.", @@ -760,7 +760,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "bmName", + "name": "businessMetadataName", "in": "path", "description": "BusinessMetadata name", "required": true, @@ -809,7 +809,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "bmName", + "name": "businessMetadataName", "in": "path", "description": "BusinessMetadata name", "required": true, @@ -1512,7 +1512,7 @@ "x-ms-client-name": "attr" }, { - "name": "atlasClassificationArray", + "name": "classifications", "in": "body", "description": "An array of classification to be added.", "required": true, @@ -1567,7 +1567,7 @@ "x-ms-client-name": "attr" }, { - "name": "body", + "name": "labels", "in": "body", "description": "set of labels to be added", "required": true, @@ -1704,7 +1704,7 @@ "/atlas/v2/glossary": { "get": { "operationId": "Glossary_List", - "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -1802,7 +1802,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}": { + "/atlas/v2/glossary/{glossaryId}": { "get": { "operationId": "Glossary_Get", "description": "Get a specific Glossary by its GUID.", @@ -1811,7 +1811,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -1846,7 +1846,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -1897,7 +1897,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -1922,7 +1922,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories": { + "/atlas/v2/glossary/{glossaryId}/categories": { "get": { "operationId": "Glossary_ListCategories", "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", @@ -1931,7 +1931,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -1986,7 +1986,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { + "/atlas/v2/glossary/{glossaryId}/categories/headers": { "get": { "operationId": "Glossary_ListCategoriesHeaders", "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", @@ -1995,7 +1995,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -2050,16 +2050,16 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "/atlas/v2/glossary/{glossaryId}/detailed": { "get": { "operationId": "Glossary_GetDetailed", - "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryGuid}/categories.", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -2087,7 +2087,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/partial": { + "/atlas/v2/glossary/{glossaryId}/partial": { "put": { "operationId": "Glossary_PartialUpdate", "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", @@ -2096,7 +2096,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -2138,7 +2138,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/terms": { + "/atlas/v2/glossary/{glossaryId}/terms": { "get": { "operationId": "Glossary_ListTerms", "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", @@ -2147,7 +2147,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -2202,7 +2202,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "/atlas/v2/glossary/{glossaryId}/terms/headers": { "get": { "operationId": "Glossary_ListTermHeaders", "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", @@ -2211,7 +2211,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryGuid", + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -2352,7 +2352,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}": { + "/atlas/v2/glossary/category/{categoryId}": { "get": { "operationId": "Glossary_GetCategory", "description": "Get specific glossary category by its GUID.", @@ -2361,7 +2361,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "categoryGuid", + "name": "categoryId", "in": "path", "description": "The globally unique identifier of the category.", "required": true, @@ -2396,7 +2396,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "categoryGuid", + "name": "categoryId", "in": "path", "description": "The globally unique identifier of the category.", "required": true, @@ -2440,7 +2440,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "categoryGuid", + "name": "categoryId", "in": "path", "description": "The globally unique identifier of the category.", "required": true, @@ -2465,7 +2465,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}/partial": { + "/atlas/v2/glossary/category/{categoryId}/partial": { "put": { "operationId": "Glossary_PartialUpdateCategory", "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", @@ -2474,7 +2474,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "categoryGuid", + "name": "categoryId", "in": "path", "description": "The globally unique identifier of the category.", "required": true, @@ -2509,7 +2509,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}/related": { + "/atlas/v2/glossary/category/{categoryId}/related": { "get": { "operationId": "Glossary_ListRelatedCategories", "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", @@ -2518,7 +2518,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "categoryGuid", + "name": "categoryId", "in": "path", "description": "The globally unique identifier of the category.", "required": true, @@ -2576,7 +2576,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "/atlas/v2/glossary/category/{categoryId}/terms": { "get": { "operationId": "Glossary_ListCategoryTerms", "description": "Get all terms associated with the specific category.", @@ -2585,7 +2585,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "categoryGuid", + "name": "categoryId", "in": "path", "description": "The globally unique identifier of the category.", "required": true, @@ -2689,7 +2689,7 @@ } } }, - "/atlas/v2/glossary/term/{termGuid}": { + "/atlas/v2/glossary/term/{termId}": { "get": { "operationId": "Glossary_GetTerm", "description": "Get a specific glossary term by its GUID. ", @@ -2698,7 +2698,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -2736,7 +2736,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -2787,7 +2787,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -2812,7 +2812,7 @@ } } }, - "/atlas/v2/glossary/term/{termGuid}/partial": { + "/atlas/v2/glossary/term/{termId}/partial": { "put": { "operationId": "Glossary_PartialUpdateTerm", "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", @@ -2821,7 +2821,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -2917,7 +2917,7 @@ } } }, - "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "/atlas/v2/glossary/terms/{termId}/assignedEntities": { "get": { "operationId": "Glossary_ListEntitiesAssignedWithTerm", "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", @@ -2926,7 +2926,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -2988,7 +2988,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -3033,7 +3033,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -3071,7 +3071,7 @@ } } }, - "/atlas/v2/glossary/terms/{termGuid}/related": { + "/atlas/v2/glossary/terms/{termId}/related": { "get": { "operationId": "Glossary_ListRelatedTerms", "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", @@ -3080,7 +3080,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "termGuid", + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -7216,7 +7216,7 @@ "description": "Attribute name" }, "operator": { - "$ref": "#/definitions/SearchFilterOperator", + "$ref": "#/definitions/FilterOperator", "description": "Operator" }, "attributeValue": { @@ -7722,6 +7722,84 @@ ], "x-ms-discriminator-value": "FileExtensionFilter" }, + "FilterOperator": { + "type": "string", + "description": "Search Filter Operator", + "enum": [ + "eq", + "ne", + "gt", + "lt", + "ge", + "le", + "contains", + "startswith", + "prefix", + "timerange", + "exists" + ], + "x-ms-enum": { + "name": "FilterOperator", + "modelAsString": true, + "values": [ + { + "name": "eq", + "value": "eq", + "description": "equal" + }, + { + "name": "ne", + "value": "ne", + "description": "not equal" + }, + { + "name": "gt", + "value": "gt", + "description": "greater than" + }, + { + "name": "lt", + "value": "lt", + "description": "less than" + }, + { + "name": "ge", + "value": "ge", + "description": "greater than or equal to" + }, + { + "name": "le", + "value": "le", + "description": "less than or equal to" + }, + { + "name": "contains", + "value": "contains", + "description": "contains" + }, + { + "name": "startswith", + "value": "startswith", + "description": "start with" + }, + { + "name": "prefix", + "value": "prefix", + "description": "prefix" + }, + { + "name": "timerange", + "value": "timerange", + "description": "time range" + }, + { + "name": "exists", + "value": "exists", + "description": "exists" + } + ] + } + }, "GlossaryFilter": { "type": "object", "description": "Glossary filter for search", @@ -8409,84 +8487,6 @@ "kind" ] }, - "SearchFilterOperator": { - "type": "string", - "description": "Search Filter Operator", - "enum": [ - "eq", - "ne", - "gt", - "lt", - "ge", - "le", - "contains", - "startswith", - "prefix", - "timerange", - "exists" - ], - "x-ms-enum": { - "name": "SearchFilterOperator", - "modelAsString": true, - "values": [ - { - "name": "eq", - "value": "eq", - "description": "equal" - }, - { - "name": "ne", - "value": "ne", - "description": "not equal" - }, - { - "name": "gt", - "value": "gt", - "description": "greater than" - }, - { - "name": "lt", - "value": "lt", - "description": "less than" - }, - { - "name": "ge", - "value": "ge", - "description": "greater than or equal to" - }, - { - "name": "le", - "value": "le", - "description": "less than or equal to" - }, - { - "name": "contains", - "value": "contains", - "description": "contains" - }, - { - "name": "startswith", - "value": "startswith", - "description": "start with" - }, - { - "name": "prefix", - "value": "prefix", - "description": "prefix" - }, - { - "name": "timerange", - "value": "timerange", - "description": "time range" - }, - { - "name": "exists", - "value": "exists", - "description": "exists" - } - ] - } - }, "SearchHighlights": { "type": "object", "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", From 047d75c28983adf18becb47dd89d151f33eb358e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 21 Dec 2023 14:54:37 +0800 Subject: [PATCH 073/132] update --- .../examples/2023-09-01/Glossary_UpdateTerm.json | 2 +- .../stable/2023-09-01/examples/Glossary_UpdateTerm.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json index 4fb70086784b..8fea21da5eb8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "glossaryTerm": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 4fb70086784b..8fea21da5eb8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "glossaryTerm": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", From b5e00bdccf17612c4da5fc4a529e61fcae758c29 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 13:51:49 +0800 Subject: [PATCH 074/132] update discovery --- .../2023-09-01/Discovery_AutoComplete.json | 4 +- .../examples/2023-09-01/Discovery_Query.json | 4 +- .../2023-09-01/Discovery_Query_And.json | 5 +- .../Discovery_Query_AndOrNested.json | 8 +- .../2023-09-01/Discovery_Query_AssetType.json | 30 +- .../2023-09-01/Discovery_Query_Attribute.json | 6 +- ...overy_Query_BusinessMetadataAttribute.json | 7 +- .../Discovery_Query_Classification.json | 3 +- .../Discovery_Query_Collection.json | 3 +- .../2023-09-01/Discovery_Query_Facet.json | 3 +- .../Discovery_Query_FileExtension.json | 4 +- .../Discovery_Query_GlossaryTerm.json | 7 +- .../2023-09-01/Discovery_Query_Id.json | 4 +- .../2023-09-01/Discovery_Query_Not.json | 4 +- .../Discovery_Query_ObjectType.json | 11 +- ...very_Query_PaginationContinuationPage.json | 5 +- .../Discovery_Query_PaginationFirstPage.json | 5 +- .../Discovery_Query_PaginationLastPage.json | 5 +- .../Discovery_Query_SystemTime.json | 5 +- .../2023-09-01/Discovery_Query_Taxonomy.json | 10 +- .../Discovery_Query_TermAssignment.json | 6 +- .../2023-09-01/Discovery_Query_Type.json | 4 +- .../2023-09-01/Discovery_Suggest.json | 4 +- .../examples/2023-09-01/Entity_AddLabel.json | 2 +- .../2023-09-01/Entity_RemoveLabels.json | 2 +- .../Entity_RemoveLabelsByUniqueAttribute.json | 2 +- .../examples/2023-09-01/Entity_SetLabels.json | 2 +- .../Entity_SetLabelsByUniqueAttribute.json | 2 +- .../models.tsp | 266 +------- .../routes.tsp | 18 +- .../examples/Discovery_AutoComplete.json | 4 +- .../2023-09-01/examples/Discovery_Query.json | 4 +- .../examples/Discovery_Query_And.json | 5 +- .../examples/Discovery_Query_AndOrNested.json | 8 +- .../examples/Discovery_Query_AssetType.json | 30 +- .../examples/Discovery_Query_Attribute.json | 6 +- ...overy_Query_BusinessMetadataAttribute.json | 7 +- .../Discovery_Query_Classification.json | 3 +- .../examples/Discovery_Query_Collection.json | 3 +- .../examples/Discovery_Query_Facet.json | 3 +- .../Discovery_Query_FileExtension.json | 4 +- .../Discovery_Query_GlossaryTerm.json | 7 +- .../examples/Discovery_Query_Id.json | 4 +- .../examples/Discovery_Query_Not.json | 4 +- .../examples/Discovery_Query_ObjectType.json | 11 +- ...very_Query_PaginationContinuationPage.json | 5 +- .../Discovery_Query_PaginationFirstPage.json | 5 +- .../Discovery_Query_PaginationLastPage.json | 5 +- .../examples/Discovery_Query_SystemTime.json | 5 +- .../examples/Discovery_Query_Taxonomy.json | 10 +- .../Discovery_Query_TermAssignment.json | 6 +- .../examples/Discovery_Query_Type.json | 4 +- .../examples/Discovery_Suggest.json | 4 +- .../2023-09-01/examples/Entity_AddLabel.json | 2 +- .../examples/Entity_RemoveLabels.json | 2 +- .../Entity_RemoveLabelsByUniqueAttribute.json | 2 +- .../2023-09-01/examples/Entity_SetLabels.json | 2 +- .../Entity_SetLabelsByUniqueAttribute.json | 2 +- .../stable/2023-09-01/openapi.json | 646 +++--------------- 59 files changed, 159 insertions(+), 1085 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json index c72ac2ff8bc7..1e66eeacb8e6 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json @@ -1,13 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteRequest": { + "autoCompleteOptions": { "keywords": "exa", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path", "includeSubTypes": false } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json index 492831046ac5..ab3e46e7ffd1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -1,17 +1,15 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json index 7e22975d4398..a406c5da1a39 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json @@ -1,18 +1,15 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" }, { - "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json index 3a9ae834aca7..da0ff4a9dac9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json @@ -1,33 +1,27 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" }, { - "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" }, { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { - "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "prefix", "attributeValue": "https://" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json index 86290bbcb119..dd7f72f754c7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json @@ -1,118 +1,90 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "AssetTypeFilter", "assetType": "SQL Server" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Server" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Database" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Data Warehouse" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Managed Instance" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Storage Account" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Blob Storage" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Files" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Table Storage" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen1" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen2" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Cosmos DB" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Factory" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Cognitive Search" }, { - "kind": "AssetTypeFilter", "assetType": "Power BI" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Explorer" }, { - "kind": "AssetTypeFilter", "assetType": "Amazon S3" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Share" }, { - "kind": "AssetTypeFilter", "assetType": "Teradata" }, { - "kind": "AssetTypeFilter", "assetType": "SAP S4HANA" }, { - "kind": "AssetTypeFilter", "assetType": "SAP ECC" }, { - "kind": "AssetTypeFilter", "assetType": "SQL Server Integration Services" }, { - "kind": "AssetTypeFilter", "assetType": "hive" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Database for MySQL" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Database for MariaDB" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Database for PostgreSQL" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Synapse Analytics" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json index 8d2fffbdbe6c..7794508c857b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json @@ -1,26 +1,22 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { - "kind": "AttributeFilter", "attributeName": "createTime", "operator": "ge", "attributeValue": 1545580800000 }, { - "kind": "AttributeFilter", "attributeName": "modifiedTime", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json index 8440b75e8bb0..df16a5e71226 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json @@ -1,32 +1,27 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|contains|prefix", "attributeValue": "string value" }, { - "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|gt|ge|lt|le", "attributeValue": 123 }, { - "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne", "attributeValue": true }, { - "kind": "AttributeFilter", "attributeName": ".", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json index e4acf8953fd9..c48e1d62ae9e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json @@ -1,11 +1,10 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "ClassificationFilter", "classification": "MICROSOFT.PERSONAL.EMAIL", "includeSubClassifications": true } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json index 7bc0050cdbf9..b882bd1f8625 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json @@ -1,11 +1,10 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "CollectionIdFilter", "collectionId": "collectionName" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json index 7e405380bc97..dff9e4350cc4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json @@ -1,10 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "filter": { - "kind": "ObjectTypeFilter", "objectType": "Tables" }, "limit": 10, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json index 3d7c7df01515..1492aec21fec 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json @@ -1,14 +1,12 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "FileExtensionFilter", "fileExtension": "txt" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json index 88ba90fac05a..d22c6cefe4e9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json @@ -1,25 +1,20 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "", "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Glossary terms" }, { - "kind": "OrFilter", "or": [ { - "kind": "GlossaryFilter", "glossaryType": "AtlasGlossary" }, { - "kind": "GlossaryFilter", "glossaryType": "AtlasGlossaryTerm" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json index e6dca741f27e..50daf5d6ad55 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json @@ -1,14 +1,12 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "IdFilter", "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json index f83d9c4fe8ff..95ab27e8cabd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json @@ -1,13 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "NotFilter", "not": { - "kind": "ClassificationFilter", "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json index b82032c0fc01..25626373d72b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json @@ -1,42 +1,33 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "ObjectTypeFilter", "objectType": "Dashboards" }, { - "kind": "ObjectTypeFilter", "objectType": "Data pipelines" }, { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "ObjectTypeFilter", "objectType": "Folders" }, { - "kind": "ObjectTypeFilter", "objectType": "Glossary terms" }, { - "kind": "ObjectTypeFilter", "objectType": "Reports" }, { - "kind": "ObjectTypeFilter", "objectType": "Stored procedures" }, { - "kind": "ObjectTypeFilter", "objectType": "Tables" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json index b31d7c5ec0c5..a66ca26aa4a0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json @@ -1,17 +1,14 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json index 9850911bcf03..b455624752ee 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json @@ -1,17 +1,14 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json index 5662bc6bfdcb..ae9bfbbcff07 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json @@ -1,17 +1,14 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json index 11480b40e5a3..838b5e819c2e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json @@ -1,21 +1,18 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "CreateTimeFilter", "createTime": { "operator": "lt", "timeThreshold": 1545580800000 } }, { - "kind": "UpdateTimeFilter", "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json index bd3d05a55ad5..c9149a034c03 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json @@ -1,28 +1,22 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "NotFilter", "not": { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": "size", "operator": "eq", "attributeValue": 0 }, { - "kind": "AttributeFilter", "attributeName": "fileSize", "operator": "eq", "attributeValue": 0 @@ -31,9 +25,7 @@ } }, { - "kind": "NotFilter", "not": { - "kind": "ClassificationFilter", "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json index a447c0782037..ea57c1f9172b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json @@ -1,23 +1,19 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "", "limit": 3, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "TermFilter", "term": "ExampleTerm" }, { - "kind": "TermFilter", "term": "ExampleTerm", "glossary": "GlossaryName" }, { - "kind": "TermFilter", "termGuid": "" } ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json index 3d26b95cffed..e7527913f485 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json @@ -1,14 +1,12 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path", "includeSubTypes": false } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json index b39d1fb4f0ef..4860aa9447b7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -1,13 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path", "includeSubTypes": false } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json index 6c8c8ccf153d..c387ae7465a3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json index 743f676c786b..1003d8d8e42b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json index 3ae4c0b565f8..0ed8eff354db 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "body": [ + "labels": [ "label1" ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json index e2b2c2eb6344..ea45a92feb08 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json index 9ffba096b022..8d671ff5f91a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index e67921764a74..a5be09fa17e0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -918,7 +918,7 @@ model AtlasGlossaryExtInfo { } @doc("The search query of advanced search request.") -model SearchOptions { +model QueryOptions { @doc("The keywords applied to all searchable fields.") keywords?: string; @@ -936,11 +936,10 @@ batch, and will return new token in each response unless there's no more data. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "This is a flexible property" @doc("The sort order of search results, can specify multiple fields.") - orderby?: unknown[]; + orderby?: bytes; - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The filter for the search. See examples for the usage of supported filters.") - filter?: unknown; + filter?: bytes; @doc("The facets for search. See examples for the usage of supported facets.") facets?: SearchFacetItem[]; @@ -989,7 +988,7 @@ model SearchTaxonomySetting { } @doc("The result of the search result.") -model SearchResult { +model QueryResult { @doc(""" The total number of search results (not the number of documents in a single page). @@ -1214,7 +1213,7 @@ must be a number between 1 and 100. limit?: int32; @doc("The filter for the search.") - filter?: SearchFilter; + filter?: bytes; } @doc("The result item of the search suggest.") @@ -1321,7 +1320,7 @@ The value must be a number between 1 and 100. limit?: int32; @doc("The filter for the autocomplete request.") - filter?: SearchFilter; + filter?: bytes; } @doc("The result of the autocomplete request.") @@ -1968,256 +1967,3 @@ model AtlasTypeDefHeader { @doc("The name of the type definition.") name?: string; } - -@discriminator("kind") -@doc("Base model for search filter") -model SearchFilter {} - -@doc("And filter for search") -model AndFilter extends SearchFilter { - @doc("And filter for search") - kind: "AndFilter"; - - @doc("List of filters") - @projectedName("json", "and") - andFilters: SearchFilter[]; -} - -@doc("Not filter for search") -model NotFilter extends SearchFilter { - @doc("Not filter for search") - kind: "NotFilter"; - - @doc("Not filter") - @projectedName("json", "not") - notFilters: SearchFilter; -} - -@doc("Or filter for search") -model OrFilter extends SearchFilter { - @doc("Or filter for search") - kind: "OrFilter"; - - @doc("List of filters") - @projectedName("json", "or") - orFilters: SearchFilter[]; -} - -@doc("Asset type filter for search") -model AssetTypeFilter extends SearchFilter { - @doc("Asset type filter for search") - kind: "AssetTypeFilter"; - - @doc("Asset type name") - assetType: string; -} - -@doc("Attribute filter for search") -model AttributeFilter extends SearchFilter { - @doc("Attribute filter for search") - kind: "AttributeFilter"; - - @doc("Attribute name") - attributeName: string; - - @doc("Operator") - operator: FilterOperator; - - #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" - @doc("Attribute value") - attributeValue: unknown; -} - -@doc("Classification type filter for search") -model ClassificationFilter extends SearchFilter { - @doc("Classification type filter for search") - kind: "ClassificationFilter"; - - @doc("Classification name") - classification: string; - - @doc("Whether to include sub classifications") - includeSubClassifications?: boolean; -} - -@doc("Classification category filter for search") -model ClassificationCategoryFilter extends SearchFilter { - @doc("Classification category filter for search") - kind: "ClassificationCategoryFilter"; - - @doc("Classification category") - classificationCategory: string; -} - -@doc("Collection id filter for search") -model CollectionIdFilter extends SearchFilter { - @doc("Collection id filter for search") - kind: "CollectionIdFilter"; - - @doc("Collection id") - collectionId: string; -} - -@doc("Contact filter for search") -model ContactFilter extends SearchFilter { - @doc("Contact filter for search") - kind: "ContactFilter"; - - @doc("Contact type") - contactType?: string; - - @doc("Contact Id") - contactId?: string; -} - -@doc("Domain id filter for search") -model DomainIdFilter extends SearchFilter { - @doc("Domain id filter for search") - kind: "DomainIdFilter"; - - @doc("Domain id") - domainId: string; -} - -@doc("Exists filter for search") -model ExistsFilter extends SearchFilter { - @doc("Exists filter for search") - kind: "ExistsFilter"; - - @projectedName("json", "exists") - @doc("Field") - field: string; -} - -@doc("File extension filter for search") -model FileExtensionFilter extends SearchFilter { - @doc("File extension filter for search") - kind: "FileExtensionFilter"; - - @doc("File extension") - fileExtension: string; -} - -@doc("Label filter for search") -model LabelFilter extends SearchFilter { - @doc("Label filter for search") - kind: "LabelFilter"; - - @doc("Label") - label: string; - - @doc("Whether to include sub labels") - includeSubLabels?: boolean; -} - -@doc("Label filter for search") -model ObjectTypeFilter extends SearchFilter { - @doc("Label filter for search") - kind: "ObjectTypeFilter"; - - @doc("Object type") - objectType: string; -} - -@doc("Path filter for search") -model PathFilter extends SearchFilter { - @doc("Path filter for search") - kind: "PathFilter"; - - @doc("Path") - path: string; - - @doc("Whether the path is parent path") - isParent?: boolean; -} - -@doc("Scan info filter for search") -model ScanInfoFilter extends SearchFilter { - @doc("Scan info filter for search") - kind: "ScanInfoFilter"; - - @doc("Data source name") - dataSourceName?: string; - - @doc("Scan name") - scanName?: string; -} - -@doc("Glossary filter for search") -model GlossaryFilter extends SearchFilter { - @doc("Glossary filter for search") - kind: "GlossaryFilter"; - - @doc("Glossary type. Either AtlasGlossary or AtlasGlossaryType") - glossaryType: string; -} - -@doc("Glossary term filter for search") -model TermFilter extends SearchFilter { - @doc("Term filter for search") - kind: "TermFilter"; - - @doc("Glossary name") - glossary?: string; - - @doc("Term name") - term?: string; - - @doc("Term name") - termGuid?: string; -} - -@doc("Id filter for search") -model IdFilter extends SearchFilter { - @doc("Id filter for search") - kind: "IdFilter"; - - @doc("Id value") - id: string; -} - -@doc("Entity type filter for search") -model EntityTypeFilter extends SearchFilter { - @doc("Type filter for search") - kind: "EntityTypeFilter"; - - @doc("Type name") - entityType: string; - - @doc("Whether to include sub types") - includeSubTypes?: boolean; -} - -#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" -@doc("Create time filter for search") -model CreateTimeFilter extends SearchFilter { - @doc("Create time filter for search") - kind: "CreateTimeFilter"; - - @doc(""" -Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example -{ - "operator": "lt", - "timeThreshold": 1545580800000 -} -to represent the time filter, operator must be one of gt/lt/gte/lte -""") - createTime: unknown; -} - -#suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" -@doc("Update time filter for search") -model UpdateTimeFilter extends SearchFilter { - @doc("Update time filter for search") - kind: "UpdateTimeFilter"; - - @doc(""" -Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example -{ - "operator": "lt", - "timeThreshold": 1545580800000 -} -to represent the time filter, operator must be one of gt/lt/gte/lte -""") - updateTime: unknown; -} diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 58b05d4d31d3..faec6f56627b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -782,7 +782,7 @@ default is false. @doc("set of labels to be deleted") @body - body: string[]; + labels: string[]; }, void, {}, @@ -802,7 +802,7 @@ default is false. @doc("set of labels to be set to the entity") @body - body: string[]; + labels: string[]; }, void, {}, @@ -822,7 +822,7 @@ default is false. @doc("set of labels to be added") @body - body: string[]; + labels: string[]; }, void, {}, @@ -863,7 +863,7 @@ be changed to other unique attributes) @doc("set of labels to be deleted") @body - body: string[]; + labels: string[]; }, void, {}, @@ -906,7 +906,7 @@ be changed to other unique attributes) @doc("set of labels to be set") @body - body: string[]; + labels: string[]; }, void, {}, @@ -1680,9 +1680,9 @@ interface Discovery { { @doc("An object specifying the search criteria.") @body - searchRequest: SearchOptions; + queryOptions: QueryOptions; }, - SearchResult, + QueryResult, {}, AtlasErrorResponse >; @@ -1695,7 +1695,7 @@ interface Discovery { { @doc("An object specifying the suggest criteria.") @body - suggestRequest: SuggestOptions; + suggestOptions: SuggestOptions; }, SuggestResult, {}, @@ -1710,7 +1710,7 @@ interface Discovery { { @doc("An object specifying the autocomplete criteria.") @body - autoCompleteRequest: AutoCompleteOptions; + autoCompleteOptions: AutoCompleteOptions; }, AutoCompleteResult, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index c72ac2ff8bc7..1e66eeacb8e6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,13 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteRequest": { + "autoCompleteOptions": { "keywords": "exa", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path", "includeSubTypes": false } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 492831046ac5..ab3e46e7ffd1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,17 +1,15 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index 7e22975d4398..a406c5da1a39 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,18 +1,15 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" }, { - "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index 3a9ae834aca7..da0ff4a9dac9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,33 +1,27 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" }, { - "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "contains", "attributeValue": ".csv" }, { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { - "kind": "AttributeFilter", "attributeName": "qualifiedName", "operator": "prefix", "attributeValue": "https://" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index 86290bbcb119..dd7f72f754c7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,118 +1,90 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "AssetTypeFilter", "assetType": "SQL Server" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Server" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Database" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Data Warehouse" }, { - "kind": "AssetTypeFilter", "assetType": "Azure SQL Managed Instance" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Storage Account" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Blob Storage" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Files" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Table Storage" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen1" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Lake Storage Gen2" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Cosmos DB" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Factory" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Cognitive Search" }, { - "kind": "AssetTypeFilter", "assetType": "Power BI" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Explorer" }, { - "kind": "AssetTypeFilter", "assetType": "Amazon S3" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Data Share" }, { - "kind": "AssetTypeFilter", "assetType": "Teradata" }, { - "kind": "AssetTypeFilter", "assetType": "SAP S4HANA" }, { - "kind": "AssetTypeFilter", "assetType": "SAP ECC" }, { - "kind": "AssetTypeFilter", "assetType": "SQL Server Integration Services" }, { - "kind": "AssetTypeFilter", "assetType": "hive" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Database for MySQL" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Database for MariaDB" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Database for PostgreSQL" }, { - "kind": "AssetTypeFilter", "assetType": "Azure Synapse Analytics" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 8d2fffbdbe6c..7794508c857b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,26 +1,22 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": "name", "operator": "eq", "attributeValue": "exampledata.csv" }, { - "kind": "AttributeFilter", "attributeName": "createTime", "operator": "ge", "attributeValue": 1545580800000 }, { - "kind": "AttributeFilter", "attributeName": "modifiedTime", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 8440b75e8bb0..df16a5e71226 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,32 +1,27 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|contains|prefix", "attributeValue": "string value" }, { - "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne|gt|ge|lt|le", "attributeValue": 123 }, { - "kind": "AttributeFilter", "attributeName": ".", "operator": "eq|ne", "attributeValue": true }, { - "kind": "AttributeFilter", "attributeName": ".", "operator": "timerange", "attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index e4acf8953fd9..c48e1d62ae9e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,11 +1,10 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "ClassificationFilter", "classification": "MICROSOFT.PERSONAL.EMAIL", "includeSubClassifications": true } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 7bc0050cdbf9..b882bd1f8625 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,11 +1,10 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "CollectionIdFilter", "collectionId": "collectionName" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index 7e405380bc97..dff9e4350cc4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,10 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "filter": { - "kind": "ObjectTypeFilter", "objectType": "Tables" }, "limit": 10, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 3d7c7df01515..1492aec21fec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,14 +1,12 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "FileExtensionFilter", "fileExtension": "txt" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 88ba90fac05a..d22c6cefe4e9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,25 +1,20 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "", "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Glossary terms" }, { - "kind": "OrFilter", "or": [ { - "kind": "GlossaryFilter", "glossaryType": "AtlasGlossary" }, { - "kind": "GlossaryFilter", "glossaryType": "AtlasGlossaryTerm" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index e6dca741f27e..50daf5d6ad55 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,14 +1,12 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "IdFilter", "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index f83d9c4fe8ff..95ab27e8cabd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,13 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "NotFilter", "not": { - "kind": "ClassificationFilter", "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index b82032c0fc01..25626373d72b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,42 +1,33 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "ObjectTypeFilter", "objectType": "Dashboards" }, { - "kind": "ObjectTypeFilter", "objectType": "Data pipelines" }, { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "ObjectTypeFilter", "objectType": "Folders" }, { - "kind": "ObjectTypeFilter", "objectType": "Glossary terms" }, { - "kind": "ObjectTypeFilter", "objectType": "Reports" }, { - "kind": "ObjectTypeFilter", "objectType": "Stored procedures" }, { - "kind": "ObjectTypeFilter", "objectType": "Tables" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index b31d7c5ec0c5..a66ca26aa4a0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,17 +1,14 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 9850911bcf03..b455624752ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,17 +1,14 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 5662bc6bfdcb..ae9bfbbcff07 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,17 +1,14 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index 11480b40e5a3..838b5e819c2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,21 +1,18 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "CreateTimeFilter", "createTime": { "operator": "lt", "timeThreshold": 1545580800000 } }, { - "kind": "UpdateTimeFilter", "updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index bd3d05a55ad5..c9149a034c03 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,28 +1,22 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "ObjectTypeFilter", "objectType": "Files" }, { - "kind": "NotFilter", "not": { - "kind": "OrFilter", "or": [ { - "kind": "AttributeFilter", "attributeName": "size", "operator": "eq", "attributeValue": 0 }, { - "kind": "AttributeFilter", "attributeName": "fileSize", "operator": "eq", "attributeValue": 0 @@ -31,9 +25,7 @@ } }, { - "kind": "NotFilter", "not": { - "kind": "ClassificationFilter", "classification": "MICROSOFT.SYSTEM.TEMP_FILE" } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index a447c0782037..ea57c1f9172b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,23 +1,19 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": "", "limit": 3, "filter": { - "kind": "OrFilter", "or": [ { - "kind": "TermFilter", "term": "ExampleTerm" }, { - "kind": "TermFilter", "term": "ExampleTerm", "glossary": "GlossaryName" }, { - "kind": "TermFilter", "termGuid": "" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index 3d26b95cffed..e7527913f485 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,14 +1,12 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "queryOptions": { "keywords": null, "limit": 10, "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path", "includeSubTypes": false } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index b39d1fb4f0ef..4860aa9447b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,13 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestRequest": { + "queryOptions": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { - "kind": "EntityTypeFilter", "entityType": "azure_blob_path", "includeSubTypes": false } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json index 6c8c8ccf153d..c387ae7465a3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json index 743f676c786b..1003d8d8e42b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 3ae4c0b565f8..0ed8eff354db 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "body": [ + "labels": [ "label1" ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json index e2b2c2eb6344..ea45a92feb08 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index 9ffba096b022..8d671ff5f91a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "body": [ + "labels": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 47f7cfaad048..58b08cc35d75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -1114,7 +1114,7 @@ "type": "string" }, { - "name": "body", + "name": "labels", "in": "body", "description": "set of labels to be added", "required": true, @@ -1158,7 +1158,7 @@ "type": "string" }, { - "name": "body", + "name": "labels", "in": "body", "description": "set of labels to be set to the entity", "required": true, @@ -1202,7 +1202,7 @@ "type": "string" }, { - "name": "body", + "name": "labels", "in": "body", "description": "set of labels to be deleted", "required": true, @@ -1619,7 +1619,7 @@ "x-ms-client-name": "attr" }, { - "name": "body", + "name": "labels", "in": "body", "description": "set of labels to be set", "required": true, @@ -1671,7 +1671,7 @@ "x-ms-client-name": "attr" }, { - "name": "body", + "name": "labels", "in": "body", "description": "set of labels to be deleted", "required": true, @@ -4442,7 +4442,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "autoCompleteRequest", + "name": "autoCompleteOptions", "in": "body", "description": "An object specifying the autocomplete criteria.", "required": true, @@ -4481,12 +4481,12 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "searchRequest", + "name": "queryOptions", "in": "body", "description": "An object specifying the search criteria.", "required": true, "schema": { - "$ref": "#/definitions/SearchOptions" + "$ref": "#/definitions/QueryOptions" } } ], @@ -4494,7 +4494,7 @@ "200": { "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SearchResult" + "$ref": "#/definitions/QueryResult" } }, "default": { @@ -4580,7 +4580,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "suggestRequest", + "name": "suggestOptions", "in": "body", "description": "An object specifying the suggest criteria.", "required": true, @@ -4686,30 +4686,6 @@ } }, "definitions": { - "AndFilter": { - "type": "object", - "description": "And filter for search", - "properties": { - "and": { - "type": "array", - "description": "List of filters", - "items": { - "$ref": "#/definitions/SearchFilter" - }, - "x-ms-client-name": "andFilters", - "x-ms-identifiers": [] - } - }, - "required": [ - "and" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AndFilter" - }, "ApiVersions": { "type": "string", "description": "Service API versions", @@ -4728,25 +4704,6 @@ ] } }, - "AssetTypeFilter": { - "type": "object", - "description": "Asset type filter for search", - "properties": { - "assetType": { - "type": "string", - "description": "Asset type name" - } - }, - "required": [ - "assetType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AssetTypeFilter" - }, "AtlasAttributeDef": { "type": "object", "description": "class that captures details of a struct-attribute.", @@ -7207,34 +7164,6 @@ } } }, - "AttributeFilter": { - "type": "object", - "description": "Attribute filter for search", - "properties": { - "attributeName": { - "type": "string", - "description": "Attribute name" - }, - "operator": { - "$ref": "#/definitions/FilterOperator", - "description": "Operator" - }, - "attributeValue": { - "description": "Attribute value" - } - }, - "required": [ - "attributeName", - "operator", - "attributeValue" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "AttributeFilter" - }, "AuthToken": { "type": "object", "description": "The Azure Active Directory OAuth2 Flow", @@ -7271,7 +7200,8 @@ "description": "The number of autocomplete results we hope to return. The default value is 50.\nThe value must be a number between 1 and 100." }, "filter": { - "$ref": "#/definitions/SearchFilter", + "type": "string", + "format": "byte", "description": "The filter for the autocomplete request." } } @@ -7408,87 +7338,6 @@ } } }, - "ClassificationCategoryFilter": { - "type": "object", - "description": "Classification category filter for search", - "properties": { - "classificationCategory": { - "type": "string", - "description": "Classification category" - } - }, - "required": [ - "classificationCategory" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ClassificationCategoryFilter" - }, - "ClassificationFilter": { - "type": "object", - "description": "Classification type filter for search", - "properties": { - "classification": { - "type": "string", - "description": "Classification name" - }, - "includeSubClassifications": { - "type": "boolean", - "description": "Whether to include sub classifications" - } - }, - "required": [ - "classification" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ClassificationFilter" - }, - "CollectionIdFilter": { - "type": "object", - "description": "Collection id filter for search", - "properties": { - "collectionId": { - "type": "string", - "description": "Collection id" - } - }, - "required": [ - "collectionId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "CollectionIdFilter" - }, - "ContactFilter": { - "type": "object", - "description": "Contact filter for search", - "properties": { - "contactType": { - "type": "string", - "description": "Contact type" - }, - "contactId": { - "type": "string", - "description": "Contact Id" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ContactFilter" - }, "ContactInfo": { "type": "object", "description": "ContactInfo", @@ -7521,24 +7370,6 @@ } } }, - "CreateTimeFilter": { - "type": "object", - "description": "Create time filter for search", - "properties": { - "createTime": { - "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n}\nto represent the time filter, operator must be one of gt/lt/gte/lte" - } - }, - "required": [ - "createTime" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "CreateTimeFilter" - }, "DateFormat": { "type": "object", "description": "The date format.", @@ -7585,25 +7416,6 @@ } } }, - "DomainIdFilter": { - "type": "object", - "description": "Domain id filter for search", - "properties": { - "domainId": { - "type": "string", - "description": "Domain id" - } - }, - "required": [ - "domainId" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "DomainIdFilter" - }, "EntityMutationResult": { "type": "object", "description": "The mutation response result of entity.", @@ -7660,68 +7472,6 @@ ] } }, - "EntityTypeFilter": { - "type": "object", - "description": "Entity type filter for search", - "properties": { - "entityType": { - "type": "string", - "description": "Type name" - }, - "includeSubTypes": { - "type": "boolean", - "description": "Whether to include sub types" - } - }, - "required": [ - "entityType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "EntityTypeFilter" - }, - "ExistsFilter": { - "type": "object", - "description": "Exists filter for search", - "properties": { - "exists": { - "type": "string", - "description": "Field", - "x-ms-client-name": "field" - } - }, - "required": [ - "exists" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ExistsFilter" - }, - "FileExtensionFilter": { - "type": "object", - "description": "File extension filter for search", - "properties": { - "fileExtension": { - "type": "string", - "description": "File extension" - } - }, - "required": [ - "fileExtension" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "FileExtensionFilter" - }, "FilterOperator": { "type": "string", "description": "Search Filter Operator", @@ -7800,44 +7550,6 @@ ] } }, - "GlossaryFilter": { - "type": "object", - "description": "Glossary filter for search", - "properties": { - "glossaryType": { - "type": "string", - "description": "Glossary type. Either AtlasGlossary or AtlasGlossaryType" - } - }, - "required": [ - "glossaryType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "GlossaryFilter" - }, - "IdFilter": { - "type": "object", - "description": "Id filter for search", - "properties": { - "id": { - "type": "string", - "description": "Id value" - } - }, - "required": [ - "id" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "IdFilter" - }, "ImportInfo": { "type": "object", "description": "ImportInfo", @@ -7884,29 +7596,6 @@ ] } }, - "LabelFilter": { - "type": "object", - "description": "Label filter for search", - "properties": { - "label": { - "type": "string", - "description": "Label" - }, - "includeSubLabels": { - "type": "boolean", - "description": "Whether to include sub labels" - } - }, - "required": [ - "label" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "LabelFilter" - }, "LineageDirection": { "type": "string", "description": "Lineage direction", @@ -7968,26 +7657,6 @@ } } }, - "NotFilter": { - "type": "object", - "description": "Not filter for search", - "properties": { - "not": { - "$ref": "#/definitions/SearchFilter", - "description": "Not filter", - "x-ms-client-name": "notFilters" - } - }, - "required": [ - "not" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "NotFilter" - }, "NumberFormat": { "type": "object", "description": "The number format.", @@ -8057,49 +7726,6 @@ } } }, - "ObjectTypeFilter": { - "type": "object", - "description": "Label filter for search", - "properties": { - "objectType": { - "type": "string", - "description": "Object type" - } - }, - "required": [ - "objectType" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ObjectTypeFilter" - }, - "OrFilter": { - "type": "object", - "description": "Or filter for search", - "properties": { - "or": { - "type": "array", - "description": "List of filters", - "items": { - "$ref": "#/definitions/SearchFilter" - }, - "x-ms-client-name": "orFilters", - "x-ms-identifiers": [] - } - }, - "required": [ - "or" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "OrFilter" - }, "PList": { "type": "object", "description": "Paginated-list, for returning search results.", @@ -8152,29 +7778,6 @@ } } }, - "PathFilter": { - "type": "object", - "description": "Path filter for search", - "properties": { - "path": { - "type": "string", - "description": "Path" - }, - "isParent": { - "type": "boolean", - "description": "Whether the path is parent path" - } - }, - "required": [ - "path" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "PathFilter" - }, "PurviewObjectId": { "type": "object", "description": "PurviewObjectId", @@ -8215,6 +7818,80 @@ } } }, + "QueryOptions": { + "type": "object", + "description": "The search query of advanced search request.", + "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\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, and will return new token in each response unless there's no more data." + }, + "orderby": { + "type": "string", + "format": "byte", + "description": "The sort order of search results, can specify multiple fields." + }, + "filter": { + "type": "string", + "format": "byte", + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, + "QueryResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "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", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + } + }, "RelationshipCategory": { "type": "string", "description": "Relationship Category", @@ -8319,26 +7996,6 @@ ] } }, - "ScanInfoFilter": { - "type": "object", - "description": "Scan info filter for search", - "properties": { - "dataSourceName": { - "type": "string", - "description": "Data source name" - }, - "scanName": { - "type": "string", - "description": "Scan name" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "ScanInfoFilter" - }, "SearchFacetItem": { "type": "object", "description": "The content of a search facet result item.", @@ -8473,20 +8130,6 @@ } } }, - "SearchFilter": { - "type": "object", - "description": "Base model for search filter", - "properties": { - "kind": { - "type": "string", - "description": "Discriminator property for SearchFilter." - } - }, - "discriminator": "kind", - "required": [ - "kind" - ] - }, "SearchHighlights": { "type": "object", "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", @@ -8528,78 +8171,6 @@ } } }, - "SearchOptions": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, - "SearchResult": { - "type": "object", - "description": "The result of the search result.", - "properties": { - "@search.count": { - "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single\npage).", - "x-ms-client-name": "searchCount" - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa.", - "x-ms-client-name": "searchCountApproximate" - }, - "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", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "x-ms-client-name": "searchFacets" - }, - "value": { - "type": "array", - "description": "Search result value", - "items": { - "$ref": "#/definitions/SearchResultValue" - } - } - } - }, "SearchResultValue": { "type": "object", "description": "The value item of the search result.", @@ -8827,7 +8398,8 @@ "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." }, "filter": { - "$ref": "#/definitions/SearchFilter", + "type": "string", + "format": "byte", "description": "The filter for the search." } } @@ -8963,30 +8535,6 @@ } } }, - "TermFilter": { - "type": "object", - "description": "Glossary term filter for search", - "properties": { - "glossary": { - "type": "string", - "description": "Glossary name" - }, - "term": { - "type": "string", - "description": "Term name" - }, - "termGuid": { - "type": "string", - "description": "Term name" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "TermFilter" - }, "TermSearchResultValue": { "type": "object", "description": "The context.", @@ -9289,24 +8837,6 @@ } ] } - }, - "UpdateTimeFilter": { - "type": "object", - "description": "Update time filter for search", - "properties": { - "updateTime": { - "description": "Either using a string 'LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D', or using a map for example\n{\n \"operator\": \"lt\",\n \"timeThreshold\": 1545580800000\n}\nto represent the time filter, operator must be one of gt/lt/gte/lte" - } - }, - "required": [ - "updateTime" - ], - "allOf": [ - { - "$ref": "#/definitions/SearchFilter" - } - ], - "x-ms-discriminator-value": "UpdateTimeFilter" } }, "parameters": { From 31161c89badfcec69949c5a07458cb7e6b790ea8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 14:31:20 +0800 Subject: [PATCH 075/132] update --- .../Azure.Analytics.Purview.DataMap/client.tsp | 6 +++--- .../Azure.Analytics.Purview.DataMap/models.tsp | 11 +++++++---- .../stable/2023-09-01/openapi.json | 12 +++--------- 3 files changed, 13 insertions(+), 16 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 41a11e15bcd9..8eb8854914c8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -20,7 +20,7 @@ interface Entity { batchDelete is PurviewDataMap.Entity.bulkDelete; addClassification is PurviewDataMap.Entity.addClassification; get is PurviewDataMap.Entity.get; - partialUpdateAttributeById is PurviewDataMap.Entity.partialUpdateAttributeByGuid; + updateAttributeById is PurviewDataMap.Entity.partialUpdateAttributeByGuid; delete is PurviewDataMap.Entity.delete; getClassification is PurviewDataMap.Entity.getClassification; removeClassification is PurviewDataMap.Entity.removeClassification; @@ -28,7 +28,7 @@ interface Entity { addClassifications is PurviewDataMap.Entity.addClassifications; updateClassifications is PurviewDataMap.Entity.updateClassifications; getByAttributes is PurviewDataMap.Entity.getByUniqueAttributes; - partialUpdateByAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; + updateByAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; deleteByAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; removeClassificationByAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; addClassificationsByAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; @@ -40,7 +40,7 @@ interface Entity { addOrUpdateBusinessMetadata is PurviewDataMap.Entity.addOrUpdateBusinessMetadata; removeBusinessMetadataAttributes is PurviewDataMap.Entity.removeBusinessMetadataAttributes; addOrUpdateBusinessMetadataAttributes is PurviewDataMap.Entity.addOrUpdateBusinessMetadataAttributes; - getSampleBusinessMetadataTemplate is PurviewDataMap.Entity.getSampleBusinessMetadataTemplate; + getBusinessMetadataTemplate is PurviewDataMap.Entity.getSampleBusinessMetadataTemplate; #suppress "@azure-tools/typespec-azure-core/byos" "This is Atlas API" importBusinessMetadata is PurviewDataMap.Entity.importBusinessMetadata; removeLabels is PurviewDataMap.Entity.removeLabels; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index a5be09fa17e0..f9d6c739535f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -936,10 +936,11 @@ batch, and will return new token in each response unless there's no more data. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "This is a flexible property" @doc("The sort order of search results, can specify multiple fields.") - orderby?: bytes; + orderby?: unknown[]; + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The filter for the search. See examples for the usage of supported filters.") - filter?: bytes; + filter?: unknown; @doc("The facets for search. See examples for the usage of supported facets.") facets?: SearchFacetItem[]; @@ -1212,8 +1213,9 @@ must be a number between 1 and 100. """) limit?: int32; + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The filter for the search.") - filter?: bytes; + filter?: unknown; } @doc("The result item of the search suggest.") @@ -1319,8 +1321,9 @@ The value must be a number between 1 and 100. """) limit?: int32; + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc("The filter for the autocomplete request.") - filter?: bytes; + filter?: unknown; } @doc("The result of the autocomplete request.") diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 58b08cc35d75..c6de26fd8c1b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -7200,8 +7200,6 @@ "description": "The number of autocomplete results we hope to return. The default value is 50.\nThe value must be a number between 1 and 100." }, "filter": { - "type": "string", - "format": "byte", "description": "The filter for the autocomplete request." } } @@ -7836,13 +7834,11 @@ "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, and will return new token in each response unless there's no more data." }, "orderby": { - "type": "string", - "format": "byte", - "description": "The sort order of search results, can specify multiple fields." + "type": "array", + "description": "The sort order of search results, can specify multiple fields.", + "items": {} }, "filter": { - "type": "string", - "format": "byte", "description": "The filter for the search. See examples for the usage of supported filters." }, "facets": { @@ -8398,8 +8394,6 @@ "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." }, "filter": { - "type": "string", - "format": "byte", "description": "The filter for the search." } } From ef383a889e381c68addb07b319161846270036e7 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 14:41:16 +0800 Subject: [PATCH 076/132] fix example bug --- .../examples/2023-09-01/Discovery_Suggest.json | 2 +- .../stable/2023-09-01/examples/Discovery_Suggest.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json index 4860aa9447b7..87bce45ca85a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "suggestOptions": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index 4860aa9447b7..87bce45ca85a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "suggestOptions": { "keywords": "exampledata", "filter": { "and": [ From 5e308e86aae9159e4e91fc46d988260caf28f41c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 14:47:58 +0800 Subject: [PATCH 077/132] update partalUpdates --- .../examples/2023-09-01/Glossary_PartialUpdateTerm.json | 2 +- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 2 +- .../2023-09-01/examples/Glossary_PartialUpdateTerm.json | 2 +- .../stable/2023-09-01/openapi.json | 7 ++++++- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json index cb5542825495..dc999f7c3efc 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "partialUpdates": { - "longDescription": "Example Long Descrition" + "longDescription": "Example Long Description" } }, "responses": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index faec6f56627b..a9d9e05727b8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1300,7 +1300,7 @@ A map containing keys as attribute names and values as corresponding attribute values to be updated. """) @body - partialUpdates: unknown; + partialUpdates: Record; }, AtlasGlossaryTerm, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index cb5542825495..dc999f7c3efc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "partialUpdates": { - "longDescription": "Example Long Descrition" + "longDescription": "Example Long Description" } }, "responses": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index c6de26fd8c1b..3f7105f39f39 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -2839,7 +2839,12 @@ "in": "body", "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", "required": true, - "schema": {} + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { From f0afe46ec35ed26412f61b5f319edca89c904fb8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 15:18:35 +0800 Subject: [PATCH 078/132] update query parameter overwrite --- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 5 +++-- .../stable/2023-09-01/openapi.json | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index a9d9e05727b8..b28a1138d7fb 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -678,8 +678,9 @@ example. qualifiedName can be changed to other unique attributes) Whether to overwrite the existing business metadata on the entity or not, default is false. """) - @query - isOverwrite?: boolean; + + @query("isOverwrite") + overwrite?: boolean; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("BusinessMetadata payload") diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 3f7105f39f39..4b854024baea 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -672,7 +672,8 @@ "in": "query", "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", "required": false, - "type": "boolean" + "type": "boolean", + "x-ms-client-name": "overwrite" }, { "name": "businessMetadata", From 169af0b8106f48e56ecd38211c171f332600538d Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 15:30:26 +0800 Subject: [PATCH 079/132] Update attr to attribute --- .../routes.tsp | 20 +++++++++---------- .../stable/2023-09-01/openapi.json | 20 +++++++++---------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index b28a1138d7fb..49d2c01973a9 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -395,7 +395,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; }, AtlasEntityWithExtInfo, {}, @@ -434,7 +434,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; @doc("Atlas entity with extended information.") @body @@ -473,7 +473,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; }, EntityMutationResult, {}, @@ -502,7 +502,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; }, void, {}, @@ -525,7 +525,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; @doc("An array of classification to be added.") @body @@ -552,7 +552,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; @doc("An array of classification to be updated.") @body @@ -860,7 +860,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; @doc("set of labels to be deleted") @body @@ -903,7 +903,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; @doc("set of labels to be set") @body @@ -946,7 +946,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; @doc("set of labels to be added") @body @@ -1810,7 +1810,7 @@ The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) """) @query("attr:qualifiedName") - attr?: string; + attribute?: string; }, AtlasLineageInfo, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 4b854024baea..c1c4ebab51ca 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -1268,7 +1268,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" } ], "responses": { @@ -1311,7 +1311,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" }, { "name": "atlasEntityWithExtInfo", @@ -1363,7 +1363,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" } ], "responses": { @@ -1415,7 +1415,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" } ], "responses": { @@ -1457,7 +1457,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" }, { "name": "atlasClassificationArray", @@ -1510,7 +1510,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" }, { "name": "classifications", @@ -1565,7 +1565,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" }, { "name": "labels", @@ -1617,7 +1617,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" }, { "name": "labels", @@ -1669,7 +1669,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" }, { "name": "labels", @@ -3284,7 +3284,7 @@ "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, "type": "string", - "x-ms-client-name": "attr" + "x-ms-client-name": "attribute" } ], "responses": { From 2e3fef10eb4a1e4541ddd1801364c401a559e7a6 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 2 Jan 2024 17:23:15 +0800 Subject: [PATCH 080/132] Update partialUpdates --- .../Azure.Analytics.Purview.DataMap/routes.tsp | 4 ++-- .../stable/2023-09-01/openapi.json | 14 ++++++++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 49d2c01973a9..1290eee86bdf 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1138,7 +1138,7 @@ A map containing keys as attribute names and values as corresponding attribute values for partial update. """) @body - partialUpdates: unknown; + partialUpdates: Record; }, AtlasGlossaryCategory, {}, @@ -1604,7 +1604,7 @@ A map containing keys as attribute names and values as corresponding attribute values. """) @body - partialUpdates: unknown; + partialUpdates: Record; }, AtlasGlossary, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index c1c4ebab51ca..16561714eda9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -2115,7 +2115,12 @@ "in": "body", "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", "required": true, - "schema": {} + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { @@ -2486,7 +2491,12 @@ "in": "body", "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", "required": true, - "schema": {} + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { From 7219cbdce80c06404ed85b3261622a2d820503c2 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 12:50:36 +0800 Subject: [PATCH 081/132] align using body parameter --- .../2023-09-01/Discovery_AutoComplete.json | 2 +- .../examples/2023-09-01/Discovery_Query.json | 2 +- .../2023-09-01/Discovery_Query_And.json | 2 +- .../Discovery_Query_AndOrNested.json | 2 +- .../2023-09-01/Discovery_Query_AssetType.json | 2 +- .../2023-09-01/Discovery_Query_Attribute.json | 2 +- ...overy_Query_BusinessMetadataAttribute.json | 2 +- .../Discovery_Query_Classification.json | 2 +- .../Discovery_Query_Collection.json | 2 +- .../2023-09-01/Discovery_Query_Facet.json | 2 +- .../Discovery_Query_FileExtension.json | 2 +- .../Discovery_Query_GlossaryTerm.json | 2 +- .../2023-09-01/Discovery_Query_Id.json | 2 +- .../2023-09-01/Discovery_Query_Not.json | 2 +- .../Discovery_Query_ObjectType.json | 2 +- ...very_Query_PaginationContinuationPage.json | 2 +- .../Discovery_Query_PaginationFirstPage.json | 2 +- .../Discovery_Query_PaginationLastPage.json | 2 +- .../Discovery_Query_SystemTime.json | 2 +- .../2023-09-01/Discovery_Query_Taxonomy.json | 2 +- .../Discovery_Query_TermAssignment.json | 2 +- .../2023-09-01/Discovery_Query_Type.json | 2 +- .../2023-09-01/Discovery_Suggest.json | 2 +- ...tity_AddClassificationToEntityByGuids.json | 2 +- .../2023-09-01/Entity_AddClassifications.json | 2 +- ...y_AddClassificationsByUniqueAttribute.json | 2 +- .../2023-09-01/Entity_AddCustomAttribute.json | 2 +- .../examples/2023-09-01/Entity_AddLabel.json | 2 +- .../Entity_AddLabelsByUniqueAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessMetadata.json | 2 +- .../2023-09-01/Entity_BulkCreateOrUpdate.json | 2 +- .../Entity_BulkSetClassifications.json | 2 +- .../examples/2023-09-01/Entity_Create.json | 2 +- .../Entity_MoveEntitiesToCollection.json | 2 +- ...ntity_PartialUpdateByUniqueAttributes.json | 2 +- .../Entity_RemoveBusinessAttribute.json | 2 +- .../Entity_RemoveBusinessMetadata.json | 2 +- .../2023-09-01/Entity_RemoveLabels.json | 2 +- .../Entity_RemoveLabelsByUniqueAttribute.json | 2 +- .../examples/2023-09-01/Entity_SetLabels.json | 2 +- .../Entity_SetLabelsByUniqueAttribute.json | 2 +- .../examples/2023-09-01/Entity_Update.json | 2 +- .../Entity_UpdateClassifications.json | 2 +- ...pdateClassificationsByUniqueAttribute.json | 2 +- .../Glossary_AssignTermToEntities.json | 2 +- .../examples/2023-09-01/Glossary_Create.json | 2 +- .../2023-09-01/Glossary_CreateCategories.json | 2 +- .../2023-09-01/Glossary_CreateCategory.json | 2 +- .../2023-09-01/Glossary_CreateTerm.json | 2 +- .../Glossary_CreateTermWithTemplate.json | 2 +- .../2023-09-01/Glossary_CreateTerms.json | 2 +- .../2023-09-01/Glossary_PartialUpdate.json | 2 +- .../Glossary_PartialUpdateTerm.json | 2 +- ...sary_RemoveTermAssignmentFromEntities.json | 2 +- .../examples/2023-09-01/Glossary_Update.json | 2 +- .../2023-09-01/Glossary_UpdateCategory.json | 2 +- .../2023-09-01/Glossary_UpdateTerm.json | 2 +- .../2023-09-01/Relationship_Create.json | 2 +- .../2023-09-01/Relationship_Update.json | 2 +- .../examples/2023-09-01/Type_BulkCreate.json | 2 +- .../Type_BulkCreateBusinessMetadataDefs.json | 2 +- .../examples/2023-09-01/Type_BulkDelete.json | 2 +- .../examples/2023-09-01/Type_BulkUpdate.json | 2 +- .../routes.tsp | 85 +++++++++---------- .../examples/Discovery_AutoComplete.json | 2 +- .../2023-09-01/examples/Discovery_Query.json | 2 +- .../examples/Discovery_Query_And.json | 2 +- .../examples/Discovery_Query_AndOrNested.json | 2 +- .../examples/Discovery_Query_AssetType.json | 2 +- .../examples/Discovery_Query_Attribute.json | 2 +- ...overy_Query_BusinessMetadataAttribute.json | 2 +- .../Discovery_Query_Classification.json | 2 +- .../examples/Discovery_Query_Collection.json | 2 +- .../examples/Discovery_Query_Facet.json | 2 +- .../Discovery_Query_FileExtension.json | 2 +- .../Discovery_Query_GlossaryTerm.json | 2 +- .../examples/Discovery_Query_Id.json | 2 +- .../examples/Discovery_Query_Not.json | 2 +- .../examples/Discovery_Query_ObjectType.json | 2 +- ...very_Query_PaginationContinuationPage.json | 2 +- .../Discovery_Query_PaginationFirstPage.json | 2 +- .../Discovery_Query_PaginationLastPage.json | 2 +- .../examples/Discovery_Query_SystemTime.json | 2 +- .../examples/Discovery_Query_Taxonomy.json | 2 +- .../Discovery_Query_TermAssignment.json | 2 +- .../examples/Discovery_Query_Type.json | 2 +- .../examples/Discovery_Suggest.json | 2 +- ...tity_AddClassificationToEntityByGuids.json | 2 +- .../examples/Entity_AddClassifications.json | 2 +- ...y_AddClassificationsByUniqueAttribute.json | 2 +- .../examples/Entity_AddCustomAttribute.json | 2 +- .../2023-09-01/examples/Entity_AddLabel.json | 2 +- .../Entity_AddLabelsByUniqueAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 2 +- .../Entity_AddOrUpdate_BusinessMetadata.json | 2 +- .../examples/Entity_BulkCreateOrUpdate.json | 2 +- .../Entity_BulkSetClassifications.json | 2 +- .../2023-09-01/examples/Entity_Create.json | 2 +- .../Entity_MoveEntitiesToCollection.json | 2 +- ...ntity_PartialUpdateByUniqueAttributes.json | 2 +- .../Entity_RemoveBusinessAttribute.json | 2 +- .../Entity_RemoveBusinessMetadata.json | 2 +- .../examples/Entity_RemoveLabels.json | 2 +- .../Entity_RemoveLabelsByUniqueAttribute.json | 2 +- .../2023-09-01/examples/Entity_SetLabels.json | 2 +- .../Entity_SetLabelsByUniqueAttribute.json | 2 +- .../2023-09-01/examples/Entity_Update.json | 2 +- .../Entity_UpdateClassifications.json | 2 +- ...pdateClassificationsByUniqueAttribute.json | 2 +- .../Glossary_AssignTermToEntities.json | 2 +- .../2023-09-01/examples/Glossary_Create.json | 2 +- .../examples/Glossary_CreateCategories.json | 2 +- .../examples/Glossary_CreateCategory.json | 2 +- .../examples/Glossary_CreateTerm.json | 2 +- .../Glossary_CreateTermWithTemplate.json | 2 +- .../examples/Glossary_CreateTerms.json | 2 +- .../examples/Glossary_PartialUpdate.json | 2 +- .../examples/Glossary_PartialUpdateTerm.json | 2 +- ...sary_RemoveTermAssignmentFromEntities.json | 2 +- .../2023-09-01/examples/Glossary_Update.json | 2 +- .../examples/Glossary_UpdateCategory.json | 2 +- .../examples/Glossary_UpdateTerm.json | 2 +- .../examples/Relationship_Create.json | 2 +- .../examples/Relationship_Update.json | 2 +- .../2023-09-01/examples/Type_BulkCreate.json | 2 +- .../Type_BulkCreateBusinessMetadataDefs.json | 2 +- .../2023-09-01/examples/Type_BulkDelete.json | 2 +- .../2023-09-01/examples/Type_BulkUpdate.json | 2 +- .../stable/2023-09-01/openapi.json | 82 +++++++++--------- 130 files changed, 211 insertions(+), 212 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json index 1e66eeacb8e6..b2f2665d5b36 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteOptions": { + "body": { "keywords": "exa", "filter": { "and": [ diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json index ab3e46e7ffd1..28c2961eee1f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "kind": "AndFilter", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json index a406c5da1a39..a1f45773a687 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json index da0ff4a9dac9..7ec39b19f500 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json index dd7f72f754c7..deb289d5ea22 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json index 7794508c857b..6d2ccf524020 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json index df16a5e71226..2ab33726a034 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json index c48e1d62ae9e..5150545e7d0f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json index b882bd1f8625..3779d9d497fe 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json index dff9e4350cc4..b417487bea7d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "filter": { "objectType": "Tables" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json index 1492aec21fec..0b7fee10f958 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json index d22c6cefe4e9..1af1169192d0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "", "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json index 50daf5d6ad55..1a983534fbce 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json index 95ab27e8cabd..4c6b90d682c4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json index 25626373d72b..f332749b05ee 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_ObjectType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json index a66ca26aa4a0..cbe86e93e8fa 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json index b455624752ee..fe5522da8ebf 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json index ae9bfbbcff07..4e64dd33405e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json index 838b5e819c2e..d2196fa7ea91 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json index c9149a034c03..f2f278e5c48b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json index ea57c1f9172b..0c24709432b3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "", "limit": 3, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json index e7527913f485..48480e13fc17 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json index 87bce45ca85a..3ff80bee52ec 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json index 6a2b6f529636..b94ab95331ec 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "request": { + "body": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json index 3bdb3c19b4a9..5ab64b05faac 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json index a5eea86a2b97..0a724e78e134 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json index b30d034aed83..5e50da3bc1c7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddCustomAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2023-09-01", - "entity": { + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json index c387ae7465a3..6c8c8ccf153d 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabel.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json index 2f9db0a93175..3a2bc5a3f537 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "labels": [ + "body": [ "label3" ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json index 34b3e5816cf3..f91a2897c1e2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "businessMetadataName": "myBizMetaData1", - "businessMetadataAttributes": { + "body": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json index 312894c87299..4141a16cc255 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_AddOrUpdate_BusinessMetadata.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadata": { + "body": { "myBizMetadata1": { "bizAttr1": "myBizMetaData1.bizAttr1" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json index ad389111aaac..81eb02f76d2e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entities": { + "body": { "referredEntities": {}, "entities": [ { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json index ea7c077e8df3..ceac402f49a7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entityHeaders": { + "body": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json index baf955ab8e7d..cf8647830754 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Create.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2023-09-01", - "entity": { + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json index 3ba4742d9a49..a9d546dacff1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "moveEntitiesRequest": { + "body": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json index 50f18d78fe73..40609617bfa7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_PartialUpdateByUniqueAttributes.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasEntityWithExtInfo": { + "body": { "entity": { "createTime": 1605766397985.0, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json index 53accfbf687d..717225e30454 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "businessMetadataName": "myBizMetaData1", - "businessMetadataAttributes": { + "body": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json index d02050e64adf..9e2de7361e36 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveBusinessMetadata.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadata": { + "body": { "myBizMetadata1": { "bizAttr1": "myBizMetaData1.bizAttr1" } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json index 1003d8d8e42b..743f676c786b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json index 0ed8eff354db..3ae4c0b565f8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_RemoveLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "labels": [ + "body": [ "label1" ] }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json index ea45a92feb08..e2b2c2eb6344 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json index 8d671ff5f91a..9ffba096b022 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_SetLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json index 99e21e91b2a8..40e2350403a5 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Update.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2023-09-01", - "entity": { + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json index bdf3ce57c20f..274b565b8f81 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json index acc71465ee0d..f3b1777a8e75 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json index 6ad1b726af7d..82aae3a1b087 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_AssignTermToEntities.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "body": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json index 2af15856d99f..01289fd09ee1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "atlasGlossary": { + "body": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json index 5e56de8fc2a1..7dfb49f4e1ae 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": [ + "body": [ { "name": "ExampleCategory2", "anchor": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json index cee2e98178e0..912e40a4e7ef 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": { + "body": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json index d9ff8a381e4e..bd988ea6973b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json index 635adc6d11ad..677877660bc8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json index 1c74cfa028c0..18fcddae9a04 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": [ + "body": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json index b5dfeca34a18..c06db55d9e38 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdate.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "partialUpdates": { + "body": { "longDescription": "Example Long Description" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json index dc999f7c3efc..356a70cf4da3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateTerm.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "partialUpdates": { + "body": { "longDescription": "Example Long Description" } }, diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json index 1dd9519f670c..2238f2443727 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_RemoveTermAssignmentFromEntities.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "body": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json index 06919b479bae..faca8b5cb2a2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_Update.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "updatedGlossary": { + "body": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json index cb450401bbc5..7c145590a59b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateCategory.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "glossaryCategory": { + "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json index 8fea21da5eb8..9ed4cb3964b7 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_UpdateTerm.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "glossaryTerm": { + "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json index 883d47b5986c..89d3b4e5afec 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json index 6287df03708b..0cd955fe3154 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json index cdb16a858b47..d91723b6e888 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json index 9ae93573b207..433ff8867948 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json index eda61c210ee7..60ba8acc3b75 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json index 3216472dba52..7905abbea1af 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 1290eee86bdf..26af3b91725f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -89,7 +89,7 @@ need to move an entity to another collection. @doc("Atlas entity with extended information.") @body - entity: AtlasEntityWithExtInfo; + body: AtlasEntityWithExtInfo; }, EntityMutationResult, {}, @@ -153,7 +153,7 @@ entities. @doc("An array of entities to create or update.") @body - entities: AtlasEntitiesWithExtInfo; + body: AtlasEntitiesWithExtInfo; }, EntityMutationResult, {}, @@ -189,7 +189,7 @@ attributes. { @doc("The request to associate a classification to multiple entities.") @body - request: ClassificationAssociateOptions; + body: ClassificationAssociateOptions; }, void, {}, @@ -330,7 +330,7 @@ Null updates are not possible. @doc("An array of classifications to be added.") @body - classifications: AtlasClassification[]; + body: AtlasClassification[]; }, void, {}, @@ -350,7 +350,7 @@ Null updates are not possible. @doc("An array of classifications to be updated.") @body - classifications: AtlasClassification[]; + body: AtlasClassification[]; }, void, {}, @@ -438,7 +438,7 @@ be changed to other unique attributes) @doc("Atlas entity with extended information.") @body - atlasEntityWithExtInfo: AtlasEntityWithExtInfo; + body: AtlasEntityWithExtInfo; }, EntityMutationResult, {}, @@ -529,7 +529,7 @@ be changed to other unique attributes) @doc("An array of classification to be added.") @body - classifications: AtlasClassification[]; + body: AtlasClassification[]; }, void, {}, @@ -556,7 +556,7 @@ be changed to other unique attributes) @doc("An array of classification to be updated.") @body - atlasClassificationArray: AtlasClassification[]; + body: AtlasClassification[]; }, void, {}, @@ -571,7 +571,7 @@ be changed to other unique attributes) { @doc("Atlas entity headers.") @body - entityHeaders: AtlasEntityHeaders; + body: AtlasEntityHeaders; }, OkResponse, {}, @@ -657,7 +657,7 @@ example. qualifiedName can be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata payload") @body - businessMetadata: Record>; + body: Record>; }, void, {}, @@ -678,14 +678,13 @@ example. qualifiedName can be changed to other unique attributes) Whether to overwrite the existing business metadata on the entity or not, default is false. """) - @query("isOverwrite") overwrite?: boolean; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("BusinessMetadata payload") @body - businessMetadata: Record>; + body: Record>; }, void, {}, @@ -710,7 +709,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata attribute payload") @body - businessMetadataAttributes: Record; + body: Record; }, void, {}, @@ -735,7 +734,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @doc("Business metadata attribute payload") @body - businessMetadataAttributes: Record; + body: Record; }, void, {}, @@ -750,7 +749,7 @@ default is false. {}, { @header contentType: "application/octet-stream"; - @body template: bytes; + @body body: bytes; }, {}, AtlasErrorResponse @@ -783,7 +782,7 @@ default is false. @doc("set of labels to be deleted") @body - labels: string[]; + body: string[]; }, void, {}, @@ -803,7 +802,7 @@ default is false. @doc("set of labels to be set to the entity") @body - labels: string[]; + body: string[]; }, void, {}, @@ -823,7 +822,7 @@ default is false. @doc("set of labels to be added") @body - labels: string[]; + body: string[]; }, void, {}, @@ -864,7 +863,7 @@ be changed to other unique attributes) @doc("set of labels to be deleted") @body - labels: string[]; + body: string[]; }, void, {}, @@ -907,7 +906,7 @@ be changed to other unique attributes) @doc("set of labels to be set") @body - labels: string[]; + body: string[]; }, void, {}, @@ -950,7 +949,7 @@ be changed to other unique attributes) @doc("set of labels to be added") @body - labels: string[]; + body: string[]; }, void, {}, @@ -969,7 +968,7 @@ be changed to other unique attributes) @doc("Entity guids to be moved to target collection.") @body - moveEntitiesRequest: MoveEntitiesOptions; + body: MoveEntitiesOptions; }, EntityMutationResult, {}, @@ -1027,7 +1026,7 @@ Using the anchor attribute when creating the Term/Category. """) @body - atlasGlossary: AtlasGlossary; + body: AtlasGlossary; }, AtlasGlossary, {}, @@ -1043,7 +1042,7 @@ the anchor attribute when creating the Term/Category. { @doc("An array of glossary category definitions to be created.") @body - glossaryCategory: AtlasGlossaryCategory[]; + body: AtlasGlossaryCategory[]; }, OkResponse, {}, @@ -1063,7 +1062,7 @@ Optionally, terms belonging to the category and the hierarchy can also be defined during creation. """) @body - glossaryCategory: AtlasGlossaryCategory; + body: AtlasGlossaryCategory; }, AtlasGlossaryCategory, {}, @@ -1097,7 +1096,7 @@ can also be defined during creation. @doc("The glossary category to be updated.") @body - glossaryCategory: AtlasGlossaryCategory; + body: AtlasGlossaryCategory; }, AtlasGlossaryCategory, {}, @@ -1138,7 +1137,7 @@ A map containing keys as attribute names and values as corresponding attribute values for partial update. """) @body - partialUpdates: Record; + body: Record; }, AtlasGlossaryCategory, {}, @@ -1218,7 +1217,7 @@ of creation. Optionally it can be categorized as well. """) @body - glossaryTerm: AtlasGlossaryTerm; + body: AtlasGlossaryTerm; }, AtlasGlossaryTerm, {}, @@ -1256,7 +1255,7 @@ Optionally it can be categorized as well. @doc("The glossary term to be updated.") @body - glossaryTerm: AtlasGlossaryTerm; + body: AtlasGlossaryTerm; }, AtlasGlossaryTerm, {}, @@ -1301,7 +1300,7 @@ A map containing keys as attribute names and values as corresponding attribute values to be updated. """) @body - partialUpdates: Record; + body: Record; }, AtlasGlossaryTerm, {}, @@ -1321,7 +1320,7 @@ values to be updated. @doc("An array of glossary term definitions to be created in bulk.") @body - glossaryTerm: AtlasGlossaryTerm[]; + body: AtlasGlossaryTerm[]; }, OkResponse, {}, @@ -1378,7 +1377,7 @@ is an alternative to assign a term to multiple entities. @doc("An array of related object IDs to which the term has to be associated.") @body - relatedObjectIds: AtlasRelatedObjectId[]; + body: AtlasRelatedObjectId[]; }, void, {}, @@ -1398,7 +1397,7 @@ is an alternative to assign a term to multiple entities. @doc("An array of related object IDs from which the term has to be dissociated.") @body - relatedObjectIds: AtlasRelatedObjectId[]; + body: AtlasRelatedObjectId[]; }, void, {}, @@ -1466,7 +1465,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("The glossary definition to be updated.") @body - updatedGlossary: AtlasGlossary; + body: AtlasGlossary; }, AtlasGlossary, {}, @@ -1604,7 +1603,7 @@ A map containing keys as attribute names and values as corresponding attribute values. """) @body - partialUpdates: Record; + body: Record; }, AtlasGlossary, {}, @@ -1681,7 +1680,7 @@ interface Discovery { { @doc("An object specifying the search criteria.") @body - queryOptions: QueryOptions; + body: QueryOptions; }, QueryResult, {}, @@ -1696,7 +1695,7 @@ interface Discovery { { @doc("An object specifying the suggest criteria.") @body - suggestOptions: SuggestOptions; + body: SuggestOptions; }, SuggestResult, {}, @@ -1711,7 +1710,7 @@ interface Discovery { { @doc("An object specifying the autocomplete criteria.") @body - autoCompleteOptions: AutoCompleteOptions; + body: AutoCompleteOptions; }, AutoCompleteResult, {}, @@ -1830,7 +1829,7 @@ The AtlasRelationship object containing the information for the relationship to be created. """) @body - relationship: AtlasRelationship; + body: AtlasRelationship; }, AtlasRelationship, {}, @@ -1848,7 +1847,7 @@ The AtlasRelationship object containing the information for the relationship to be created. """) @body - relationship: AtlasRelationship; + body: AtlasRelationship; }, AtlasRelationship, {}, @@ -2151,7 +2150,7 @@ Any changes to the existing definitions will be discarded. { @doc("A composite wrapper object with corresponding lists of the type definition.") @body - typesDef: AtlasTypesDef; + body: AtlasTypesDef; }, AtlasTypesDef, {}, @@ -2169,7 +2168,7 @@ persisted. { @doc("A composite object that captures all type definition changes.") @body - typesDef: AtlasTypesDef; + body: AtlasTypesDef; }, AtlasTypesDef, {}, @@ -2184,7 +2183,7 @@ persisted. { @doc("A composite object that captures all types to be deleted") @body - typesDef: AtlasTypesDef; + body: AtlasTypesDef; }, void, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 1e66eeacb8e6..b2f2665d5b36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteOptions": { + "body": { "keywords": "exa", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index ab3e46e7ffd1..28c2961eee1f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "kind": "AndFilter", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index a406c5da1a39..a1f45773a687 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index da0ff4a9dac9..7ec39b19f500 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index dd7f72f754c7..deb289d5ea22 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 7794508c857b..6d2ccf524020 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index df16a5e71226..2ab33726a034 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index c48e1d62ae9e..5150545e7d0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index b882bd1f8625..3779d9d497fe 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index dff9e4350cc4..b417487bea7d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "filter": { "objectType": "Tables" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 1492aec21fec..0b7fee10f958 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index d22c6cefe4e9..1af1169192d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "", "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index 50daf5d6ad55..1a983534fbce 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 95ab27e8cabd..4c6b90d682c4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index 25626373d72b..f332749b05ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index a66ca26aa4a0..cbe86e93e8fa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index b455624752ee..fe5522da8ebf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index ae9bfbbcff07..4e64dd33405e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index 838b5e819c2e..d2196fa7ea91 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index c9149a034c03..f2f278e5c48b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index ea57c1f9172b..0c24709432b3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": "", "limit": 3, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index e7527913f485..48480e13fc17 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "queryOptions": { + "body": { "keywords": null, "limit": 10, "filter": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index 87bce45ca85a..3ff80bee52ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestOptions": { + "body": { "keywords": "exampledata", "filter": { "and": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index 6a2b6f529636..b94ab95331ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "request": { + "body": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 3bdb3c19b4a9..5ab64b05faac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index a5eea86a2b97..0a724e78e134 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index b30d034aed83..5e50da3bc1c7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2023-09-01", - "entity": { + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json index c387ae7465a3..6c8c8ccf153d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabel.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 2f9db0a93175..3a2bc5a3f537 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "labels": [ + "body": [ "label3" ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 34b3e5816cf3..f91a2897c1e2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "businessMetadataName": "myBizMetaData1", - "businessMetadataAttributes": { + "body": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json index 312894c87299..4141a16cc255 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessMetadata.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadata": { + "body": { "myBizMetadata1": { "bizAttr1": "myBizMetaData1.bizAttr1" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index ad389111aaac..81eb02f76d2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entities": { + "body": { "referredEntities": {}, "entities": [ { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index ea7c077e8df3..ceac402f49a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entityHeaders": { + "body": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index baf955ab8e7d..cf8647830754 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2023-09-01", - "entity": { + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index 3ba4742d9a49..a9d546dacff1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "moveEntitiesRequest": { + "body": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index 50f18d78fe73..40609617bfa7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasEntityWithExtInfo": { + "body": { "entity": { "createTime": 1605766397985.0, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 53accfbf687d..717225e30454 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", "businessMetadataName": "myBizMetaData1", - "businessMetadataAttributes": { + "body": { "bizAttr1": "bizAttr1" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index d02050e64adf..9e2de7361e36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadata": { + "body": { "myBizMetadata1": { "bizAttr1": "myBizMetaData1.bizAttr1" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json index 1003d8d8e42b..743f676c786b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 0ed8eff354db..3ae4c0b565f8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "labels": [ + "body": [ "label1" ] }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json index ea45a92feb08..e2b2c2eb6344 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabels.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index 8d671ff5f91a..9ffba096b022 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "Asset", "attr:qualifiedName": "https://asset1", - "labels": [ + "body": [ "label1", "label2" ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 99e21e91b2a8..40e2350403a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "api-version": "2023-09-01", - "entity": { + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index bdf3ce57c20f..274b565b8f81 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index acc71465ee0d..f3b1777a8e75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 6ad1b726af7d..82aae3a1b087 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "body": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index 2af15856d99f..01289fd09ee1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "atlasGlossary": { + "body": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 5e56de8fc2a1..7dfb49f4e1ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": [ + "body": [ { "name": "ExampleCategory2", "anchor": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index cee2e98178e0..912e40a4e7ef 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": { + "body": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index d9ff8a381e4e..bd988ea6973b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index 635adc6d11ad..677877660bc8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index 1c74cfa028c0..18fcddae9a04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": [ + "body": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index b5dfeca34a18..c06db55d9e38 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "partialUpdates": { + "body": { "longDescription": "Example Long Description" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index dc999f7c3efc..356a70cf4da3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "partialUpdates": { + "body": { "longDescription": "Example Long Description" } }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index 1dd9519f670c..2238f2443727 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "body": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index 06919b479bae..faca8b5cb2a2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "updatedGlossary": { + "body": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index cb450401bbc5..7c145590a59b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "glossaryCategory": { + "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 8fea21da5eb8..9ed4cb3964b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "glossaryTerm": { + "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 883d47b5986c..89d3b4e5afec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 6287df03708b..0cd955fe3154 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index cdb16a858b47..d91723b6e888 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 9ae93573b207..433ff8867948 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index eda61c210ee7..60ba8acc3b75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index 3216472dba52..7905abbea1af 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 16561714eda9..a7bee6134c9d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -100,7 +100,7 @@ "type": "string" }, { - "name": "entity", + "name": "body", "in": "body", "description": "Atlas entity with extended information.", "required": true, @@ -238,7 +238,7 @@ } }, { - "name": "entities", + "name": "body", "in": "body", "description": "An array of entities to create or update.", "required": true, @@ -316,7 +316,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "request", + "name": "body", "in": "body", "description": "The request to associate a classification to multiple entities.", "required": true, @@ -352,7 +352,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "entityHeaders", + "name": "body", "in": "body", "description": "Atlas entity headers.", "required": true, @@ -676,7 +676,7 @@ "x-ms-client-name": "overwrite" }, { - "name": "businessMetadata", + "name": "body", "in": "body", "description": "BusinessMetadata payload", "required": true, @@ -721,7 +721,7 @@ "type": "string" }, { - "name": "businessMetadata", + "name": "body", "in": "body", "description": "Business metadata payload", "required": true, @@ -775,7 +775,7 @@ "type": "string" }, { - "name": "businessMetadataAttributes", + "name": "body", "in": "body", "description": "Business metadata attribute payload", "required": true, @@ -824,7 +824,7 @@ "type": "string" }, { - "name": "businessMetadataAttributes", + "name": "body", "in": "body", "description": "Business metadata attribute payload", "required": true, @@ -986,7 +986,7 @@ "type": "string" }, { - "name": "classifications", + "name": "body", "in": "body", "description": "An array of classifications to be updated.", "required": true, @@ -1031,7 +1031,7 @@ "type": "string" }, { - "name": "classifications", + "name": "body", "in": "body", "description": "An array of classifications to be added.", "required": true, @@ -1115,7 +1115,7 @@ "type": "string" }, { - "name": "labels", + "name": "body", "in": "body", "description": "set of labels to be added", "required": true, @@ -1159,7 +1159,7 @@ "type": "string" }, { - "name": "labels", + "name": "body", "in": "body", "description": "set of labels to be set to the entity", "required": true, @@ -1203,7 +1203,7 @@ "type": "string" }, { - "name": "labels", + "name": "body", "in": "body", "description": "set of labels to be deleted", "required": true, @@ -1314,7 +1314,7 @@ "x-ms-client-name": "attribute" }, { - "name": "atlasEntityWithExtInfo", + "name": "body", "in": "body", "description": "Atlas entity with extended information.", "required": true, @@ -1460,7 +1460,7 @@ "x-ms-client-name": "attribute" }, { - "name": "atlasClassificationArray", + "name": "body", "in": "body", "description": "An array of classification to be updated.", "required": true, @@ -1513,7 +1513,7 @@ "x-ms-client-name": "attribute" }, { - "name": "classifications", + "name": "body", "in": "body", "description": "An array of classification to be added.", "required": true, @@ -1568,7 +1568,7 @@ "x-ms-client-name": "attribute" }, { - "name": "labels", + "name": "body", "in": "body", "description": "set of labels to be added", "required": true, @@ -1620,7 +1620,7 @@ "x-ms-client-name": "attribute" }, { - "name": "labels", + "name": "body", "in": "body", "description": "set of labels to be set", "required": true, @@ -1672,7 +1672,7 @@ "x-ms-client-name": "attribute" }, { - "name": "labels", + "name": "body", "in": "body", "description": "set of labels to be deleted", "required": true, @@ -1773,7 +1773,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "atlasGlossary", + "name": "body", "in": "body", "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", "required": true, @@ -1861,7 +1861,7 @@ "type": "boolean" }, { - "name": "updatedGlossary", + "name": "body", "in": "body", "description": "The glossary definition to be updated.", "required": true, @@ -2111,7 +2111,7 @@ "type": "boolean" }, { - "name": "partialUpdates", + "name": "body", "in": "body", "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", "required": true, @@ -2281,7 +2281,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryCategory", + "name": "body", "in": "body", "description": "An array of glossary category definitions to be created.", "required": true, @@ -2328,7 +2328,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "glossaryCategory", + "name": "body", "in": "body", "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", "required": true, @@ -2409,7 +2409,7 @@ "type": "string" }, { - "name": "glossaryCategory", + "name": "body", "in": "body", "description": "The glossary category to be updated.", "required": true, @@ -2487,7 +2487,7 @@ "type": "string" }, { - "name": "partialUpdates", + "name": "body", "in": "body", "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", "required": true, @@ -2667,7 +2667,7 @@ "type": "boolean" }, { - "name": "glossaryTerm", + "name": "body", "in": "body", "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", "required": true, @@ -2761,7 +2761,7 @@ "type": "boolean" }, { - "name": "glossaryTerm", + "name": "body", "in": "body", "description": "The glossary term to be updated.", "required": true, @@ -2846,7 +2846,7 @@ "type": "boolean" }, { - "name": "partialUpdates", + "name": "body", "in": "body", "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", "required": true, @@ -2895,7 +2895,7 @@ "type": "boolean" }, { - "name": "glossaryTerm", + "name": "body", "in": "body", "description": "An array of glossary term definitions to be created in bulk.", "required": true, @@ -3011,7 +3011,7 @@ "type": "string" }, { - "name": "relatedObjectIds", + "name": "body", "in": "body", "description": "An array of related object IDs to which the term has to be associated.", "required": true, @@ -3056,7 +3056,7 @@ "type": "string" }, { - "name": "relatedObjectIds", + "name": "body", "in": "body", "description": "An array of related object IDs from which the term has to be dissociated.", "required": true, @@ -3327,7 +3327,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "relationship", + "name": "body", "in": "body", "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", "required": true, @@ -3364,7 +3364,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "relationship", + "name": "body", "in": "body", "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", "required": true, @@ -4121,7 +4121,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "typesDef", + "name": "body", "in": "body", "description": "A composite object that captures all type definition changes.", "required": true, @@ -4158,7 +4158,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "typesDef", + "name": "body", "in": "body", "description": "A composite wrapper object with corresponding lists of the type definition.", "required": true, @@ -4198,7 +4198,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "typesDef", + "name": "body", "in": "body", "description": "A composite object that captures all types to be deleted", "required": true, @@ -4333,7 +4333,7 @@ "type": "string" }, { - "name": "moveEntitiesRequest", + "name": "body", "in": "body", "description": "Entity guids to be moved to target collection.", "required": true, @@ -4458,7 +4458,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "autoCompleteOptions", + "name": "body", "in": "body", "description": "An object specifying the autocomplete criteria.", "required": true, @@ -4497,7 +4497,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "queryOptions", + "name": "body", "in": "body", "description": "An object specifying the search criteria.", "required": true, @@ -4596,7 +4596,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "suggestOptions", + "name": "body", "in": "body", "description": "An object specifying the suggest criteria.", "required": true, From 18ad5ed8935913c9f6bd742458bbf31a28edce00 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:08:45 +0800 Subject: [PATCH 082/132] Update Glossary_PartialUpdateCategory.json --- .../examples/2023-09-01/Glossary_PartialUpdateCategory.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json index fcd86785e556..15be08095e73 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Glossary_PartialUpdateCategory.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", - "partialUpdates": { + "body": { "longDescription": "Example Long Description" } }, From 867767b5dc69f259596e6379aa33617dc6b56d7f Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:15:17 +0800 Subject: [PATCH 083/132] revert update examples in original example folder --- .../2023-09-01/examples/Discovery_AutoComplete.json | 6 ++---- .../stable/2023-09-01/examples/Discovery_Query.json | 7 ++----- .../2023-09-01/examples/Discovery_Query_And.json | 6 ++---- .../examples/Discovery_Query_AndOrNested.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_AssetType.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Attribute.json | 6 ++---- .../Discovery_Query_BusinessMetadataAttribute.json | 6 ++---- .../examples/Discovery_Query_Classification.json | 6 ++---- .../examples/Discovery_Query_Collection.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Facet.json | 6 ++---- .../examples/Discovery_Query_FileExtension.json | 6 ++---- .../examples/Discovery_Query_GlossaryTerm.json | 6 ++---- .../stable/2023-09-01/examples/Discovery_Query_Id.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Not.json | 6 ++---- .../examples/Discovery_Query_ObjectType.json | 6 ++---- .../Discovery_Query_PaginationContinuationPage.json | 6 ++---- .../examples/Discovery_Query_PaginationFirstPage.json | 6 ++---- .../examples/Discovery_Query_PaginationLastPage.json | 6 ++---- .../examples/Discovery_Query_SystemTime.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Taxonomy.json | 6 ++---- .../examples/Discovery_Query_TermAssignment.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Type.json | 6 ++---- .../stable/2023-09-01/examples/Discovery_Suggest.json | 6 ++---- .../Entity_AddClassificationToEntityByGuids.json | 6 ++---- .../2023-09-01/examples/Entity_AddClassifications.json | 6 ++---- .../Entity_AddClassificationsByUniqueAttribute.json | 6 ++---- .../2023-09-01/examples/Entity_AddCustomAttribute.json | 7 ++----- .../examples/Entity_AddLabelsByUniqueAttribute.json | 4 +--- .../examples/Entity_AddOrUpdate_BusinessAttribute.json | 6 ++---- .../2023-09-01/examples/Entity_BulkCreateOrUpdate.json | 6 ++---- .../stable/2023-09-01/examples/Entity_BulkDelete.json | 4 +--- .../examples/Entity_BulkSetClassifications.json | 6 ++---- .../stable/2023-09-01/examples/Entity_Create.json | 7 ++----- .../stable/2023-09-01/examples/Entity_Delete.json | 4 +--- .../examples/Entity_DeleteByUniqueAttribute.json | 4 +--- .../stable/2023-09-01/examples/Entity_Get.json | 4 +--- .../examples/Entity_GetByUniqueAttributes.json | 4 +--- .../2023-09-01/examples/Entity_GetClassification.json | 4 +--- .../2023-09-01/examples/Entity_GetClassifications.json | 4 +--- .../stable/2023-09-01/examples/Entity_GetHeader.json | 4 +--- .../Entity_GetSampleBusinessMetadataTemplate.json | 7 ++----- .../examples/Entity_ImportBusinessMetadata.json | 6 ++---- .../stable/2023-09-01/examples/Entity_ListByGuids.json | 4 +--- .../examples/Entity_ListByUniqueAttributes.json | 4 +--- .../examples/Entity_MoveEntitiesToCollection.json | 6 ++---- .../examples/Entity_PartialUpdateAttributeByGuid.json | 4 +--- .../Entity_PartialUpdateByUniqueAttributes.json | 10 ++++------ .../examples/Entity_RemoveBusinessAttribute.json | 6 ++---- .../examples/Entity_RemoveBusinessMetadata.json | 4 +--- .../examples/Entity_RemoveClassification.json | 4 +--- .../Entity_RemoveClassificationByUniqueAttribute.json | 4 +--- .../examples/Entity_RemoveLabelsByUniqueAttribute.json | 4 +--- .../examples/Entity_SetLabelsByUniqueAttribute.json | 4 +--- .../stable/2023-09-01/examples/Entity_Update.json | 7 ++----- .../examples/Entity_UpdateClassifications.json | 6 ++---- .../Entity_UpdateClassificationsByUniqueAttribute.json | 6 ++---- .../examples/Glossary_AssignTermToEntities.json | 8 +++----- .../stable/2023-09-01/examples/Glossary_Create.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateCategories.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateCategory.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateTerm.json | 6 ++---- .../examples/Glossary_CreateTermWithTemplate.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateTerms.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_Delete.json | 6 ++---- .../2023-09-01/examples/Glossary_DeleteCategory.json | 6 ++---- .../2023-09-01/examples/Glossary_DeleteTerm.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_Get.json | 6 ++---- .../2023-09-01/examples/Glossary_GetCategory.json | 6 ++---- .../2023-09-01/examples/Glossary_GetDetailed.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_GetTerm.json | 6 ++---- .../examples/Glossary_GetTermWithoutAssets.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_List.json | 4 +--- .../2023-09-01/examples/Glossary_ListCategories.json | 6 ++---- .../examples/Glossary_ListCategoriesHeaders.json | 6 ++---- .../examples/Glossary_ListCategoryTerms.json | 6 ++---- .../Glossary_ListEntitiesAssignedWithTerm.json | 6 ++---- .../examples/Glossary_ListRelatedCategories.json | 6 ++---- .../2023-09-01/examples/Glossary_ListRelatedTerms.json | 6 ++---- .../2023-09-01/examples/Glossary_ListTermHeaders.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_ListTerms.json | 6 ++---- .../2023-09-01/examples/Glossary_PartialUpdate.json | 8 +++----- .../examples/Glossary_PartialUpdateCategory.json | 6 ++---- .../examples/Glossary_PartialUpdateTerm.json | 10 ++++------ .../Glossary_RemoveTermAssignmentFromEntities.json | 8 +++----- .../stable/2023-09-01/examples/Glossary_Update.json | 8 +++----- .../2023-09-01/examples/Glossary_UpdateCategory.json | 8 +++----- .../2023-09-01/examples/Glossary_UpdateTerm.json | 8 +++----- .../stable/2023-09-01/examples/Lineage_Get.json | 4 +--- .../examples/Lineage_GetByUniqueAttribute.json | 4 +--- .../2023-09-01/examples/Lineage_GetNextPage.json | 4 +--- .../2023-09-01/examples/Relationship_Create.json | 6 ++---- .../2023-09-01/examples/Relationship_Delete.json | 4 +--- .../stable/2023-09-01/examples/Relationship_Get.json | 4 +--- .../2023-09-01/examples/Relationship_Update.json | 6 ++---- .../stable/2023-09-01/examples/Type_BulkCreate.json | 6 ++---- .../examples/Type_BulkCreateBusinessMetadataDefs.json | 6 ++---- .../stable/2023-09-01/examples/Type_BulkDelete.json | 6 ++---- .../stable/2023-09-01/examples/Type_BulkUpdate.json | 6 ++---- .../stable/2023-09-01/examples/Type_Delete.json | 4 +--- .../examples/Type_GetBusinessMetadataDefByGuid.json | 4 +--- .../examples/Type_GetBusinessMetadataDefByName.json | 4 +--- .../stable/2023-09-01/examples/Type_GetByGuid.json | 4 +--- .../stable/2023-09-01/examples/Type_GetByName.json | 4 +--- .../examples/Type_GetClassificationDefByGuid.json | 4 +--- .../examples/Type_GetClassificationDefByName.json | 4 +--- .../2023-09-01/examples/Type_GetEntityDefByGuid.json | 4 +--- .../2023-09-01/examples/Type_GetEntityDefByName.json | 4 +--- .../2023-09-01/examples/Type_GetEnumDefByGuid.json | 4 +--- .../2023-09-01/examples/Type_GetEnumDefByName.json | 4 +--- .../examples/Type_GetRelationshipDefByGuid.json | 4 +--- .../examples/Type_GetRelationshipDefByName.json | 4 +--- .../2023-09-01/examples/Type_GetStructDefByGuid.json | 4 +--- .../2023-09-01/examples/Type_GetStructDefByName.json | 4 +--- .../examples/Type_GetTermTemplateDefByGuid.json | 4 +--- .../examples/Type_GetTermTemplateDefByName.json | 4 +--- .../stable/2023-09-01/examples/Type_List.json | 4 +--- .../stable/2023-09-01/examples/Type_ListEnumDefs.json | 4 +--- .../stable/2023-09-01/examples/Type_ListHeaders.json | 4 +--- .../2023-09-01/examples/Type_ListTermTemplateDefs.json | 4 +--- 119 files changed, 204 insertions(+), 447 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index b2f2665d5b36..6f9992091ded 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "autoCompleteRequest": { "keywords": "exa", "filter": { "and": [ @@ -34,7 +34,5 @@ ] } } - }, - "title": "Discovery_AutoComplete", - "operationId": "Discovery_AutoComplete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 28c2961eee1f..01a3c24a0366 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,10 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { "objectType": "Files" @@ -104,7 +103,5 @@ ] } } - }, - "title": "Discovery_Query", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index a1f45773a687..510076af8094 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -74,7 +74,5 @@ ] } } - }, - "title": "Discovery_Query_And", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index 7ec39b19f500..a18f77f11ea4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -91,7 +91,5 @@ ] } } - }, - "title": "Discovery_Query_AndOrNested", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index deb289d5ea22..6f134d2cbc92 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -134,7 +134,5 @@ ] } } - }, - "title": "Discovery_Query_AssetType", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 6d2ccf524020..33e68dd2cc70 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -91,7 +91,5 @@ ] } } - }, - "title": "Discovery_Query_Attribute", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 2ab33726a034..49a647d73822 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -48,7 +48,5 @@ ] } } - }, - "title": "Discovery_Query_BusinessMetadataAttribute", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 5150545e7d0f..1652e3eb3967 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -63,7 +63,5 @@ ] } } - }, - "title": "Discovery_Query_Classification", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 3779d9d497fe..8d51d3b6a9c9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -62,7 +62,5 @@ ] } } - }, - "title": "Discovery_Query_Collection", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index b417487bea7d..d68b074a230f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "filter": { "objectType": "Tables" @@ -144,7 +144,5 @@ ] } } - }, - "title": "Discovery_Query_Facet", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 0b7fee10f958..9c2aed22a521 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -56,7 +56,5 @@ ] } } - }, - "title": "Discovery_Query_FileExtension", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 1af1169192d0..15d04904849c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "", "limit": 10, "filter": { @@ -90,7 +90,5 @@ } } } - }, - "title": "Discovery_Query_GlossaryTerm", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index 1a983534fbce..a239b38b5c50 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -39,7 +39,5 @@ ] } } - }, - "title": "Discovery_Query_Id", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 4c6b90d682c4..004b8283ffc2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -54,7 +54,5 @@ ] } } - }, - "title": "Discovery_Query_Not", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index f332749b05ee..1e48cd2210b5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -69,7 +69,5 @@ ] } } - }, - "title": "Discovery_Query_ObjectType", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index cbe86e93e8fa..99220e6552d4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -105,7 +105,5 @@ ] } } - }, - "title": "Discovery_Query_PaginationContinuationPage", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index fe5522da8ebf..9de3ad93b2b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -104,7 +104,5 @@ ] } } - }, - "title": "Discovery_Query_PaginationFirstPage", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 4e64dd33405e..7320000e5082 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -104,7 +104,5 @@ ] } } - }, - "title": "Discovery_Query_PaginationLastPage", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index d2196fa7ea91..bde144d66d3f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -49,7 +49,5 @@ ] } } - }, - "title": "Discovery_Query_SystemTime", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index f2f278e5c48b..6b05a5985854 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -88,7 +88,5 @@ ] } } - }, - "title": "Discovery_Query_Taxonomy", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 0c24709432b3..576c69a243c5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "", "limit": 3, "filter": { @@ -53,7 +53,5 @@ ] } } - }, - "title": "Discovery_Query_TermAssignment", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index 48480e13fc17..f78c96dd68ac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -60,7 +60,5 @@ ] } } - }, - "title": "Discovery_Query_Type", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index 3ff80bee52ec..f0886ed0c690 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "suggestRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -54,7 +54,5 @@ ] } } - }, - "title": "Discovery_Suggest", - "operationId": "Discovery_Suggest" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index b94ab95331ec..c955f4586918 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "request": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, @@ -15,7 +15,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddClassificationToEntityByGuids", - "operationId": "Entity_AddClassification" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 5ab64b05faac..6aa11763de71 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "body": [ + "classifications": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" @@ -15,7 +15,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddClassifications", - "operationId": "Entity_AddClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index 0a724e78e134..e82bbe57a2f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "body": [ + "atlasClassificationArray": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,7 +14,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddClassificationsByUniqueAttribute", - "operationId": "Entity_AddClassificationsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 5e50da3bc1c7..5fafde7ea05e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -1,8 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2023-09-01", - "body": { + "entity": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -52,7 +51,5 @@ } } } - }, - "title": "Entity_AddCustomAttribute", - "operationId": "Entity_CreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 3a2bc5a3f537..8d60d206619e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -9,7 +9,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddLabelsByUniqueAttribute", - "operationId": "Entity_AddLabelsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index f91a2897c1e2..6335668124ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,14 +2,12 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadataName": "myBizMetaData1", + "bmName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - }, - "title": "Entity_AddOrUpdate_BusinessAttribute", - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index 81eb02f76d2e..779992eff9ba 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "entities": { "referredEntities": {}, "entities": [ { @@ -100,7 +100,5 @@ } } } - }, - "title": "Entity_BulkCreateOrUpdate", - "operationId": "Entity_BulkCreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json index 3b8c27b9b5fc..067d745f66c1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json @@ -31,7 +31,5 @@ } } } - }, - "title": "Entity_BulkDelete", - "operationId": "Entity_BulkDelete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index ceac402f49a7..907bbe9c1e97 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "entityHeaders": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { @@ -35,7 +35,5 @@ "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" ] } - }, - "title": "Entity_BulkSetClassifications", - "operationId": "Entity_BulkSetClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index cf8647830754..b4946962b191 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -1,8 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2023-09-01", - "body": { + "entity": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -57,7 +56,5 @@ } } } - }, - "title": "Entity_Create", - "operationId": "Entity_CreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json index 9e6ab2104d44..029021e09916 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json @@ -23,7 +23,5 @@ } } } - }, - "title": "Entity_Delete", - "operationId": "Entity_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json index 3df1ba7cee96..34948b6504ab 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json @@ -29,7 +29,5 @@ } } } - }, - "title": "Entity_DeleteByUniqueAttribute", - "operationId": "Entity_DeleteByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 2acf46b04d68..918d06e41adc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -57,7 +57,5 @@ } } } - }, - "title": "Entity_Get", - "operationId": "Entity_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 113dab2d668f..1985ed6cb10e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -31,7 +31,5 @@ "referredEntities": {} } } - }, - "title": "Entity_GetByUniqueAttributes", - "operationId": "Entity_GetByUniqueAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json index 968a4d7e0fcc..1d976b1e21e0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json @@ -13,7 +13,5 @@ "entityStatus": "ACTIVE" } } - }, - "title": "Entity_GetClassification", - "operationId": "Entity_GetClassification" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json index ae0d81292c04..8f89220119d7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json @@ -18,7 +18,5 @@ "sortType": "NONE" } } - }, - "title": "Entity_GetClassifications", - "operationId": "Entity_GetClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json index 029a55bbbb96..c9ae29bce60d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json @@ -24,7 +24,5 @@ "typeName": "azure_storage_account" } } - }, - "title": "Entity_GetHeader", - "operationId": "Entity_GetHeader" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index 34f5b284ae4b..b25d5b0cc239 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,13 +1,10 @@ { "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2023-09-01" + "Endpoint": "{Endpoint}" }, "responses": { "200": { "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" } - }, - "title": "Entity_GetSampleBusinessMetadataTemplate", - "operationId": "Entity_GetSampleBusinessMetadataTemplate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 7b3743545b30..37325e736386 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "file": "examplefile.csv" }, "responses": { "200": { @@ -16,7 +16,5 @@ ] } } - }, - "title": "Entity_ImportBusinessMetadata", - "operationId": "Entity_ImportBusinessMetadata" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index ed6951961940..8d8754364eed 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -110,7 +110,5 @@ ] } } - }, - "title": "Entity_ListByGuids", - "operationId": "Entity_ListByGuids" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index c4ce33dd6345..16c42a58932e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -46,7 +46,5 @@ ] } } - }, - "title": "Entity_ListByUniqueAttributes", - "operationId": "Entity_ListByUniqueAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index a9d546dacff1..42e6555a9f4e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "body": { + "moveEntitiesRequest": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" @@ -41,7 +41,5 @@ } } } - }, - "title": "Entity_MoveEntitiesToCollection", - "operationId": "Entity_MoveEntitiesToCollection" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json index 4320bdb7e9a7..343a0b2ecb25 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json @@ -33,7 +33,5 @@ ] } } - }, - "title": "Entity_PartialUpdateAttributeByGuid", - "operationId": "Entity_PartialUpdateAttributeByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index 40609617bfa7..a38dc403ff1d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -3,9 +3,9 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "body": { + "atlasEntityWithExtInfo": { "entity": { - "createTime": 1605766397985.0, + "createTime": 1.605766397985E12, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "relationshipAttributes": { @@ -13,7 +13,7 @@ "meanings": [] }, "status": "ACTIVE", - "updateTime": 1605766397985.0, + "updateTime": 1.605766397985E12, "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "lastModifiedTS": "1", "version": 0.0, @@ -56,7 +56,5 @@ ] } } - }, - "title": "Entity_PartialUpdateByUniqueAttributes", - "operationId": "Entity_PartialUpdateByUniqueAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 717225e30454..6335668124ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -2,14 +2,12 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadataName": "myBizMetaData1", + "bmName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - }, - "title": "Entity_RemoveBusinessAttribute", - "operationId": "Entity_RemoveBusinessMetadataAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9e2de7361e36..9292ad587d04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -10,7 +10,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveBusinessMetadata", - "operationId": "Entity_RemoveBusinessMetadata" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json index 408744950b01..0967940bc811 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json @@ -6,7 +6,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveClassification", - "operationId": "Entity_RemoveClassification" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json index 75717c4f59ad..4d2cc9927070 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json @@ -7,7 +7,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveClassificationByUniqueAttribute", - "operationId": "Entity_RemoveClassificationByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 3ae4c0b565f8..8479ed0cfe43 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -9,7 +9,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveLabelsByUniqueAttribute", - "operationId": "Entity_RemoveLabelsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index 9ffba096b022..b2132f45f70b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -10,7 +10,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_SetLabelsByUniqueAttribute", - "operationId": "Entity_SetLabelsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 40e2350403a5..56799529f337 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -1,8 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2023-09-01", - "body": { + "entity": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -56,7 +55,5 @@ } } } - }, - "title": "Entity_Update", - "operationId": "Entity_CreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index 274b565b8f81..d558a272e7ea 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "body": [ + "classifications": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" @@ -15,7 +15,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_UpdateClassifications", - "operationId": "Entity_UpdateClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index f3b1777a8e75..e82bbe57a2f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "body": [ + "atlasClassificationArray": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,7 +14,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_UpdateClassificationsByUniqueAttribute", - "operationId": "Entity_UpdateClassificationsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 82aae3a1b087..5ff085189499 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "body": [ + "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "relatedObjectIds": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { @@ -18,7 +18,5 @@ }, "responses": { "204": {} - }, - "title": "Glossary_AssignTermToEntities", - "operationId": "Glossary_AssignTermToEntities" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index 01289fd09ee1..a1ec9e6bee07 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "atlasGlossary": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -26,7 +26,5 @@ "updateTime": 1672892675688 } } - }, - "title": "Glossary_Create", - "operationId": "Glossary_Create" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 7dfb49f4e1ae..17a515af1f09 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": [ + "glossaryCategory": [ { "name": "ExampleCategory2", "anchor": { @@ -41,7 +41,5 @@ } ] } - }, - "title": "Glossary_CreateCategories", - "operationId": "Glossary_CreateCategories" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index 912e40a4e7ef..7f31caaea342 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "glossaryCategory": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, @@ -33,7 +33,5 @@ ] } } - }, - "title": "Glossary_CreateCategory", - "operationId": "Glossary_CreateCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index bd988ea6973b..efd7d2d547b2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "glossaryTerm": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -72,7 +72,5 @@ } } } - }, - "title": "Glossary_CreateTerm", - "operationId": "Glossary_CreateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index 677877660bc8..c9b7795a1b04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "glossaryTerm": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -47,7 +47,5 @@ } } } - }, - "title": "Glossary_CreateTermWithTemplate", - "operationId": "Glossary_CreateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index 18fcddae9a04..ddd48b3a0782 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": [ + "glossaryTerm": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -87,7 +87,5 @@ } ] } - }, - "title": "Glossary_CreateTerms", - "operationId": "Glossary_CreateTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 88b82510fb9f..70b4059decdd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -1,11 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} - }, - "title": "Glossary_Delete", - "operationId": "Glossary_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index c281cd4c2450..678b949d55e5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -1,11 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} - }, - "title": "Glossary_DeleteCategory", - "operationId": "Glossary_DeleteCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index 7fa8e97b845a..32fd415f64d5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -1,11 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} - }, - "title": "Glossary_DeleteTerm", - "operationId": "Glossary_DeleteTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 6e1aaeaa5786..1eb2a13b1f0b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { @@ -37,7 +37,5 @@ ] } } - }, - "title": "Glossary_Get", - "operationId": "Glossary_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 1de42a99f57e..2329430d0e4d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { @@ -35,7 +35,5 @@ ] } } - }, - "title": "Glossary_GetCategory", - "operationId": "Glossary_GetCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index 0345a931a976..f5aea38d5f1d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { @@ -225,7 +225,5 @@ } } } - }, - "title": "Glossary_GetDetailed", - "operationId": "Glossary_GetDetailed" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index 3b574ac3e20f..d1bf7157bbed 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { @@ -80,7 +80,5 @@ ] } } - }, - "title": "Glossary_GetTerm", - "operationId": "Glossary_GetTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index 3bedbf11a9a4..c0dcc7655580 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] @@ -60,7 +60,5 @@ ] } } - }, - "title": "Glossary_GetTermWithoutAssets", - "operationId": "Glossary_GetTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json index c454ce6b68f7..f8bc74ada7f4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json @@ -55,7 +55,5 @@ } ] } - }, - "title": "Glossary_List", - "operationId": "Glossary_List" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index 30e8cf73dbfd..aabcc66dc2d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -68,7 +68,5 @@ } ] } - }, - "title": "Glossary_ListCategories", - "operationId": "Glossary_ListCategories" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index a04eb3cba127..277c967f7f0b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -28,7 +28,5 @@ } ] } - }, - "title": "Glossary_ListCategoriesHeaders", - "operationId": "Glossary_ListCategoriesHeaders" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index e1a99139221b..7fe35d8dd8f2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -16,7 +16,5 @@ } ] } - }, - "title": "Glossary_ListCategoryTerms", - "operationId": "Glossary_ListCategoryTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index 99c872e87c99..ebfed3c2de40 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" @@ -53,7 +53,5 @@ } ] } - }, - "title": "Glossary_ListEntitiesAssignedWithTerm", - "operationId": "Glossary_ListEntitiesAssignedWithTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index 2e845fcb0944..7523745867a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,7 +25,5 @@ ] } } - }, - "title": "Glossary_ListRelatedCategories", - "operationId": "Glossary_ListRelatedCategories" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index 56999a9dd79a..ca90bb6d08d7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,7 +25,5 @@ ] } } - }, - "title": "Glossary_ListRelatedTerms", - "operationId": "Glossary_ListRelatedTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 6bcfbe8c9fc9..1375aa567f2b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -21,7 +21,5 @@ } ] } - }, - "title": "Glossary_ListTermHeaders", - "operationId": "Glossary_ListTermHeaders" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index 583aa635b462..214bbd4c4f76 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -99,7 +99,5 @@ } ] } - }, - "title": "Glossary_ListTerms", - "operationId": "Glossary_ListTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index c06db55d9e38..4df90166a6b6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "body": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "partialUpdates": { "longDescription": "Example Long Description" } }, @@ -54,7 +54,5 @@ ] } } - }, - "title": "Glossary_PartialUpdate", - "operationId": "Glossary_PartialUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index fcd86785e556..11516593b6bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", + "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", "partialUpdates": { "longDescription": "Example Long Description" } @@ -39,7 +39,5 @@ ] } } - }, - "title": "Glossary_PartialUpdateCategory", - "operationId": "Glossary_PartialUpdateCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index 356a70cf4da3..572d692fa4b6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "body": { - "longDescription": "Example Long Description" + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "partialUpdates": { + "longDescription": "Example Long Descrition" } }, "responses": { @@ -54,7 +54,5 @@ ] } } - }, - "title": "Glossary_PartialUpdateTerm", - "operationId": "Glossary_PartialUpdateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index 2238f2443727..ca978c5df1fc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "body": [ + "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "relatedObjectIds": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" @@ -11,7 +11,5 @@ }, "responses": { "204": {} - }, - "title": "Glossary_RemoveTermAssignmentFromEntities", - "operationId": "Glossary_DeleteTermAssignmentFromEntities" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index faca8b5cb2a2..ac2868693994 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "body": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "updatedGlossary": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", @@ -92,7 +92,5 @@ ] } } - }, - "title": "Glossary_Update", - "operationId": "Glossary_Update" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index 7c145590a59b..fb8c92c94fd5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "body": { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "glossaryCategory": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", @@ -59,7 +59,5 @@ ] } } - }, - "title": "Glossary_UpdateCategory", - "operationId": "Glossary_UpdateCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 9ed4cb3964b7..065bba39f639 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "body": { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "glossaryTerm": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", @@ -88,7 +88,5 @@ ] } } - }, - "title": "Glossary_UpdateTerm", - "operationId": "Glossary_UpdateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json index a08de217b1c0..122a1804289c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json @@ -20,7 +20,5 @@ "parentRelations": [] } } - }, - "title": "Lineage_Get", - "operationId": "Lineage_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json index ab738e50995b..4b9886deec69 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json @@ -59,7 +59,5 @@ } } } - }, - "title": "Lineage_GetByUniqueAttribute", - "operationId": "Lineage_GetByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json index 778a391f5b59..66f7aac1fb7a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json @@ -21,7 +21,5 @@ "parentRelations": [] } } - }, - "title": "Lineage_GetNextPage", - "operationId": "Lineage_GetNextPage" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 89d3b4e5afec..8122eee5cd3a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "relationship": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -54,7 +54,5 @@ "version": 0 } } - }, - "title": "Relationship_Create", - "operationId": "Relationship_Create" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json index c6e4848b9952..291912c8ccac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json @@ -5,7 +5,5 @@ }, "responses": { "204": {} - }, - "title": "Relationship_Delete", - "operationId": "Relationship_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json index 182684f354bd..7a9054f95285 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json @@ -35,7 +35,5 @@ } } } - }, - "title": "Relationship_Get", - "operationId": "Relationship_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 0cd955fe3154..3664c81a3ec7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "relationship": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -55,7 +55,5 @@ "version": 0 } } - }, - "title": "Relationship_Update", - "operationId": "Relationship_Update" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index d91723b6e888..3c08502d3e0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -67,7 +67,5 @@ "relationshipDefs": [] } } - }, - "title": "Type_BulkCreate", - "operationId": "Type_BulkCreate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 433ff8867948..66e7d50e8570 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -71,7 +71,5 @@ ] } } - }, - "title": "Type_BulkCreateBusinessMetadataDefs", - "operationId": "Type_BulkCreate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index 60ba8acc3b75..40e463be1ce9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -29,7 +29,5 @@ }, "responses": { "204": {} - }, - "title": "Type_BulkDelete", - "operationId": "Type_BulkDelete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index 7905abbea1af..fd37acb1ec1c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -284,7 +284,5 @@ ] } } - }, - "title": "Type_BulkUpdate", - "operationId": "Type_BulkUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json index 8a364027401e..d95c0728b9cb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json @@ -5,7 +5,5 @@ }, "responses": { "204": {} - }, - "title": "Type_Delete", - "operationId": "Type_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json index 34921a8239b7..5790a0df446e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetBusinessMetadataDefByGuid", - "operationId": "Type_GetBusinessMetadataDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json index 64d92fefd723..89abf18c256d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetBusinessMetadataDefByName", - "operationId": "Type_GetBusinessMetadataDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json index e94b5ad8b518..ebd1ed4902de 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetByGuid", - "operationId": "Type_GetByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json index 804029d070e1..77ec05812c26 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetByName", - "operationId": "Type_GetByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json index bf27840af6aa..31f09a6d61e6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json @@ -22,7 +22,5 @@ "subTypes": [] } } - }, - "title": "Type_GetClassificationDefByGuid", - "operationId": "Type_GetClassificationDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json index e7a58bf32bfb..b7d7ed8a4f74 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json @@ -22,7 +22,5 @@ "subTypes": [] } } - }, - "title": "Type_GetClassificationDefByName", - "operationId": "Type_GetClassificationDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json index 9c0d6ce53cb7..2728fb2507c3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json @@ -52,7 +52,5 @@ ] } } - }, - "title": "Type_GetEntityDefByGuid", - "operationId": "Type_GetEntityDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json index 140ba1a5b309..0542db979369 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json @@ -52,7 +52,5 @@ ] } } - }, - "title": "Type_GetEntityDefByName", - "operationId": "Type_GetEntityDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json index ab9e4048b0d2..9c324ce8d35b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json @@ -32,7 +32,5 @@ ] } } - }, - "title": "Type_GetEnumDefByGuid", - "operationId": "Type_GetEnumDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json index 62907f8f6a69..6adfee266b61 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json @@ -32,7 +32,5 @@ ] } } - }, - "title": "Type_GetEnumDefByName", - "operationId": "Type_GetEnumDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json index 71c9a03a65d9..66b6efd3f8bf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json @@ -35,7 +35,5 @@ "relationshipLabel": "r:storm_topology_nodes" } } - }, - "title": "Type_GetRelationshipDefByGuid", - "operationId": "Type_GetRelationshipDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json index ecdafc07a934..148c7d655371 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json @@ -35,7 +35,5 @@ "relationshipLabel": "r:storm_topology_nodes" } } - }, - "title": "Type_GetRelationshipDefByName", - "operationId": "Type_GetRelationshipDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json index c31ae06aeeb6..d2e1e0901f30 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json @@ -42,7 +42,5 @@ ] } } - }, - "title": "Type_GetStructDefByGuid", - "operationId": "Type_GetStructDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json index 26f8e843a6d6..6bffd4888fa2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json @@ -42,7 +42,5 @@ ] } } - }, - "title": "Type_GetStructDefByName", - "operationId": "Type_GetStructDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json index e6c263c691e5..fc5c6208e066 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json @@ -79,7 +79,5 @@ ] } } - }, - "title": "Type_GetTermTemplateDefByGuid", - "operationId": "Type_GetTermTemplateDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json index d8b28d19db05..72f8d97172d8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json @@ -79,7 +79,5 @@ ] } } - }, - "title": "Type_GetTermTemplateDefByName", - "operationId": "Type_GetTermTemplateDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4f9be7fe0434..4e6b37b8b6f1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -265,7 +265,5 @@ ] } } - }, - "title": "Type_List", - "operationId": "Type_List" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index c4118ef9957a..0c3b2d78f851 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -86,7 +86,5 @@ "relationshipDefs": [] } } - }, - "title": "Type_ListEnumDefs", - "operationId": "Type_List" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json index 288c815d8a88..99ec7d9d00b2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json @@ -23,7 +23,5 @@ } ] } - }, - "title": "Type_ListHeaders", - "operationId": "Type_ListHeaders" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index c9a13ccd7758..26902f2461c6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -87,7 +87,5 @@ ] } } - }, - "title": "Type_ListTermTemplateDefs", - "operationId": "Type_List" + } } From 8f7003247f3d435dc8c80188cb8a5ade814aa137 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:19:38 +0800 Subject: [PATCH 084/132] Revert "revert update examples in original example folder" This reverts commit 867767b5dc69f259596e6379aa33617dc6b56d7f. --- .../2023-09-01/examples/Discovery_AutoComplete.json | 6 ++++-- .../stable/2023-09-01/examples/Discovery_Query.json | 7 +++++-- .../2023-09-01/examples/Discovery_Query_And.json | 6 ++++-- .../examples/Discovery_Query_AndOrNested.json | 6 ++++-- .../2023-09-01/examples/Discovery_Query_AssetType.json | 6 ++++-- .../2023-09-01/examples/Discovery_Query_Attribute.json | 6 ++++-- .../Discovery_Query_BusinessMetadataAttribute.json | 6 ++++-- .../examples/Discovery_Query_Classification.json | 6 ++++-- .../examples/Discovery_Query_Collection.json | 6 ++++-- .../2023-09-01/examples/Discovery_Query_Facet.json | 6 ++++-- .../examples/Discovery_Query_FileExtension.json | 6 ++++-- .../examples/Discovery_Query_GlossaryTerm.json | 6 ++++-- .../stable/2023-09-01/examples/Discovery_Query_Id.json | 6 ++++-- .../2023-09-01/examples/Discovery_Query_Not.json | 6 ++++-- .../examples/Discovery_Query_ObjectType.json | 6 ++++-- .../Discovery_Query_PaginationContinuationPage.json | 6 ++++-- .../examples/Discovery_Query_PaginationFirstPage.json | 6 ++++-- .../examples/Discovery_Query_PaginationLastPage.json | 6 ++++-- .../examples/Discovery_Query_SystemTime.json | 6 ++++-- .../2023-09-01/examples/Discovery_Query_Taxonomy.json | 6 ++++-- .../examples/Discovery_Query_TermAssignment.json | 6 ++++-- .../2023-09-01/examples/Discovery_Query_Type.json | 6 ++++-- .../stable/2023-09-01/examples/Discovery_Suggest.json | 6 ++++-- .../Entity_AddClassificationToEntityByGuids.json | 6 ++++-- .../2023-09-01/examples/Entity_AddClassifications.json | 6 ++++-- .../Entity_AddClassificationsByUniqueAttribute.json | 6 ++++-- .../2023-09-01/examples/Entity_AddCustomAttribute.json | 7 +++++-- .../examples/Entity_AddLabelsByUniqueAttribute.json | 4 +++- .../examples/Entity_AddOrUpdate_BusinessAttribute.json | 6 ++++-- .../2023-09-01/examples/Entity_BulkCreateOrUpdate.json | 6 ++++-- .../stable/2023-09-01/examples/Entity_BulkDelete.json | 4 +++- .../examples/Entity_BulkSetClassifications.json | 6 ++++-- .../stable/2023-09-01/examples/Entity_Create.json | 7 +++++-- .../stable/2023-09-01/examples/Entity_Delete.json | 4 +++- .../examples/Entity_DeleteByUniqueAttribute.json | 4 +++- .../stable/2023-09-01/examples/Entity_Get.json | 4 +++- .../examples/Entity_GetByUniqueAttributes.json | 4 +++- .../2023-09-01/examples/Entity_GetClassification.json | 4 +++- .../2023-09-01/examples/Entity_GetClassifications.json | 4 +++- .../stable/2023-09-01/examples/Entity_GetHeader.json | 4 +++- .../Entity_GetSampleBusinessMetadataTemplate.json | 7 +++++-- .../examples/Entity_ImportBusinessMetadata.json | 6 ++++-- .../stable/2023-09-01/examples/Entity_ListByGuids.json | 4 +++- .../examples/Entity_ListByUniqueAttributes.json | 4 +++- .../examples/Entity_MoveEntitiesToCollection.json | 6 ++++-- .../examples/Entity_PartialUpdateAttributeByGuid.json | 4 +++- .../Entity_PartialUpdateByUniqueAttributes.json | 10 ++++++---- .../examples/Entity_RemoveBusinessAttribute.json | 6 ++++-- .../examples/Entity_RemoveBusinessMetadata.json | 4 +++- .../examples/Entity_RemoveClassification.json | 4 +++- .../Entity_RemoveClassificationByUniqueAttribute.json | 4 +++- .../examples/Entity_RemoveLabelsByUniqueAttribute.json | 4 +++- .../examples/Entity_SetLabelsByUniqueAttribute.json | 4 +++- .../stable/2023-09-01/examples/Entity_Update.json | 7 +++++-- .../examples/Entity_UpdateClassifications.json | 6 ++++-- .../Entity_UpdateClassificationsByUniqueAttribute.json | 6 ++++-- .../examples/Glossary_AssignTermToEntities.json | 8 +++++--- .../stable/2023-09-01/examples/Glossary_Create.json | 6 ++++-- .../2023-09-01/examples/Glossary_CreateCategories.json | 6 ++++-- .../2023-09-01/examples/Glossary_CreateCategory.json | 6 ++++-- .../2023-09-01/examples/Glossary_CreateTerm.json | 6 ++++-- .../examples/Glossary_CreateTermWithTemplate.json | 6 ++++-- .../2023-09-01/examples/Glossary_CreateTerms.json | 6 ++++-- .../stable/2023-09-01/examples/Glossary_Delete.json | 6 ++++-- .../2023-09-01/examples/Glossary_DeleteCategory.json | 6 ++++-- .../2023-09-01/examples/Glossary_DeleteTerm.json | 6 ++++-- .../stable/2023-09-01/examples/Glossary_Get.json | 6 ++++-- .../2023-09-01/examples/Glossary_GetCategory.json | 6 ++++-- .../2023-09-01/examples/Glossary_GetDetailed.json | 6 ++++-- .../stable/2023-09-01/examples/Glossary_GetTerm.json | 6 ++++-- .../examples/Glossary_GetTermWithoutAssets.json | 6 ++++-- .../stable/2023-09-01/examples/Glossary_List.json | 4 +++- .../2023-09-01/examples/Glossary_ListCategories.json | 6 ++++-- .../examples/Glossary_ListCategoriesHeaders.json | 6 ++++-- .../examples/Glossary_ListCategoryTerms.json | 6 ++++-- .../Glossary_ListEntitiesAssignedWithTerm.json | 6 ++++-- .../examples/Glossary_ListRelatedCategories.json | 6 ++++-- .../2023-09-01/examples/Glossary_ListRelatedTerms.json | 6 ++++-- .../2023-09-01/examples/Glossary_ListTermHeaders.json | 6 ++++-- .../stable/2023-09-01/examples/Glossary_ListTerms.json | 6 ++++-- .../2023-09-01/examples/Glossary_PartialUpdate.json | 8 +++++--- .../examples/Glossary_PartialUpdateCategory.json | 6 ++++-- .../examples/Glossary_PartialUpdateTerm.json | 10 ++++++---- .../Glossary_RemoveTermAssignmentFromEntities.json | 8 +++++--- .../stable/2023-09-01/examples/Glossary_Update.json | 8 +++++--- .../2023-09-01/examples/Glossary_UpdateCategory.json | 8 +++++--- .../2023-09-01/examples/Glossary_UpdateTerm.json | 8 +++++--- .../stable/2023-09-01/examples/Lineage_Get.json | 4 +++- .../examples/Lineage_GetByUniqueAttribute.json | 4 +++- .../2023-09-01/examples/Lineage_GetNextPage.json | 4 +++- .../2023-09-01/examples/Relationship_Create.json | 6 ++++-- .../2023-09-01/examples/Relationship_Delete.json | 4 +++- .../stable/2023-09-01/examples/Relationship_Get.json | 4 +++- .../2023-09-01/examples/Relationship_Update.json | 6 ++++-- .../stable/2023-09-01/examples/Type_BulkCreate.json | 6 ++++-- .../examples/Type_BulkCreateBusinessMetadataDefs.json | 6 ++++-- .../stable/2023-09-01/examples/Type_BulkDelete.json | 6 ++++-- .../stable/2023-09-01/examples/Type_BulkUpdate.json | 6 ++++-- .../stable/2023-09-01/examples/Type_Delete.json | 4 +++- .../examples/Type_GetBusinessMetadataDefByGuid.json | 4 +++- .../examples/Type_GetBusinessMetadataDefByName.json | 4 +++- .../stable/2023-09-01/examples/Type_GetByGuid.json | 4 +++- .../stable/2023-09-01/examples/Type_GetByName.json | 4 +++- .../examples/Type_GetClassificationDefByGuid.json | 4 +++- .../examples/Type_GetClassificationDefByName.json | 4 +++- .../2023-09-01/examples/Type_GetEntityDefByGuid.json | 4 +++- .../2023-09-01/examples/Type_GetEntityDefByName.json | 4 +++- .../2023-09-01/examples/Type_GetEnumDefByGuid.json | 4 +++- .../2023-09-01/examples/Type_GetEnumDefByName.json | 4 +++- .../examples/Type_GetRelationshipDefByGuid.json | 4 +++- .../examples/Type_GetRelationshipDefByName.json | 4 +++- .../2023-09-01/examples/Type_GetStructDefByGuid.json | 4 +++- .../2023-09-01/examples/Type_GetStructDefByName.json | 4 +++- .../examples/Type_GetTermTemplateDefByGuid.json | 4 +++- .../examples/Type_GetTermTemplateDefByName.json | 4 +++- .../stable/2023-09-01/examples/Type_List.json | 4 +++- .../stable/2023-09-01/examples/Type_ListEnumDefs.json | 4 +++- .../stable/2023-09-01/examples/Type_ListHeaders.json | 4 +++- .../2023-09-01/examples/Type_ListTermTemplateDefs.json | 4 +++- 119 files changed, 447 insertions(+), 204 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 6f9992091ded..b2f2665d5b36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteRequest": { + "body": { "keywords": "exa", "filter": { "and": [ @@ -34,5 +34,7 @@ ] } } - } + }, + "title": "Discovery_AutoComplete", + "operationId": "Discovery_AutoComplete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 01a3c24a0366..28c2961eee1f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,9 +1,10 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { + "kind": "AndFilter", "and": [ { "objectType": "Files" @@ -103,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index 510076af8094..a1f45773a687 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -74,5 +74,7 @@ ] } } - } + }, + "title": "Discovery_Query_And", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index a18f77f11ea4..7ec39b19f500 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_AndOrNested", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index 6f134d2cbc92..deb289d5ea22 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -134,5 +134,7 @@ ] } } - } + }, + "title": "Discovery_Query_AssetType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 33e68dd2cc70..6d2ccf524020 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_Attribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 49a647d73822..2ab33726a034 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -48,5 +48,7 @@ ] } } - } + }, + "title": "Discovery_Query_BusinessMetadataAttribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 1652e3eb3967..5150545e7d0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -63,5 +63,7 @@ ] } } - } + }, + "title": "Discovery_Query_Classification", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 8d51d3b6a9c9..3779d9d497fe 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -62,5 +62,7 @@ ] } } - } + }, + "title": "Discovery_Query_Collection", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index d68b074a230f..b417487bea7d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "filter": { "objectType": "Tables" @@ -144,5 +144,7 @@ ] } } - } + }, + "title": "Discovery_Query_Facet", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 9c2aed22a521..0b7fee10f958 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Discovery_Query_FileExtension", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 15d04904849c..1af1169192d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "", "limit": 10, "filter": { @@ -90,5 +90,7 @@ } } } - } + }, + "title": "Discovery_Query_GlossaryTerm", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index a239b38b5c50..1a983534fbce 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Discovery_Query_Id", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 004b8283ffc2..4c6b90d682c4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Query_Not", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index 1e48cd2210b5..f332749b05ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -69,5 +69,7 @@ ] } } - } + }, + "title": "Discovery_Query_ObjectType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index 99220e6552d4..cbe86e93e8fa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -105,5 +105,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationContinuationPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 9de3ad93b2b7..fe5522da8ebf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationFirstPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 7320000e5082..4e64dd33405e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationLastPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index bde144d66d3f..d2196fa7ea91 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -49,5 +49,7 @@ ] } } - } + }, + "title": "Discovery_Query_SystemTime", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index 6b05a5985854..f2f278e5c48b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Discovery_Query_Taxonomy", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 576c69a243c5..0c24709432b3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "", "limit": 3, "filter": { @@ -53,5 +53,7 @@ ] } } - } + }, + "title": "Discovery_Query_TermAssignment", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index f78c96dd68ac..48480e13fc17 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Discovery_Query_Type", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index f0886ed0c690..3ff80bee52ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Suggest", + "operationId": "Discovery_Suggest" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index c955f4586918..b94ab95331ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "request": { + "body": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationToEntityByGuids", + "operationId": "Entity_AddClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 6aa11763de71..5ab64b05faac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassifications", + "operationId": "Entity_AddClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index e82bbe57a2f3..0a724e78e134 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationsByUniqueAttribute", + "operationId": "Entity_AddClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 5fafde7ea05e..5e50da3bc1c7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -51,5 +52,7 @@ } } } - } + }, + "title": "Entity_AddCustomAttribute", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 8d60d206619e..3a2bc5a3f537 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddLabelsByUniqueAttribute", + "operationId": "Entity_AddLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 6335668124ae..f91a2897c1e2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,12 +2,14 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - } + }, + "title": "Entity_AddOrUpdate_BusinessAttribute", + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index 779992eff9ba..81eb02f76d2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entities": { + "body": { "referredEntities": {}, "entities": [ { @@ -100,5 +100,7 @@ } } } - } + }, + "title": "Entity_BulkCreateOrUpdate", + "operationId": "Entity_BulkCreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json index 067d745f66c1..3b8c27b9b5fc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json @@ -31,5 +31,7 @@ } } } - } + }, + "title": "Entity_BulkDelete", + "operationId": "Entity_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index 907bbe9c1e97..ceac402f49a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entityHeaders": { + "body": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { @@ -35,5 +35,7 @@ "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" ] } - } + }, + "title": "Entity_BulkSetClassifications", + "operationId": "Entity_BulkSetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index b4946962b191..cf8647830754 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -56,5 +57,7 @@ } } } - } + }, + "title": "Entity_Create", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json index 029021e09916..9e6ab2104d44 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json @@ -23,5 +23,7 @@ } } } - } + }, + "title": "Entity_Delete", + "operationId": "Entity_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json index 34948b6504ab..3df1ba7cee96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json @@ -29,5 +29,7 @@ } } } - } + }, + "title": "Entity_DeleteByUniqueAttribute", + "operationId": "Entity_DeleteByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 918d06e41adc..2acf46b04d68 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -57,5 +57,7 @@ } } } - } + }, + "title": "Entity_Get", + "operationId": "Entity_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 1985ed6cb10e..113dab2d668f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -31,5 +31,7 @@ "referredEntities": {} } } - } + }, + "title": "Entity_GetByUniqueAttributes", + "operationId": "Entity_GetByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json index 1d976b1e21e0..968a4d7e0fcc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json @@ -13,5 +13,7 @@ "entityStatus": "ACTIVE" } } - } + }, + "title": "Entity_GetClassification", + "operationId": "Entity_GetClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json index 8f89220119d7..ae0d81292c04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json @@ -18,5 +18,7 @@ "sortType": "NONE" } } - } + }, + "title": "Entity_GetClassifications", + "operationId": "Entity_GetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json index c9ae29bce60d..029a55bbbb96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json @@ -24,5 +24,7 @@ "typeName": "azure_storage_account" } } - } + }, + "title": "Entity_GetHeader", + "operationId": "Entity_GetHeader" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index b25d5b0cc239..34f5b284ae4b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,10 +1,13 @@ { "parameters": { - "Endpoint": "{Endpoint}" + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01" }, "responses": { "200": { "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" } - } + }, + "title": "Entity_GetSampleBusinessMetadataTemplate", + "operationId": "Entity_GetSampleBusinessMetadataTemplate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 37325e736386..7b3743545b30 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "file": "examplefile.csv" + "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { @@ -16,5 +16,7 @@ ] } } - } + }, + "title": "Entity_ImportBusinessMetadata", + "operationId": "Entity_ImportBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index 8d8754364eed..ed6951961940 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -110,5 +110,7 @@ ] } } - } + }, + "title": "Entity_ListByGuids", + "operationId": "Entity_ListByGuids" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index 16c42a58932e..c4ce33dd6345 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -46,5 +46,7 @@ ] } } - } + }, + "title": "Entity_ListByUniqueAttributes", + "operationId": "Entity_ListByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index 42e6555a9f4e..a9d546dacff1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "moveEntitiesRequest": { + "body": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" @@ -41,5 +41,7 @@ } } } - } + }, + "title": "Entity_MoveEntitiesToCollection", + "operationId": "Entity_MoveEntitiesToCollection" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json index 343a0b2ecb25..4320bdb7e9a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateAttributeByGuid", + "operationId": "Entity_PartialUpdateAttributeByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index a38dc403ff1d..40609617bfa7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -3,9 +3,9 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasEntityWithExtInfo": { + "body": { "entity": { - "createTime": 1.605766397985E12, + "createTime": 1605766397985.0, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "relationshipAttributes": { @@ -13,7 +13,7 @@ "meanings": [] }, "status": "ACTIVE", - "updateTime": 1.605766397985E12, + "updateTime": 1605766397985.0, "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "lastModifiedTS": "1", "version": 0.0, @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateByUniqueAttributes", + "operationId": "Entity_PartialUpdateByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 6335668124ae..717225e30454 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -2,12 +2,14 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessAttribute", + "operationId": "Entity_RemoveBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9292ad587d04..9e2de7361e36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessMetadata", + "operationId": "Entity_RemoveBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json index 0967940bc811..408744950b01 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json @@ -6,5 +6,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassification", + "operationId": "Entity_RemoveClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json index 4d2cc9927070..75717c4f59ad 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json @@ -7,5 +7,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassificationByUniqueAttribute", + "operationId": "Entity_RemoveClassificationByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 8479ed0cfe43..3ae4c0b565f8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveLabelsByUniqueAttribute", + "operationId": "Entity_RemoveLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index b2132f45f70b..9ffba096b022 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_SetLabelsByUniqueAttribute", + "operationId": "Entity_SetLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 56799529f337..40e2350403a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -55,5 +56,7 @@ } } } - } + }, + "title": "Entity_Update", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index d558a272e7ea..274b565b8f81 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassifications", + "operationId": "Entity_UpdateClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index e82bbe57a2f3..f3b1777a8e75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassificationsByUniqueAttribute", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 5ff085189499..82aae3a1b087 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { @@ -18,5 +18,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_AssignTermToEntities", + "operationId": "Glossary_AssignTermToEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index a1ec9e6bee07..01289fd09ee1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "atlasGlossary": { + "body": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -26,5 +26,7 @@ "updateTime": 1672892675688 } } - } + }, + "title": "Glossary_Create", + "operationId": "Glossary_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 17a515af1f09..7dfb49f4e1ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": [ + "body": [ { "name": "ExampleCategory2", "anchor": { @@ -41,5 +41,7 @@ } ] } - } + }, + "title": "Glossary_CreateCategories", + "operationId": "Glossary_CreateCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index 7f31caaea342..912e40a4e7ef 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": { + "body": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Glossary_CreateCategory", + "operationId": "Glossary_CreateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index efd7d2d547b2..bd988ea6973b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -72,5 +72,7 @@ } } } - } + }, + "title": "Glossary_CreateTerm", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index c9b7795a1b04..677877660bc8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -47,5 +47,7 @@ } } } - } + }, + "title": "Glossary_CreateTermWithTemplate", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index ddd48b3a0782..18fcddae9a04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": [ + "body": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -87,5 +87,7 @@ } ] } - } + }, + "title": "Glossary_CreateTerms", + "operationId": "Glossary_CreateTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 70b4059decdd..88b82510fb9f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} - } + }, + "title": "Glossary_Delete", + "operationId": "Glossary_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index 678b949d55e5..c281cd4c2450 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteCategory", + "operationId": "Glossary_DeleteCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index 32fd415f64d5..7fa8e97b845a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteTerm", + "operationId": "Glossary_DeleteTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 1eb2a13b1f0b..6e1aaeaa5786 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Glossary_Get", + "operationId": "Glossary_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 2329430d0e4d..1de42a99f57e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { @@ -35,5 +35,7 @@ ] } } - } + }, + "title": "Glossary_GetCategory", + "operationId": "Glossary_GetCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index f5aea38d5f1d..0345a931a976 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { @@ -225,5 +225,7 @@ } } } - } + }, + "title": "Glossary_GetDetailed", + "operationId": "Glossary_GetDetailed" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index d1bf7157bbed..3b574ac3e20f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { @@ -80,5 +80,7 @@ ] } } - } + }, + "title": "Glossary_GetTerm", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index c0dcc7655580..3bedbf11a9a4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Glossary_GetTermWithoutAssets", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json index f8bc74ada7f4..c454ce6b68f7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json @@ -55,5 +55,7 @@ } ] } - } + }, + "title": "Glossary_List", + "operationId": "Glossary_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index aabcc66dc2d0..30e8cf73dbfd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -68,5 +68,7 @@ } ] } - } + }, + "title": "Glossary_ListCategories", + "operationId": "Glossary_ListCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index 277c967f7f0b..a04eb3cba127 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -28,5 +28,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoriesHeaders", + "operationId": "Glossary_ListCategoriesHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index 7fe35d8dd8f2..e1a99139221b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -16,5 +16,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoryTerms", + "operationId": "Glossary_ListCategoryTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index ebfed3c2de40..99c872e87c99 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" @@ -53,5 +53,7 @@ } ] } - } + }, + "title": "Glossary_ListEntitiesAssignedWithTerm", + "operationId": "Glossary_ListEntitiesAssignedWithTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index 7523745867a5..2e845fcb0944 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedCategories", + "operationId": "Glossary_ListRelatedCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index ca90bb6d08d7..56999a9dd79a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedTerms", + "operationId": "Glossary_ListRelatedTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 1375aa567f2b..6bcfbe8c9fc9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -21,5 +21,7 @@ } ] } - } + }, + "title": "Glossary_ListTermHeaders", + "operationId": "Glossary_ListTermHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index 214bbd4c4f76..583aa635b462 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -99,5 +99,7 @@ } ] } - } + }, + "title": "Glossary_ListTerms", + "operationId": "Glossary_ListTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index 4df90166a6b6..c06db55d9e38 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "partialUpdates": { + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { "longDescription": "Example Long Description" } }, @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdate", + "operationId": "Glossary_PartialUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index 11516593b6bd..fcd86785e556 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", + "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", "partialUpdates": { "longDescription": "Example Long Description" } @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateCategory", + "operationId": "Glossary_PartialUpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index 572d692fa4b6..356a70cf4da3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "partialUpdates": { - "longDescription": "Example Long Descrition" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { + "longDescription": "Example Long Description" } }, "responses": { @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateTerm", + "operationId": "Glossary_PartialUpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index ca978c5df1fc..2238f2443727 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" @@ -11,5 +11,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_RemoveTermAssignmentFromEntities", + "operationId": "Glossary_DeleteTermAssignmentFromEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index ac2868693994..faca8b5cb2a2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "updatedGlossary": { + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", @@ -92,5 +92,7 @@ ] } } - } + }, + "title": "Glossary_Update", + "operationId": "Glossary_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index fb8c92c94fd5..7c145590a59b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "glossaryCategory": { + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", @@ -59,5 +59,7 @@ ] } } - } + }, + "title": "Glossary_UpdateCategory", + "operationId": "Glossary_UpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 065bba39f639..9ed4cb3964b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "glossaryTerm": { + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Glossary_UpdateTerm", + "operationId": "Glossary_UpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json index 122a1804289c..a08de217b1c0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json @@ -20,5 +20,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_Get", + "operationId": "Lineage_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json index 4b9886deec69..ab738e50995b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json @@ -59,5 +59,7 @@ } } } - } + }, + "title": "Lineage_GetByUniqueAttribute", + "operationId": "Lineage_GetByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json index 66f7aac1fb7a..778a391f5b59 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json @@ -21,5 +21,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_GetNextPage", + "operationId": "Lineage_GetNextPage" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 8122eee5cd3a..89d3b4e5afec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -54,5 +54,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Create", + "operationId": "Relationship_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json index 291912c8ccac..c6e4848b9952 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Relationship_Delete", + "operationId": "Relationship_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json index 7a9054f95285..182684f354bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json @@ -35,5 +35,7 @@ } } } - } + }, + "title": "Relationship_Get", + "operationId": "Relationship_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 3664c81a3ec7..0cd955fe3154 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -55,5 +55,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Update", + "operationId": "Relationship_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index 3c08502d3e0f..d91723b6e888 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -67,5 +67,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_BulkCreate", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 66e7d50e8570..433ff8867948 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -71,5 +71,7 @@ ] } } - } + }, + "title": "Type_BulkCreateBusinessMetadataDefs", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index 40e463be1ce9..60ba8acc3b75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -29,5 +29,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_BulkDelete", + "operationId": "Type_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index fd37acb1ec1c..7905abbea1af 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -284,5 +284,7 @@ ] } } - } + }, + "title": "Type_BulkUpdate", + "operationId": "Type_BulkUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json index d95c0728b9cb..8a364027401e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_Delete", + "operationId": "Type_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json index 5790a0df446e..34921a8239b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByGuid", + "operationId": "Type_GetBusinessMetadataDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json index 89abf18c256d..64d92fefd723 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByName", + "operationId": "Type_GetBusinessMetadataDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json index ebd1ed4902de..e94b5ad8b518 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByGuid", + "operationId": "Type_GetByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json index 77ec05812c26..804029d070e1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByName", + "operationId": "Type_GetByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json index 31f09a6d61e6..bf27840af6aa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByGuid", + "operationId": "Type_GetClassificationDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json index b7d7ed8a4f74..e7a58bf32bfb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByName", + "operationId": "Type_GetClassificationDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json index 2728fb2507c3..9c0d6ce53cb7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByGuid", + "operationId": "Type_GetEntityDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json index 0542db979369..140ba1a5b309 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByName", + "operationId": "Type_GetEntityDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json index 9c324ce8d35b..ab9e4048b0d2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByGuid", + "operationId": "Type_GetEnumDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json index 6adfee266b61..62907f8f6a69 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByName", + "operationId": "Type_GetEnumDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json index 66b6efd3f8bf..71c9a03a65d9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByGuid", + "operationId": "Type_GetRelationshipDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json index 148c7d655371..ecdafc07a934 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByName", + "operationId": "Type_GetRelationshipDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json index d2e1e0901f30..c31ae06aeeb6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByGuid", + "operationId": "Type_GetStructDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json index 6bffd4888fa2..26f8e843a6d6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByName", + "operationId": "Type_GetStructDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json index fc5c6208e066..e6c263c691e5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByGuid", + "operationId": "Type_GetTermTemplateDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json index 72f8d97172d8..d8b28d19db05 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByName", + "operationId": "Type_GetTermTemplateDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4e6b37b8b6f1..4f9be7fe0434 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -265,5 +265,7 @@ ] } } - } + }, + "title": "Type_List", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index 0c3b2d78f851..c4118ef9957a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -86,5 +86,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_ListEnumDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json index 99ec7d9d00b2..288c815d8a88 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json @@ -23,5 +23,7 @@ } ] } - } + }, + "title": "Type_ListHeaders", + "operationId": "Type_ListHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index 26902f2461c6..c9a13ccd7758 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -87,5 +87,7 @@ ] } } - } + }, + "title": "Type_ListTermTemplateDefs", + "operationId": "Type_List" } From d31fe8aa07e5076cf6e3299c3a9123681ebabd23 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:26:44 +0800 Subject: [PATCH 085/132] Update Glossary_PartialUpdateCategory.json --- .../2023-09-01/examples/Glossary_PartialUpdateCategory.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index fcd86785e556..15be08095e73 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", - "partialUpdates": { + "body": { "longDescription": "Example Long Description" } }, From a03cfea9951e2fa31b32d0005341363282621f6f Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:28:58 +0800 Subject: [PATCH 086/132] Revert "Update Glossary_PartialUpdateCategory.json" This reverts commit d31fe8aa07e5076cf6e3299c3a9123681ebabd23. --- .../2023-09-01/examples/Glossary_PartialUpdateCategory.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index 15be08095e73..fcd86785e556 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", - "body": { + "partialUpdates": { "longDescription": "Example Long Description" } }, From e1cd39232f47e437a476d795dd9d659785eb826d Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:29:11 +0800 Subject: [PATCH 087/132] Revert "Revert "revert update examples in original example folder"" This reverts commit 8f7003247f3d435dc8c80188cb8a5ade814aa137. --- .../2023-09-01/examples/Discovery_AutoComplete.json | 6 ++---- .../stable/2023-09-01/examples/Discovery_Query.json | 7 ++----- .../2023-09-01/examples/Discovery_Query_And.json | 6 ++---- .../examples/Discovery_Query_AndOrNested.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_AssetType.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Attribute.json | 6 ++---- .../Discovery_Query_BusinessMetadataAttribute.json | 6 ++---- .../examples/Discovery_Query_Classification.json | 6 ++---- .../examples/Discovery_Query_Collection.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Facet.json | 6 ++---- .../examples/Discovery_Query_FileExtension.json | 6 ++---- .../examples/Discovery_Query_GlossaryTerm.json | 6 ++---- .../stable/2023-09-01/examples/Discovery_Query_Id.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Not.json | 6 ++---- .../examples/Discovery_Query_ObjectType.json | 6 ++---- .../Discovery_Query_PaginationContinuationPage.json | 6 ++---- .../examples/Discovery_Query_PaginationFirstPage.json | 6 ++---- .../examples/Discovery_Query_PaginationLastPage.json | 6 ++---- .../examples/Discovery_Query_SystemTime.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Taxonomy.json | 6 ++---- .../examples/Discovery_Query_TermAssignment.json | 6 ++---- .../2023-09-01/examples/Discovery_Query_Type.json | 6 ++---- .../stable/2023-09-01/examples/Discovery_Suggest.json | 6 ++---- .../Entity_AddClassificationToEntityByGuids.json | 6 ++---- .../2023-09-01/examples/Entity_AddClassifications.json | 6 ++---- .../Entity_AddClassificationsByUniqueAttribute.json | 6 ++---- .../2023-09-01/examples/Entity_AddCustomAttribute.json | 7 ++----- .../examples/Entity_AddLabelsByUniqueAttribute.json | 4 +--- .../examples/Entity_AddOrUpdate_BusinessAttribute.json | 6 ++---- .../2023-09-01/examples/Entity_BulkCreateOrUpdate.json | 6 ++---- .../stable/2023-09-01/examples/Entity_BulkDelete.json | 4 +--- .../examples/Entity_BulkSetClassifications.json | 6 ++---- .../stable/2023-09-01/examples/Entity_Create.json | 7 ++----- .../stable/2023-09-01/examples/Entity_Delete.json | 4 +--- .../examples/Entity_DeleteByUniqueAttribute.json | 4 +--- .../stable/2023-09-01/examples/Entity_Get.json | 4 +--- .../examples/Entity_GetByUniqueAttributes.json | 4 +--- .../2023-09-01/examples/Entity_GetClassification.json | 4 +--- .../2023-09-01/examples/Entity_GetClassifications.json | 4 +--- .../stable/2023-09-01/examples/Entity_GetHeader.json | 4 +--- .../Entity_GetSampleBusinessMetadataTemplate.json | 7 ++----- .../examples/Entity_ImportBusinessMetadata.json | 6 ++---- .../stable/2023-09-01/examples/Entity_ListByGuids.json | 4 +--- .../examples/Entity_ListByUniqueAttributes.json | 4 +--- .../examples/Entity_MoveEntitiesToCollection.json | 6 ++---- .../examples/Entity_PartialUpdateAttributeByGuid.json | 4 +--- .../Entity_PartialUpdateByUniqueAttributes.json | 10 ++++------ .../examples/Entity_RemoveBusinessAttribute.json | 6 ++---- .../examples/Entity_RemoveBusinessMetadata.json | 4 +--- .../examples/Entity_RemoveClassification.json | 4 +--- .../Entity_RemoveClassificationByUniqueAttribute.json | 4 +--- .../examples/Entity_RemoveLabelsByUniqueAttribute.json | 4 +--- .../examples/Entity_SetLabelsByUniqueAttribute.json | 4 +--- .../stable/2023-09-01/examples/Entity_Update.json | 7 ++----- .../examples/Entity_UpdateClassifications.json | 6 ++---- .../Entity_UpdateClassificationsByUniqueAttribute.json | 6 ++---- .../examples/Glossary_AssignTermToEntities.json | 8 +++----- .../stable/2023-09-01/examples/Glossary_Create.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateCategories.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateCategory.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateTerm.json | 6 ++---- .../examples/Glossary_CreateTermWithTemplate.json | 6 ++---- .../2023-09-01/examples/Glossary_CreateTerms.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_Delete.json | 6 ++---- .../2023-09-01/examples/Glossary_DeleteCategory.json | 6 ++---- .../2023-09-01/examples/Glossary_DeleteTerm.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_Get.json | 6 ++---- .../2023-09-01/examples/Glossary_GetCategory.json | 6 ++---- .../2023-09-01/examples/Glossary_GetDetailed.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_GetTerm.json | 6 ++---- .../examples/Glossary_GetTermWithoutAssets.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_List.json | 4 +--- .../2023-09-01/examples/Glossary_ListCategories.json | 6 ++---- .../examples/Glossary_ListCategoriesHeaders.json | 6 ++---- .../examples/Glossary_ListCategoryTerms.json | 6 ++---- .../Glossary_ListEntitiesAssignedWithTerm.json | 6 ++---- .../examples/Glossary_ListRelatedCategories.json | 6 ++---- .../2023-09-01/examples/Glossary_ListRelatedTerms.json | 6 ++---- .../2023-09-01/examples/Glossary_ListTermHeaders.json | 6 ++---- .../stable/2023-09-01/examples/Glossary_ListTerms.json | 6 ++---- .../2023-09-01/examples/Glossary_PartialUpdate.json | 8 +++----- .../examples/Glossary_PartialUpdateCategory.json | 6 ++---- .../examples/Glossary_PartialUpdateTerm.json | 10 ++++------ .../Glossary_RemoveTermAssignmentFromEntities.json | 8 +++----- .../stable/2023-09-01/examples/Glossary_Update.json | 8 +++----- .../2023-09-01/examples/Glossary_UpdateCategory.json | 8 +++----- .../2023-09-01/examples/Glossary_UpdateTerm.json | 8 +++----- .../stable/2023-09-01/examples/Lineage_Get.json | 4 +--- .../examples/Lineage_GetByUniqueAttribute.json | 4 +--- .../2023-09-01/examples/Lineage_GetNextPage.json | 4 +--- .../2023-09-01/examples/Relationship_Create.json | 6 ++---- .../2023-09-01/examples/Relationship_Delete.json | 4 +--- .../stable/2023-09-01/examples/Relationship_Get.json | 4 +--- .../2023-09-01/examples/Relationship_Update.json | 6 ++---- .../stable/2023-09-01/examples/Type_BulkCreate.json | 6 ++---- .../examples/Type_BulkCreateBusinessMetadataDefs.json | 6 ++---- .../stable/2023-09-01/examples/Type_BulkDelete.json | 6 ++---- .../stable/2023-09-01/examples/Type_BulkUpdate.json | 6 ++---- .../stable/2023-09-01/examples/Type_Delete.json | 4 +--- .../examples/Type_GetBusinessMetadataDefByGuid.json | 4 +--- .../examples/Type_GetBusinessMetadataDefByName.json | 4 +--- .../stable/2023-09-01/examples/Type_GetByGuid.json | 4 +--- .../stable/2023-09-01/examples/Type_GetByName.json | 4 +--- .../examples/Type_GetClassificationDefByGuid.json | 4 +--- .../examples/Type_GetClassificationDefByName.json | 4 +--- .../2023-09-01/examples/Type_GetEntityDefByGuid.json | 4 +--- .../2023-09-01/examples/Type_GetEntityDefByName.json | 4 +--- .../2023-09-01/examples/Type_GetEnumDefByGuid.json | 4 +--- .../2023-09-01/examples/Type_GetEnumDefByName.json | 4 +--- .../examples/Type_GetRelationshipDefByGuid.json | 4 +--- .../examples/Type_GetRelationshipDefByName.json | 4 +--- .../2023-09-01/examples/Type_GetStructDefByGuid.json | 4 +--- .../2023-09-01/examples/Type_GetStructDefByName.json | 4 +--- .../examples/Type_GetTermTemplateDefByGuid.json | 4 +--- .../examples/Type_GetTermTemplateDefByName.json | 4 +--- .../stable/2023-09-01/examples/Type_List.json | 4 +--- .../stable/2023-09-01/examples/Type_ListEnumDefs.json | 4 +--- .../stable/2023-09-01/examples/Type_ListHeaders.json | 4 +--- .../2023-09-01/examples/Type_ListTermTemplateDefs.json | 4 +--- 119 files changed, 204 insertions(+), 447 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index b2f2665d5b36..6f9992091ded 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "autoCompleteRequest": { "keywords": "exa", "filter": { "and": [ @@ -34,7 +34,5 @@ ] } } - }, - "title": "Discovery_AutoComplete", - "operationId": "Discovery_AutoComplete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 28c2961eee1f..01a3c24a0366 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,10 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { "objectType": "Files" @@ -104,7 +103,5 @@ ] } } - }, - "title": "Discovery_Query", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index a1f45773a687..510076af8094 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -74,7 +74,5 @@ ] } } - }, - "title": "Discovery_Query_And", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index 7ec39b19f500..a18f77f11ea4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -91,7 +91,5 @@ ] } } - }, - "title": "Discovery_Query_AndOrNested", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index deb289d5ea22..6f134d2cbc92 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -134,7 +134,5 @@ ] } } - }, - "title": "Discovery_Query_AssetType", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 6d2ccf524020..33e68dd2cc70 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -91,7 +91,5 @@ ] } } - }, - "title": "Discovery_Query_Attribute", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 2ab33726a034..49a647d73822 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -48,7 +48,5 @@ ] } } - }, - "title": "Discovery_Query_BusinessMetadataAttribute", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 5150545e7d0f..1652e3eb3967 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -63,7 +63,5 @@ ] } } - }, - "title": "Discovery_Query_Classification", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 3779d9d497fe..8d51d3b6a9c9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -62,7 +62,5 @@ ] } } - }, - "title": "Discovery_Query_Collection", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index b417487bea7d..d68b074a230f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "filter": { "objectType": "Tables" @@ -144,7 +144,5 @@ ] } } - }, - "title": "Discovery_Query_Facet", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 0b7fee10f958..9c2aed22a521 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -56,7 +56,5 @@ ] } } - }, - "title": "Discovery_Query_FileExtension", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 1af1169192d0..15d04904849c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "", "limit": 10, "filter": { @@ -90,7 +90,5 @@ } } } - }, - "title": "Discovery_Query_GlossaryTerm", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index 1a983534fbce..a239b38b5c50 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -39,7 +39,5 @@ ] } } - }, - "title": "Discovery_Query_Id", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 4c6b90d682c4..004b8283ffc2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -54,7 +54,5 @@ ] } } - }, - "title": "Discovery_Query_Not", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index f332749b05ee..1e48cd2210b5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -69,7 +69,5 @@ ] } } - }, - "title": "Discovery_Query_ObjectType", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index cbe86e93e8fa..99220e6552d4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -105,7 +105,5 @@ ] } } - }, - "title": "Discovery_Query_PaginationContinuationPage", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index fe5522da8ebf..9de3ad93b2b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -104,7 +104,5 @@ ] } } - }, - "title": "Discovery_Query_PaginationFirstPage", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 4e64dd33405e..7320000e5082 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -104,7 +104,5 @@ ] } } - }, - "title": "Discovery_Query_PaginationLastPage", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index d2196fa7ea91..bde144d66d3f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -49,7 +49,5 @@ ] } } - }, - "title": "Discovery_Query_SystemTime", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index f2f278e5c48b..6b05a5985854 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -88,7 +88,5 @@ ] } } - }, - "title": "Discovery_Query_Taxonomy", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 0c24709432b3..576c69a243c5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": "", "limit": 3, "filter": { @@ -53,7 +53,5 @@ ] } } - }, - "title": "Discovery_Query_TermAssignment", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index 48480e13fc17..f78c96dd68ac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "searchRequest": { "keywords": null, "limit": 10, "filter": { @@ -60,7 +60,5 @@ ] } } - }, - "title": "Discovery_Query_Type", - "operationId": "Discovery_Query" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index 3ff80bee52ec..f0886ed0c690 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "suggestRequest": { "keywords": "exampledata", "filter": { "and": [ @@ -54,7 +54,5 @@ ] } } - }, - "title": "Discovery_Suggest", - "operationId": "Discovery_Suggest" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index b94ab95331ec..c955f4586918 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "request": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, @@ -15,7 +15,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddClassificationToEntityByGuids", - "operationId": "Entity_AddClassification" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 5ab64b05faac..6aa11763de71 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "body": [ + "classifications": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" @@ -15,7 +15,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddClassifications", - "operationId": "Entity_AddClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index 0a724e78e134..e82bbe57a2f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "body": [ + "atlasClassificationArray": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,7 +14,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddClassificationsByUniqueAttribute", - "operationId": "Entity_AddClassificationsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 5e50da3bc1c7..5fafde7ea05e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -1,8 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2023-09-01", - "body": { + "entity": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -52,7 +51,5 @@ } } } - }, - "title": "Entity_AddCustomAttribute", - "operationId": "Entity_CreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 3a2bc5a3f537..8d60d206619e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -9,7 +9,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_AddLabelsByUniqueAttribute", - "operationId": "Entity_AddLabelsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index f91a2897c1e2..6335668124ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,14 +2,12 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadataName": "myBizMetaData1", + "bmName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - }, - "title": "Entity_AddOrUpdate_BusinessAttribute", - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index 81eb02f76d2e..779992eff9ba 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "entities": { "referredEntities": {}, "entities": [ { @@ -100,7 +100,5 @@ } } } - }, - "title": "Entity_BulkCreateOrUpdate", - "operationId": "Entity_BulkCreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json index 3b8c27b9b5fc..067d745f66c1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json @@ -31,7 +31,5 @@ } } } - }, - "title": "Entity_BulkDelete", - "operationId": "Entity_BulkDelete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index ceac402f49a7..907bbe9c1e97 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "entityHeaders": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { @@ -35,7 +35,5 @@ "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" ] } - }, - "title": "Entity_BulkSetClassifications", - "operationId": "Entity_BulkSetClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index cf8647830754..b4946962b191 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -1,8 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2023-09-01", - "body": { + "entity": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -57,7 +56,5 @@ } } } - }, - "title": "Entity_Create", - "operationId": "Entity_CreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json index 9e6ab2104d44..029021e09916 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json @@ -23,7 +23,5 @@ } } } - }, - "title": "Entity_Delete", - "operationId": "Entity_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json index 3df1ba7cee96..34948b6504ab 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json @@ -29,7 +29,5 @@ } } } - }, - "title": "Entity_DeleteByUniqueAttribute", - "operationId": "Entity_DeleteByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 2acf46b04d68..918d06e41adc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -57,7 +57,5 @@ } } } - }, - "title": "Entity_Get", - "operationId": "Entity_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 113dab2d668f..1985ed6cb10e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -31,7 +31,5 @@ "referredEntities": {} } } - }, - "title": "Entity_GetByUniqueAttributes", - "operationId": "Entity_GetByUniqueAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json index 968a4d7e0fcc..1d976b1e21e0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json @@ -13,7 +13,5 @@ "entityStatus": "ACTIVE" } } - }, - "title": "Entity_GetClassification", - "operationId": "Entity_GetClassification" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json index ae0d81292c04..8f89220119d7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json @@ -18,7 +18,5 @@ "sortType": "NONE" } } - }, - "title": "Entity_GetClassifications", - "operationId": "Entity_GetClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json index 029a55bbbb96..c9ae29bce60d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json @@ -24,7 +24,5 @@ "typeName": "azure_storage_account" } } - }, - "title": "Entity_GetHeader", - "operationId": "Entity_GetHeader" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index 34f5b284ae4b..b25d5b0cc239 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,13 +1,10 @@ { "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2023-09-01" + "Endpoint": "{Endpoint}" }, "responses": { "200": { "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" } - }, - "title": "Entity_GetSampleBusinessMetadataTemplate", - "operationId": "Entity_GetSampleBusinessMetadataTemplate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 7b3743545b30..37325e736386 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "file": "examplefile.csv" }, "responses": { "200": { @@ -16,7 +16,5 @@ ] } } - }, - "title": "Entity_ImportBusinessMetadata", - "operationId": "Entity_ImportBusinessMetadata" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index ed6951961940..8d8754364eed 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -110,7 +110,5 @@ ] } } - }, - "title": "Entity_ListByGuids", - "operationId": "Entity_ListByGuids" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index c4ce33dd6345..16c42a58932e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -46,7 +46,5 @@ ] } } - }, - "title": "Entity_ListByUniqueAttributes", - "operationId": "Entity_ListByUniqueAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index a9d546dacff1..42e6555a9f4e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "body": { + "moveEntitiesRequest": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" @@ -41,7 +41,5 @@ } } } - }, - "title": "Entity_MoveEntitiesToCollection", - "operationId": "Entity_MoveEntitiesToCollection" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json index 4320bdb7e9a7..343a0b2ecb25 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json @@ -33,7 +33,5 @@ ] } } - }, - "title": "Entity_PartialUpdateAttributeByGuid", - "operationId": "Entity_PartialUpdateAttributeByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index 40609617bfa7..a38dc403ff1d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -3,9 +3,9 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "body": { + "atlasEntityWithExtInfo": { "entity": { - "createTime": 1605766397985.0, + "createTime": 1.605766397985E12, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "relationshipAttributes": { @@ -13,7 +13,7 @@ "meanings": [] }, "status": "ACTIVE", - "updateTime": 1605766397985.0, + "updateTime": 1.605766397985E12, "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "lastModifiedTS": "1", "version": 0.0, @@ -56,7 +56,5 @@ ] } } - }, - "title": "Entity_PartialUpdateByUniqueAttributes", - "operationId": "Entity_PartialUpdateByUniqueAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 717225e30454..6335668124ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -2,14 +2,12 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "businessMetadataName": "myBizMetaData1", + "bmName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - }, - "title": "Entity_RemoveBusinessAttribute", - "operationId": "Entity_RemoveBusinessMetadataAttributes" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9e2de7361e36..9292ad587d04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -10,7 +10,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveBusinessMetadata", - "operationId": "Entity_RemoveBusinessMetadata" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json index 408744950b01..0967940bc811 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json @@ -6,7 +6,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveClassification", - "operationId": "Entity_RemoveClassification" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json index 75717c4f59ad..4d2cc9927070 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json @@ -7,7 +7,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveClassificationByUniqueAttribute", - "operationId": "Entity_RemoveClassificationByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 3ae4c0b565f8..8479ed0cfe43 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -9,7 +9,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_RemoveLabelsByUniqueAttribute", - "operationId": "Entity_RemoveLabelsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index 9ffba096b022..b2132f45f70b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -10,7 +10,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_SetLabelsByUniqueAttribute", - "operationId": "Entity_SetLabelsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 40e2350403a5..56799529f337 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -1,8 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "api-version": "2023-09-01", - "body": { + "entity": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -56,7 +55,5 @@ } } } - }, - "title": "Entity_Update", - "operationId": "Entity_CreateOrUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index 274b565b8f81..d558a272e7ea 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "body": [ + "classifications": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" @@ -15,7 +15,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_UpdateClassifications", - "operationId": "Entity_UpdateClassifications" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index f3b1777a8e75..e82bbe57a2f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "body": [ + "atlasClassificationArray": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,7 +14,5 @@ }, "responses": { "204": {} - }, - "title": "Entity_UpdateClassificationsByUniqueAttribute", - "operationId": "Entity_UpdateClassificationsByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 82aae3a1b087..5ff085189499 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "body": [ + "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "relatedObjectIds": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { @@ -18,7 +18,5 @@ }, "responses": { "204": {} - }, - "title": "Glossary_AssignTermToEntities", - "operationId": "Glossary_AssignTermToEntities" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index 01289fd09ee1..a1ec9e6bee07 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "atlasGlossary": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -26,7 +26,5 @@ "updateTime": 1672892675688 } } - }, - "title": "Glossary_Create", - "operationId": "Glossary_Create" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 7dfb49f4e1ae..17a515af1f09 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": [ + "glossaryCategory": [ { "name": "ExampleCategory2", "anchor": { @@ -41,7 +41,5 @@ } ] } - }, - "title": "Glossary_CreateCategories", - "operationId": "Glossary_CreateCategories" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index 912e40a4e7ef..7f31caaea342 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "glossaryCategory": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, @@ -33,7 +33,5 @@ ] } } - }, - "title": "Glossary_CreateCategory", - "operationId": "Glossary_CreateCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index bd988ea6973b..efd7d2d547b2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "glossaryTerm": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -72,7 +72,5 @@ } } } - }, - "title": "Glossary_CreateTerm", - "operationId": "Glossary_CreateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index 677877660bc8..c9b7795a1b04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "glossaryTerm": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -47,7 +47,5 @@ } } } - }, - "title": "Glossary_CreateTermWithTemplate", - "operationId": "Glossary_CreateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index 18fcddae9a04..ddd48b3a0782 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": [ + "glossaryTerm": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -87,7 +87,5 @@ } ] } - }, - "title": "Glossary_CreateTerms", - "operationId": "Glossary_CreateTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 88b82510fb9f..70b4059decdd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -1,11 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} - }, - "title": "Glossary_Delete", - "operationId": "Glossary_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index c281cd4c2450..678b949d55e5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -1,11 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} - }, - "title": "Glossary_DeleteCategory", - "operationId": "Glossary_DeleteCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index 7fa8e97b845a..32fd415f64d5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -1,11 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} - }, - "title": "Glossary_DeleteTerm", - "operationId": "Glossary_DeleteTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 6e1aaeaa5786..1eb2a13b1f0b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { @@ -37,7 +37,5 @@ ] } } - }, - "title": "Glossary_Get", - "operationId": "Glossary_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 1de42a99f57e..2329430d0e4d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { @@ -35,7 +35,5 @@ ] } } - }, - "title": "Glossary_GetCategory", - "operationId": "Glossary_GetCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index 0345a931a976..f5aea38d5f1d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { @@ -225,7 +225,5 @@ } } } - }, - "title": "Glossary_GetDetailed", - "operationId": "Glossary_GetDetailed" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index 3b574ac3e20f..d1bf7157bbed 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { @@ -80,7 +80,5 @@ ] } } - }, - "title": "Glossary_GetTerm", - "operationId": "Glossary_GetTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index 3bedbf11a9a4..c0dcc7655580 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] @@ -60,7 +60,5 @@ ] } } - }, - "title": "Glossary_GetTermWithoutAssets", - "operationId": "Glossary_GetTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json index c454ce6b68f7..f8bc74ada7f4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json @@ -55,7 +55,5 @@ } ] } - }, - "title": "Glossary_List", - "operationId": "Glossary_List" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index 30e8cf73dbfd..aabcc66dc2d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -68,7 +68,5 @@ } ] } - }, - "title": "Glossary_ListCategories", - "operationId": "Glossary_ListCategories" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index a04eb3cba127..277c967f7f0b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -28,7 +28,5 @@ } ] } - }, - "title": "Glossary_ListCategoriesHeaders", - "operationId": "Glossary_ListCategoriesHeaders" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index e1a99139221b..7fe35d8dd8f2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -16,7 +16,5 @@ } ] } - }, - "title": "Glossary_ListCategoryTerms", - "operationId": "Glossary_ListCategoryTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index 99c872e87c99..ebfed3c2de40 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" @@ -53,7 +53,5 @@ } ] } - }, - "title": "Glossary_ListEntitiesAssignedWithTerm", - "operationId": "Glossary_ListEntitiesAssignedWithTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index 2e845fcb0944..7523745867a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,7 +25,5 @@ ] } } - }, - "title": "Glossary_ListRelatedCategories", - "operationId": "Glossary_ListRelatedCategories" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index 56999a9dd79a..ca90bb6d08d7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,7 +25,5 @@ ] } } - }, - "title": "Glossary_ListRelatedTerms", - "operationId": "Glossary_ListRelatedTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 6bcfbe8c9fc9..1375aa567f2b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -21,7 +21,5 @@ } ] } - }, - "title": "Glossary_ListTermHeaders", - "operationId": "Glossary_ListTermHeaders" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index 583aa635b462..214bbd4c4f76 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -99,7 +99,5 @@ } ] } - }, - "title": "Glossary_ListTerms", - "operationId": "Glossary_ListTerms" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index c06db55d9e38..4df90166a6b6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "body": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "partialUpdates": { "longDescription": "Example Long Description" } }, @@ -54,7 +54,5 @@ ] } } - }, - "title": "Glossary_PartialUpdate", - "operationId": "Glossary_PartialUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index fcd86785e556..11516593b6bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", + "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", "partialUpdates": { "longDescription": "Example Long Description" } @@ -39,7 +39,5 @@ ] } } - }, - "title": "Glossary_PartialUpdateCategory", - "operationId": "Glossary_PartialUpdateCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index 356a70cf4da3..572d692fa4b6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "body": { - "longDescription": "Example Long Description" + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "partialUpdates": { + "longDescription": "Example Long Descrition" } }, "responses": { @@ -54,7 +54,5 @@ ] } } - }, - "title": "Glossary_PartialUpdateTerm", - "operationId": "Glossary_PartialUpdateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index 2238f2443727..ca978c5df1fc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "body": [ + "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "relatedObjectIds": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" @@ -11,7 +11,5 @@ }, "responses": { "204": {} - }, - "title": "Glossary_RemoveTermAssignmentFromEntities", - "operationId": "Glossary_DeleteTermAssignmentFromEntities" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index faca8b5cb2a2..ac2868693994 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "body": { + "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "updatedGlossary": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", @@ -92,7 +92,5 @@ ] } } - }, - "title": "Glossary_Update", - "operationId": "Glossary_Update" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index 7c145590a59b..fb8c92c94fd5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "body": { + "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "glossaryCategory": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", @@ -59,7 +59,5 @@ ] } } - }, - "title": "Glossary_UpdateCategory", - "operationId": "Glossary_UpdateCategory" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 9ed4cb3964b7..065bba39f639 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", - "body": { + "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "glossaryTerm": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", @@ -88,7 +88,5 @@ ] } } - }, - "title": "Glossary_UpdateTerm", - "operationId": "Glossary_UpdateTerm" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json index a08de217b1c0..122a1804289c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json @@ -20,7 +20,5 @@ "parentRelations": [] } } - }, - "title": "Lineage_Get", - "operationId": "Lineage_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json index ab738e50995b..4b9886deec69 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json @@ -59,7 +59,5 @@ } } } - }, - "title": "Lineage_GetByUniqueAttribute", - "operationId": "Lineage_GetByUniqueAttribute" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json index 778a391f5b59..66f7aac1fb7a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json @@ -21,7 +21,5 @@ "parentRelations": [] } } - }, - "title": "Lineage_GetNextPage", - "operationId": "Lineage_GetNextPage" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 89d3b4e5afec..8122eee5cd3a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "relationship": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -54,7 +54,5 @@ "version": 0 } } - }, - "title": "Relationship_Create", - "operationId": "Relationship_Create" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json index c6e4848b9952..291912c8ccac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json @@ -5,7 +5,5 @@ }, "responses": { "204": {} - }, - "title": "Relationship_Delete", - "operationId": "Relationship_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json index 182684f354bd..7a9054f95285 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json @@ -35,7 +35,5 @@ } } } - }, - "title": "Relationship_Get", - "operationId": "Relationship_Get" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 0cd955fe3154..3664c81a3ec7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "relationship": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -55,7 +55,5 @@ "version": 0 } } - }, - "title": "Relationship_Update", - "operationId": "Relationship_Update" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index d91723b6e888..3c08502d3e0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -67,7 +67,5 @@ "relationshipDefs": [] } } - }, - "title": "Type_BulkCreate", - "operationId": "Type_BulkCreate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 433ff8867948..66e7d50e8570 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -71,7 +71,5 @@ ] } } - }, - "title": "Type_BulkCreateBusinessMetadataDefs", - "operationId": "Type_BulkCreate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index 60ba8acc3b75..40e463be1ce9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -29,7 +29,5 @@ }, "responses": { "204": {} - }, - "title": "Type_BulkDelete", - "operationId": "Type_BulkDelete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index 7905abbea1af..fd37acb1ec1c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "body": { + "typesDef": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -284,7 +284,5 @@ ] } } - }, - "title": "Type_BulkUpdate", - "operationId": "Type_BulkUpdate" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json index 8a364027401e..d95c0728b9cb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json @@ -5,7 +5,5 @@ }, "responses": { "204": {} - }, - "title": "Type_Delete", - "operationId": "Type_Delete" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json index 34921a8239b7..5790a0df446e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetBusinessMetadataDefByGuid", - "operationId": "Type_GetBusinessMetadataDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json index 64d92fefd723..89abf18c256d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetBusinessMetadataDefByName", - "operationId": "Type_GetBusinessMetadataDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json index e94b5ad8b518..ebd1ed4902de 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetByGuid", - "operationId": "Type_GetByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json index 804029d070e1..77ec05812c26 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json @@ -37,7 +37,5 @@ ] } } - }, - "title": "Type_GetByName", - "operationId": "Type_GetByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json index bf27840af6aa..31f09a6d61e6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json @@ -22,7 +22,5 @@ "subTypes": [] } } - }, - "title": "Type_GetClassificationDefByGuid", - "operationId": "Type_GetClassificationDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json index e7a58bf32bfb..b7d7ed8a4f74 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json @@ -22,7 +22,5 @@ "subTypes": [] } } - }, - "title": "Type_GetClassificationDefByName", - "operationId": "Type_GetClassificationDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json index 9c0d6ce53cb7..2728fb2507c3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json @@ -52,7 +52,5 @@ ] } } - }, - "title": "Type_GetEntityDefByGuid", - "operationId": "Type_GetEntityDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json index 140ba1a5b309..0542db979369 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json @@ -52,7 +52,5 @@ ] } } - }, - "title": "Type_GetEntityDefByName", - "operationId": "Type_GetEntityDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json index ab9e4048b0d2..9c324ce8d35b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json @@ -32,7 +32,5 @@ ] } } - }, - "title": "Type_GetEnumDefByGuid", - "operationId": "Type_GetEnumDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json index 62907f8f6a69..6adfee266b61 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json @@ -32,7 +32,5 @@ ] } } - }, - "title": "Type_GetEnumDefByName", - "operationId": "Type_GetEnumDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json index 71c9a03a65d9..66b6efd3f8bf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json @@ -35,7 +35,5 @@ "relationshipLabel": "r:storm_topology_nodes" } } - }, - "title": "Type_GetRelationshipDefByGuid", - "operationId": "Type_GetRelationshipDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json index ecdafc07a934..148c7d655371 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json @@ -35,7 +35,5 @@ "relationshipLabel": "r:storm_topology_nodes" } } - }, - "title": "Type_GetRelationshipDefByName", - "operationId": "Type_GetRelationshipDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json index c31ae06aeeb6..d2e1e0901f30 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json @@ -42,7 +42,5 @@ ] } } - }, - "title": "Type_GetStructDefByGuid", - "operationId": "Type_GetStructDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json index 26f8e843a6d6..6bffd4888fa2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json @@ -42,7 +42,5 @@ ] } } - }, - "title": "Type_GetStructDefByName", - "operationId": "Type_GetStructDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json index e6c263c691e5..fc5c6208e066 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json @@ -79,7 +79,5 @@ ] } } - }, - "title": "Type_GetTermTemplateDefByGuid", - "operationId": "Type_GetTermTemplateDefByGuid" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json index d8b28d19db05..72f8d97172d8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json @@ -79,7 +79,5 @@ ] } } - }, - "title": "Type_GetTermTemplateDefByName", - "operationId": "Type_GetTermTemplateDefByName" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4f9be7fe0434..4e6b37b8b6f1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -265,7 +265,5 @@ ] } } - }, - "title": "Type_List", - "operationId": "Type_List" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index c4118ef9957a..0c3b2d78f851 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -86,7 +86,5 @@ "relationshipDefs": [] } } - }, - "title": "Type_ListEnumDefs", - "operationId": "Type_List" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json index 288c815d8a88..99ec7d9d00b2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json @@ -23,7 +23,5 @@ } ] } - }, - "title": "Type_ListHeaders", - "operationId": "Type_ListHeaders" + } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index c9a13ccd7758..26902f2461c6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -87,7 +87,5 @@ ] } } - }, - "title": "Type_ListTermTemplateDefs", - "operationId": "Type_List" + } } From 1d705c9dbd410767fba9d84e70943f5b11455507 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:29:58 +0800 Subject: [PATCH 088/132] Delete openapi.json --- .../stable/2023-09-01/openapi.json | 8864 ----------------- 1 file changed, 8864 deletions(-) delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json deleted file mode 100644 index a7bee6134c9d..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ /dev/null @@ -1,8864 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Analytics Purview Data Map", - "version": "2023-09-01", - "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/datamap/api", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "AuthToken": [ - "https://purview.azure.net/.default" - ] - } - ], - "securityDefinitions": { - "AuthToken": { - "type": "oauth2", - "description": "The Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "https://purview.azure.net/.default": "" - } - } - }, - "tags": [], - "paths": { - "/atlas/v2/entity": { - "post": { - "operationId": "Entity_CreateOrUpdate", - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "Ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "Replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "Merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - }, - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" - }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" - } - } - } - }, - "/atlas/v2/entity/bulk": { - "get": { - "operationId": "Entity_ListByGuids", - "description": "List entities in bulk identified by its GUIDs.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to list.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - } - }, - "post": { - "operationId": "Entity_BulkCreateOrUpdate", - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "Ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "Replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "Merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "body", - "in": "body", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "Entity_BulkDelete", - "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to delete.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - } - } - }, - "/atlas/v2/entity/bulk/classification": { - "post": { - "operationId": "Entity_AddClassification", - "description": "Associate a classification to multiple entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The request to associate a classification to multiple entities.", - "required": true, - "schema": { - "$ref": "#/definitions/ClassificationAssociateOptions" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "operationId": "Entity_BulkSetClassifications", - "description": "Set classifications on entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "Atlas entity headers.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" - } - } - } - }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_ListByUniqueAttributes", - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "operationId": "Entity_ImportBusinessMetadata", - "description": "Upload the file for creating Business Metadata in BULK", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "uploadedInputStream", - "in": "formData", - "description": "InputStream of file", - "required": true, - "type": "file" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/BulkImportResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "produces": [ - "application/octet-stream", - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "file" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "operationId": "Entity_Get", - "description": "Get complete definition of an entity given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateAttributeByGuid", - "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The name of the attribute.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The value of the attribute.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" - } - } - }, - "delete": { - "operationId": "Entity_Delete", - "description": "Delete an entity identified by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "description": "Add business metadata to an entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "isOverwrite", - "in": "query", - "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", - "required": false, - "type": "boolean", - "x-ms-client-name": "overwrite" - }, - { - "name": "body", - "in": "body", - "description": "BusinessMetadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadata", - "description": "Remove business metadata from an entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Business metadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "description": "Add or update business metadata attributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "businessMetadataName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "description": "Delete business metadata attributes from an entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "businessMetadataName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { - "get": { - "operationId": "Entity_GetClassification", - "description": "Get classification for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassification" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveClassification", - "description": "Delete a given classification from an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "operationId": "Entity_GetClassifications", - "description": "List classifications for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassifications" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" - } - } - }, - "put": { - "operationId": "Entity_UpdateClassifications", - "description": "Update classifications to an existing entity represented by a guid.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of classifications to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassifications", - "description": "Add classifications to an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of classifications to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "operationId": "Entity_GetHeader", - "description": "Get entity header given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetHeader": { - "$ref": "./examples/Entity_GetHeader.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/labels": { - "put": { - "operationId": "Entity_AddLabel", - "description": "Add given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_AddLabel.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabels", - "description": "Set labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set to the entity", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabels": { - "$ref": "./examples/Entity_SetLabels.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabels", - "description": "Delete given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_RemoveLabels.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_GetByUniqueAttributes", - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateByUniqueAttributes", - "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" - } - } - }, - "delete": { - "operationId": "Entity_DeleteByUniqueAttribute", - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { - "delete": { - "operationId": "Entity_RemoveClassificationByUniqueAttribute", - "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "put": { - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "description": "Update classification on an entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "An array of classification to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "description": "Add classification to the entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "An array of classification to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "put": { - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/glossary": { - "get": { - "operationId": "Glossary_List", - "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossary" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - } - }, - "post": { - "operationId": "Glossary_Create", - "description": "Create a glossary.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}": { - "get": { - "operationId": "Glossary_Get", - "description": "Get a specific Glossary by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } - } - }, - "put": { - "operationId": "Glossary_Update", - "description": "Update the given glossary.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "The glossary definition to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - } - }, - "delete": { - "operationId": "Glossary_Delete", - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/categories": { - "get": { - "operationId": "Glossary_ListCategories", - "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/categories/headers": { - "get": { - "operationId": "Glossary_ListCategoriesHeaders", - "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/detailed": { - "get": { - "operationId": "Glossary_GetDetailed", - "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/partial": { - "put": { - "operationId": "Glossary_PartialUpdate", - "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/terms": { - "get": { - "operationId": "Glossary_ListTerms", - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/terms/headers": { - "get": { - "operationId": "Glossary_ListTermHeaders", - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/categories": { - "post": { - "operationId": "Glossary_CreateCategories", - "description": "Create glossary category in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An array of glossary category definitions to be created.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "operationId": "Glossary_CreateCategory", - "description": "Create a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}": { - "get": { - "operationId": "Glossary_GetCategory", - "description": "Get specific glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateCategory", - "description": "Update the given glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The glossary category to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteCategory", - "description": "Delete a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateCategory", - "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}/related": { - "get": { - "operationId": "Glossary_ListRelatedCategories", - "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}/terms": { - "get": { - "operationId": "Glossary_ListCategoryTerms", - "description": "Get all terms associated with the specific category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - } - } - }, - "/atlas/v2/glossary/term": { - "post": { - "operationId": "Glossary_CreateTerm", - "description": "Create a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termId}": { - "get": { - "operationId": "Glossary_GetTerm", - "description": "Get a specific glossary term by its GUID. ", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" - }, - "Glossary_GetTermWithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateTerm", - "description": "Update the given glossary term by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "The glossary term to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTerm", - "description": "Delete a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termId}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateTerm", - "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" - } - } - } - }, - "/atlas/v2/glossary/terms": { - "post": { - "operationId": "Glossary_CreateTerms", - "description": "Create glossary terms in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "An array of glossary term definitions to be created in bulk.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termId}/assignedEntities": { - "get": { - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - } - }, - "post": { - "operationId": "Glossary_AssignTermToEntities", - "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of related object IDs to which the term has to be associated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTermAssignmentFromEntities", - "description": "Delete the term assignment for the given list of related objects.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of related object IDs from which the term has to be dissociated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termId}/related": { - "get": { - "operationId": "Glossary_ListRelatedTerms", - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "operationId": "Lineage_Get", - "description": "Get lineage info of the entity specified by GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" - } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Lineage_GetByUniqueAttribute", - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/relationship": { - "put": { - "operationId": "Relationship_Update", - "description": "Update an existing relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" - } - } - }, - "post": { - "operationId": "Relationship_Create", - "description": "Create a new relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - } - } - }, - "/atlas/v2/relationship/guid/{guid}": { - "get": { - "operationId": "Relationship_Get", - "description": "Get relationship information between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - }, - { - "name": "extendedInfo", - "in": "query", - "description": "Limits whether includes extended information.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - } - }, - "delete": { - "operationId": "Relationship_Delete", - "description": "Delete a relationship between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByGuid", - "description": "Get the businessMetadata definition for the given guid.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "businessMetadata guid", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByName", - "description": "Get the businessMetadata definition by it's name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "businessMetadata name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/guid/{guid}": { - "get": { - "operationId": "Type_GetClassificationDefByGuid", - "description": "Get the classification definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/name/{name}": { - "get": { - "operationId": "Type_GetClassificationDefByName", - "description": "Get the classification definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - } - } - }, - "/atlas/v2/types/entitydef/guid/{guid}": { - "get": { - "operationId": "Type_GetEntityDefByGuid", - "description": "Get the Entity definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/entitydef/name/{name}": { - "get": { - "operationId": "Type_GetEntityDefByName", - "description": "Get the entity definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByName": { - "$ref": "./examples/Type_GetEntityDefByName.json" - } - } - } - }, - "/atlas/v2/types/enumdef/guid/{guid}": { - "get": { - "operationId": "Type_GetEnumDefByGuid", - "description": "Get the enum definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/enumdef/name/{name}": { - "get": { - "operationId": "Type_GetEnumDefByName", - "description": "Get the enum definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/guid/{guid}": { - "get": { - "operationId": "Type_GetRelationshipDefByGuid", - "description": "Get the relationship definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/name/{name}": { - "get": { - "operationId": "Type_GetRelationshipDefByName", - "description": "Get the relationship definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } - } - } - }, - "/atlas/v2/types/structdef/guid/{guid}": { - "get": { - "operationId": "Type_GetStructDefByGuid", - "description": "Get the struct definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByGuid": { - "$ref": "./examples/Type_GetStructDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/structdef/name/{name}": { - "get": { - "operationId": "Type_GetStructDefByName", - "description": "Get the struct definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - } - } - }, - "/atlas/v2/types/typedef/guid/{guid}": { - "get": { - "operationId": "Type_GetByGuid", - "description": "Get the type definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - } - } - }, - "/atlas/v2/types/typedef/name/{name}": { - "get": { - "operationId": "Type_GetByName", - "description": "Get the type definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - } - }, - "delete": { - "operationId": "Type_Delete", - "description": "Delete API for type identified by its name.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" - } - } - } - }, - "/atlas/v2/types/typedefs": { - "get": { - "operationId": "Type_List", - "description": "List all type definitions in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "TypeDef", - "modelAsString": true, - "values": [ - { - "name": "Enum", - "value": "enum", - "description": "enum" - }, - { - "name": "Entity", - "value": "entity", - "description": "entity" - }, - { - "name": "Classification", - "value": "classification", - "description": "classification" - }, - { - "name": "Relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "Struct", - "value": "struct", - "description": "struct" - }, - { - "name": "TermTemplate", - "value": "term_template", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - } - }, - "put": { - "operationId": "Type_BulkUpdate", - "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "A composite object that captures all type definition changes.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkUpdate": { - "$ref": "./examples/Type_BulkUpdate.json" - } - } - }, - "post": { - "operationId": "Type_BulkCreate", - "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "A composite wrapper object with corresponding lists of the type definition.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" - }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" - } - } - }, - "delete": { - "operationId": "Type_BulkDelete", - "description": "Delete API for all types in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "A composite object that captures all types to be deleted", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - } - } - }, - "/atlas/v2/types/typedefs/headers": { - "get": { - "operationId": "Type_ListHeaders", - "description": "List all type definitions returned as a list of minimal information header.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "TypeDef", - "modelAsString": true, - "values": [ - { - "name": "Enum", - "value": "enum", - "description": "enum" - }, - { - "name": "Entity", - "value": "entity", - "description": "entity" - }, - { - "name": "Classification", - "value": "classification", - "description": "classification" - }, - { - "name": "Relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "Struct", - "value": "struct", - "description": "struct" - }, - { - "name": "TermTemplate", - "value": "term_template", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasTypeDefHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - } - } - }, - "/entity/moveTo": { - "post": { - "operationId": "Entity_MoveEntitiesToCollection", - "description": "Move existing entities to the target collection.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } - } - } - }, - "/lineage/{guid}/next": { - "get": { - "operationId": "Lineage_GetNextPage", - "description": "Return immediate next page lineage info about entity with pagination", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - } - } - }, - "/search/autocomplete": { - "post": { - "operationId": "Discovery_AutoComplete", - "description": "Get auto complete options.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An object specifying the autocomplete criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/AutoCompleteOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AutoCompleteResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - } - } - }, - "/search/query": { - "post": { - "operationId": "Discovery_Query", - "description": "Get data using search.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An object specifying the search criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/QueryOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/QueryResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" - }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" - }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" - }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_TermAssignment": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Type": { - "$ref": "./examples/Discovery_Query_Type.json" - } - } - } - }, - "/search/suggest": { - "post": { - "operationId": "Discovery_Suggest", - "description": "Get search suggestions by query criteria.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An object specifying the suggest criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/SuggestOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/SuggestResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - } - } - }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "operationId": "Type_GetTermTemplateDefByGuid", - "description": "Get the term template definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - } - } - }, - "/types/termtemplatedef/name/{name}": { - "get": { - "operationId": "Type_GetTermTemplateDefByName", - "description": "Get the term template definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The unique name of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" - } - } - } - } - }, - "definitions": { - "ApiVersions": { - "type": "string", - "description": "Service API versions", - "enum": [ - "2023-09-01" - ], - "x-ms-enum": { - "name": "ApiVersions", - "modelAsString": true, - "values": [ - { - "name": "v2023_09_01", - "value": "2023-09-01", - "description": "2023-09-01 service API version" - } - ] - } - }, - "AtlasAttributeDef": { - "type": "object", - "description": "class that captures details of a struct-attribute.", - "properties": { - "cardinality": { - "$ref": "#/definitions/CardinalityValue", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - } - } - }, - "AtlasBaseModelObject": { - "type": "object", - "description": "The base model object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - } - } - }, - "AtlasBaseTypeDef": { - "type": "object", - "description": "Base class that captures common-attributes for all types.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassification": { - "type": "object", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityGuid": { - "type": "string", - "description": "The GUID of the entity." - }, - "entityStatus": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "removePropagationsOnEntityDelete": { - "type": "boolean", - "description": "Determines if propagations will be removed on entity deletion." - }, - "validityPeriods": { - "type": "array", - "description": "An array of time boundaries indicating validity periods.", - "items": { - "$ref": "#/definitions/TimeBoundary" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassificationDef": { - "type": "object", - "description": "class that captures details of a classification-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - } - } - }, - "AtlasClassifications": { - "type": "object", - "description": "REST serialization friendly list.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "AtlasConstraintDef": { - "type": "object", - "description": "class that captures details of a constraint.", - "properties": { - "params": { - "type": "object", - "description": "The parameters of the constraint definition.", - "additionalProperties": {} - }, - "type": { - "type": "string", - "description": "The type of the constraint." - } - } - }, - "AtlasEntitiesWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entities": { - "type": "array", - "description": "An array of entities.", - "items": { - "$ref": "#/definitions/AtlasEntity" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntity": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "businessAttributes": { - "type": "object", - "description": "Business attributes", - "additionalProperties": {} - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "customAttributes": { - "type": "object", - "description": "Custom Attribute", - "additionalProperties": { - "type": "string" - } - }, - "guid": { - "type": "string", - "description": "The GUID of the entity." - }, - "homeId": { - "type": "string", - "description": "The home ID of the entity." - }, - "collectionId": { - "type": "string", - "description": "The collection ID of the entity.", - "readOnly": true - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers indicating the meanings of the entity.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship." - }, - "proxy": { - "type": "boolean", - "description": "Determines if there's a proxy." - }, - "relationshipAttributes": { - "type": "object", - "description": "The attributes of relationship.", - "additionalProperties": {} - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the entity." - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactInfo" - }, - "type": "array" - } - } - } - }, - "AtlasEntityDef": { - "type": "object", - "description": "class that captures details of a entity-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntityExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - } - } - }, - "AtlasEntityHeader": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "classificationNames": { - "type": "array", - "description": "An array of classification names.", - "items": { - "type": "string" - } - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "guid": { - "type": "string", - "description": "The GUID of the record." - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meaningNames": { - "type": "array", - "description": "An array of meanings.", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - } - } - }, - "AtlasEntityHeaders": { - "type": "object", - "description": "An instance of an entity header map.", - "properties": { - "guidHeaderMap": { - "type": "object", - "description": "The description of the guid header map,", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - } - } - }, - "AtlasEntityWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entity": { - "$ref": "#/definitions/AtlasEntity", - "description": "An instance of an entity - like hive_table, hive_database." - } - } - }, - "AtlasEnumDef": { - "type": "object", - "description": "class that captures details of an enum-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEnumElementDef": { - "type": "object", - "description": "class that captures details of an enum-element.", - "properties": { - "description": { - "type": "string", - "description": "The description of the enum element definition." - }, - "ordinal": { - "type": "integer", - "format": "int32", - "description": "The ordinal of the enum element definition." - }, - "value": { - "type": "string", - "description": "The value of the enum element definition." - } - } - }, - "AtlasErrorResponse": { - "type": "object", - "description": "An error response from the service", - "properties": { - "requestId": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The request ID." - }, - "errorCode": { - "type": "string", - "description": "The error code." - }, - "errorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "AtlasExtraTypeDef": { - "type": "object", - "description": "Extra properties for a type.", - "properties": { - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossary": { - "type": "object", - "description": "The glossary object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - } - } - }, - "AtlasGlossaryBaseObject": { - "type": "object", - "description": "The glossary base object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - } - } - }, - "AtlasGlossaryCategory": { - "type": "object", - "description": "The glossary category.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "childrenCategories": { - "type": "array", - "description": "An array of children categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader", - "description": "The header of the related category." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossaryExtInfo": { - "type": "object", - "description": "The extended information of glossary.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - }, - "categoryInfo": { - "type": "object", - "description": "The glossary category information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "termInfo": { - "type": "object", - "description": "The glossary term information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - } - }, - "AtlasGlossaryHeader": { - "type": "object", - "description": "The glossary header with basic information.", - "properties": { - "displayText": { - "type": "string", - "description": "The display text." - }, - "glossaryGuid": { - "type": "string", - "description": "The GUID of the glossary." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasGlossaryTerm": { - "type": "object", - "description": "The glossary term.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "abbreviation": { - "type": "string", - "description": "The abbreviation of the term." - }, - "templateName": { - "type": "array", - "description": "The name of the template.", - "items": {} - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "antonyms": { - "type": "array", - "description": "An array of related term headers as antonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/TermStatus", - "description": "Status of the AtlasGlossaryTerm" - }, - "nickName": { - "type": "string", - "description": "The nick name of the term." - }, - "hierarchyInfo": { - "type": "array", - "description": "The hierarchy information of the term.", - "items": { - "$ref": "#/definitions/PurviewObjectId" - }, - "x-ms-identifiers": [] - }, - "resources": { - "type": "array", - "description": "An array of resource link for term", - "items": { - "$ref": "#/definitions/ResourceLink" - }, - "x-ms-identifiers": [] - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactInfo" - }, - "type": "array" - } - }, - "attributes": { - "type": "object", - "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "assignedEntities": { - "type": "array", - "description": "An array of related object IDs.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - }, - "categories": { - "type": "array", - "description": "An array of term categorization headers.", - "items": { - "$ref": "#/definitions/AtlasTermCategorizationHeader" - }, - "x-ms-identifiers": [] - }, - "classifies": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "examples": { - "type": "array", - "description": "An array of examples.", - "items": { - "type": "string" - } - }, - "isA": { - "type": "array", - "description": "An array of related term headers indicating the is-a relationship.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredTerms": { - "type": "array", - "description": "An array of preferred related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredToTerms": { - "type": "array", - "description": "An array of related term headers that are preferred to.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacedBy": { - "type": "array", - "description": "An array of related term headers that are replaced by.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacementTerms": { - "type": "array", - "description": "An array of related term headers for replacement.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "seeAlso": { - "type": "array", - "description": "An array of related term headers for see also.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "synonyms": { - "type": "array", - "description": "An array of related term headers as synonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translatedTerms": { - "type": "array", - "description": "An array of translated related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translationTerms": { - "type": "array", - "description": "An array of related term headers for translation.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the term." - }, - "validValues": { - "type": "array", - "description": "An array of related term headers as valid values.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "validValuesFor": { - "type": "array", - "description": "An array of related term headers as valid values for other records.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasLineageInfo": { - "type": "object", - "description": "The lineage information.", - "properties": { - "baseEntityGuid": { - "type": "string", - "description": "The GUID of the base entity." - }, - "guidEntityMap": { - "type": "object", - "description": "The GUID entity map.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "widthCounts": { - "type": "object", - "description": "The entity count in specific direction.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "lineageDepth": { - "type": "integer", - "format": "int32", - "description": "The depth of lineage." - }, - "lineageWidth": { - "type": "integer", - "format": "int32", - "description": "The width of lineage." - }, - "childrenCount": { - "type": "integer", - "format": "int32", - "description": "The number of children node." - }, - "lineageDirection": { - "$ref": "#/definitions/LineageDirection", - "description": "The enum of lineage direction." - }, - "parentRelations": { - "type": "array", - "description": "An array of parentRelations relations.", - "items": { - "$ref": "#/definitions/ParentRelation" - }, - "x-ms-identifiers": [] - }, - "relations": { - "type": "array", - "description": "An array of lineage relations.", - "items": { - "$ref": "#/definitions/LineageRelation" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasObjectId": { - "type": "object", - "description": "Reference to an object-instance of a type - like entity.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - } - } - }, - "AtlasRelatedCategoryHeader": { - "type": "object", - "description": "The header of the related category.", - "properties": { - "categoryGuid": { - "type": "string", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the category header." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "parentCategoryGuid": { - "type": "string", - "description": "The GUID of the parent category." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasRelatedObjectId": { - "type": "object", - "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "entityStatus": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "relationshipType": { - "type": "string", - "description": "Relationship type" - }, - "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." - }, - "relationshipGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the relationship." - }, - "relationshipStatus": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - } - } - }, - "AtlasRelatedTermHeader": { - "type": "object", - "description": "The header of the related term.", - "properties": { - "description": { - "type": "string", - "description": "The description of the related term." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "expression": { - "type": "string", - "description": "The expression of the term." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus", - "description": "The status of term relationship." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." - } - } - }, - "AtlasRelationship": { - "type": "object", - "description": "Atlas relationship instance.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "end1": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "end2": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "guid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "homeId": { - "type": "string", - "description": "The home ID of the relationship." - }, - "label": { - "type": "string", - "description": "The label of the relationship." - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship" - }, - "status": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the relationship." - } - } - }, - "AtlasRelationshipAttributeDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/CardinalityValue", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - }, - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." - }, - "relationshipTypeName": { - "type": "string", - "description": "The name of the relationship type." - } - } - }, - "AtlasRelationshipDef": { - "type": "object", - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - } - } - }, - "AtlasRelationshipEndDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/CardinalityValue", - "description": "single-valued attribute or multi-valued attribute." - }, - "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." - } - } - }, - "AtlasRelationshipWithExtInfo": { - "type": "object", - "description": "The relationship with extended information.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entity header.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "relationship": { - "$ref": "#/definitions/AtlasRelationship", - "description": "Atlas relationship instance." - } - } - }, - "AtlasStruct": { - "type": "object", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasStructDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTermAssignmentHeader": { - "type": "object", - "description": "The header for term assignment.", - "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": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermAssignmentStatus", - "description": "The status of terms assignment." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the term." - } - } - }, - "AtlasTermAssignmentStatus": { - "type": "string", - "description": "Status for term assignment", - "enum": [ - "DISCOVERED", - "PROPOSED", - "IMPORTED", - "VALIDATED", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermAssignmentStatus", - "modelAsString": true, - "values": [ - { - "name": "Discovered", - "value": "DISCOVERED", - "description": "The status is discovered." - }, - { - "name": "Proposed", - "value": "PROPOSED", - "description": "The status is proposed." - }, - { - "name": "Imported", - "value": "IMPORTED", - "description": "The status is imported." - }, - { - "name": "Validated", - "value": "VALIDATED", - "description": "The status is validated." - }, - { - "name": "Deprecated", - "value": "DEPRECATED", - "description": "The status is deprecated." - }, - { - "name": "Obsolete", - "value": "OBSOLETE", - "description": "The status is obsolete." - }, - { - "name": "Other", - "value": "OTHER", - "description": "Other status." - } - ] - } - }, - "AtlasTermCategorizationHeader": { - "type": "object", - "description": "The basic information for term categorization.", - "properties": { - "categoryGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the record." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "relationGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus", - "description": "The status of term relationship." - } - } - }, - "AtlasTermRelationshipStatus": { - "type": "string", - "description": "Status for atlas term relationship", - "enum": [ - "DRAFT", - "ACTIVE", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermRelationshipStatus", - "modelAsString": true, - "values": [ - { - "name": "Draft", - "value": "DRAFT", - "description": "draft" - }, - { - "name": "Active", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "Deprecated", - "value": "DEPRECATED", - "description": "deprecated" - }, - { - "name": "Obsolete", - "value": "OBSOLETE", - "description": "obsolete" - }, - { - "name": "Other", - "value": "OTHER", - "description": "other" - } - ] - } - }, - "AtlasTypeDef": { - "type": "object", - "description": "The definitions of type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTypeDefHeader": { - "type": "object", - "description": "The basic information of the type definition.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - } - } - }, - "AtlasTypesDef": { - "type": "object", - "description": "The definitions of types.", - "properties": { - "businessMetadataDefs": { - "type": "array", - "description": "businessMetadataDefs", - "items": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - }, - "x-ms-identifiers": [] - }, - "classificationDefs": { - "type": "array", - "description": "An array of classification definitions.", - "items": { - "$ref": "#/definitions/AtlasClassificationDef" - }, - "x-ms-identifiers": [] - }, - "entityDefs": { - "type": "array", - "description": "An array of entity definitions.", - "items": { - "$ref": "#/definitions/AtlasEntityDef" - }, - "x-ms-identifiers": [] - }, - "enumDefs": { - "type": "array", - "description": "An array of enum definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumDef" - }, - "x-ms-identifiers": [] - }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" - }, - "x-ms-identifiers": [] - }, - "structDefs": { - "type": "array", - "description": "An array of struct definitions.", - "items": { - "$ref": "#/definitions/AtlasStructDef" - }, - "x-ms-identifiers": [] - }, - "termTemplateDefs": { - "type": "array", - "description": "An array of term template definitions.", - "items": { - "$ref": "#/definitions/TermTemplateDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AuthToken": { - "type": "object", - "description": "The Azure Active Directory OAuth2 Flow", - "properties": { - "type": { - "type": "string", - "description": "OAuth2 authentication", - "enum": [ - "oauth2" - ] - }, - "flows": { - "type": "array", - "description": "Supported OAuth2 flows", - "items": {} - } - }, - "required": [ - "type", - "flows" - ] - }, - "AutoCompleteOptions": { - "type": "object", - "description": "The query of autocomplete request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the autocomplete request." - } - } - }, - "AutoCompleteResult": { - "type": "object", - "description": "The result of the autocomplete request.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/AutoCompleteResultValue" - }, - "x-ms-identifiers": [] - } - } - }, - "AutoCompleteResultValue": { - "type": "object", - "description": "The value item of the autocomplete suggest.", - "properties": { - "text": { - "type": "string", - "description": "The completed term or phrase." - }, - "queryPlusText": { - "type": "string", - "description": "The completed search query text." - } - } - }, - "Azure.Core.uuid": { - "type": "string", - "format": "uuid", - "description": "Universally Unique Identifier" - }, - "BulkImportResult": { - "type": "object", - "description": "Bulk import result", - "properties": { - "failedImportInfoList": { - "type": "array", - "description": "failed importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - }, - "successImportInfoList": { - "type": "array", - "description": "successful importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - } - } - }, - "BusinessAttributeUpdateBehavior": { - "type": "string", - "description": "Enum for business attribute update behavior", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "Ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "Replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "Merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - "CardinalityValue": { - "type": "string", - "description": "Cardinality", - "enum": [ - "SINGLE", - "LIST", - "SET" - ], - "x-ms-enum": { - "name": "CardinalityValue", - "modelAsString": true, - "values": [ - { - "name": "Single", - "value": "SINGLE", - "description": "single" - }, - { - "name": "List", - "value": "LIST", - "description": "list" - }, - { - "name": "Set", - "value": "SET", - "description": "set" - } - ] - } - }, - "ClassificationAssociateOptions": { - "type": "object", - "description": "The request content for classification association.", - "properties": { - "classification": { - "$ref": "#/definitions/AtlasClassification", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." - }, - "entityGuids": { - "type": "array", - "description": "The GUID of the entity.", - "items": { - "type": "string" - } - } - } - }, - "ContactInfo": { - "type": "object", - "description": "ContactInfo", - "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." - } - } - }, - "ContactSearchResultValue": { - "type": "object", - "description": "The contact in the search and suggest result.", - "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\nExpert or Steward for a glossary term." - } - } - }, - "DateFormat": { - "type": "object", - "description": "The date format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "An array of available locales.", - "items": { - "type": "string" - } - }, - "calendar": { - "type": "number", - "format": "float", - "description": "Calendar" - }, - "dateInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "dateTimeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "instance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "lenient": { - "type": "boolean", - "description": "Determines the leniency of the date format." - }, - "numberFormat": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "timeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "timeZone": { - "$ref": "#/definitions/TimeZone", - "description": "The timezone information." - } - } - }, - "EntityMutationResult": { - "type": "object", - "description": "The mutation response result of entity.", - "properties": { - "guidAssignments": { - "type": "object", - "description": "A map of GUID assignments with entities.", - "additionalProperties": { - "type": "string" - } - }, - "mutatedEntities": { - "type": "object", - "description": "The entity headers of mutated entities.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - }, - "partialUpdatedEntities": { - "type": "array", - "description": "An array of entity headers that partially updated.", - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "EntityStatus": { - "type": "string", - "description": "Status - can be active or deleted", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "EntityStatus", - "modelAsString": true, - "values": [ - { - "name": "Active", - "value": "ACTIVE", - "description": "The status is active." - }, - { - "name": "Deleted", - "value": "DELETED", - "description": "The status is deleted." - } - ] - } - }, - "FilterOperator": { - "type": "string", - "description": "Search Filter Operator", - "enum": [ - "eq", - "ne", - "gt", - "lt", - "ge", - "le", - "contains", - "startswith", - "prefix", - "timerange", - "exists" - ], - "x-ms-enum": { - "name": "FilterOperator", - "modelAsString": true, - "values": [ - { - "name": "eq", - "value": "eq", - "description": "equal" - }, - { - "name": "ne", - "value": "ne", - "description": "not equal" - }, - { - "name": "gt", - "value": "gt", - "description": "greater than" - }, - { - "name": "lt", - "value": "lt", - "description": "less than" - }, - { - "name": "ge", - "value": "ge", - "description": "greater than or equal to" - }, - { - "name": "le", - "value": "le", - "description": "less than or equal to" - }, - { - "name": "contains", - "value": "contains", - "description": "contains" - }, - { - "name": "startswith", - "value": "startswith", - "description": "start with" - }, - { - "name": "prefix", - "value": "prefix", - "description": "prefix" - }, - { - "name": "timerange", - "value": "timerange", - "description": "time range" - }, - { - "name": "exists", - "value": "exists", - "description": "exists" - } - ] - } - }, - "ImportInfo": { - "type": "object", - "description": "ImportInfo", - "properties": { - "childObjectName": { - "type": "string", - "description": "childObjectName" - }, - "importStatus": { - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" - }, - "parentObjectName": { - "type": "string", - "description": "parentObjectName" - }, - "remarks": { - "type": "string", - "description": "remarks" - } - } - }, - "ImportStatus": { - "type": "string", - "description": "Status for import", - "enum": [ - "SUCCESS", - "FAILED" - ], - "x-ms-enum": { - "name": "ImportStatus", - "modelAsString": true, - "values": [ - { - "name": "Success", - "value": "SUCCESS", - "description": "Success" - }, - { - "name": "Failed", - "value": "FAILED", - "description": "Failed" - } - ] - } - }, - "LineageDirection": { - "type": "string", - "description": "Lineage direction", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - }, - "LineageRelation": { - "type": "object", - "description": "The lineage relation with GUID of the from and to entity.", - "properties": { - "fromEntityId": { - "type": "string", - "description": "The GUID of from-entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "toEntityId": { - "type": "string", - "description": "The GUID of to-entity." - } - } - }, - "MoveEntitiesOptions": { - "type": "object", - "description": "MoveEntitiesContent", - "properties": { - "entityGuids": { - "type": "array", - "description": "An array of entity guids to be moved to target collection.", - "items": { - "type": "string" - } - } - } - }, - "NumberFormat": { - "type": "object", - "description": "The number format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "The number format.", - "items": { - "type": "string" - } - }, - "currency": { - "type": "string", - "description": "The currency." - }, - "currencyInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "groupingUsed": { - "type": "boolean", - "description": "Determines if grouping is used." - }, - "instance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "integerInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "maximumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of fraction digits." - }, - "maximumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of integer digits." - }, - "minimumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of fraction digits." - }, - "minimumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of integer digits." - }, - "numberInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "parseIntegerOnly": { - "type": "boolean", - "description": "Determines if only integer is parsed." - }, - "percentInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "roundingMode": { - "$ref": "#/definitions/RoundingMode", - "description": "The enum of rounding mode." - } - } - }, - "PList": { - "type": "object", - "description": "Paginated-list, for returning search results.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "ParentRelation": { - "type": "object", - "description": "The lineage parents relation with GUID of the parent entity and to child entity.", - "properties": { - "childEntityId": { - "type": "string", - "description": "The GUID of child entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "parentEntityId": { - "type": "string", - "description": "The GUID of parent entity." - } - } - }, - "PurviewObjectId": { - "type": "object", - "description": "PurviewObjectId", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "name": { - "type": "string", - "description": "Name" - }, - "displayText": { - "type": "string", - "description": "Display text" - }, - "itemPath": { - "type": "string", - "description": "Item path" - }, - "resourceId": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "type": "object", - "description": "Dictionary of ", - "additionalProperties": {} - } - } - }, - "QueryOptions": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, - "QueryResult": { - "type": "object", - "description": "The result of the search result.", - "properties": { - "@search.count": { - "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single\npage).", - "x-ms-client-name": "searchCount" - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa.", - "x-ms-client-name": "searchCountApproximate" - }, - "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", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "x-ms-client-name": "searchFacets" - }, - "value": { - "type": "array", - "description": "Search result value", - "items": { - "$ref": "#/definitions/SearchResultValue" - } - } - } - }, - "RelationshipCategory": { - "type": "string", - "description": "Relationship Category", - "enum": [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "x-ms-enum": { - "name": "RelationshipCategory", - "modelAsString": true, - "values": [ - { - "name": "Association", - "value": "ASSOCIATION", - "description": "association" - }, - { - "name": "Aggregation", - "value": "AGGREGATION", - "description": "aggregation" - }, - { - "name": "Composition", - "value": "COMPOSITION", - "description": "composition" - } - ] - } - }, - "ResourceLink": { - "type": "object", - "description": "ResourceLink", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." - }, - "url": { - "type": "string", - "description": "web url. http or https" - } - } - }, - "RoundingMode": { - "type": "string", - "description": "Rounding Mode", - "enum": [ - "UP", - "DOWN", - "CEILING", - "FLOOR", - "HALF_UP", - "HALF_DOWN", - "HALF_EVEN", - "UNNECESSARY" - ], - "x-ms-enum": { - "name": "RoundingMode", - "modelAsString": true, - "values": [ - { - "name": "Up", - "value": "UP", - "description": "up" - }, - { - "name": "Down", - "value": "DOWN", - "description": "down" - }, - { - "name": "Ceiling", - "value": "CEILING", - "description": "ceiling" - }, - { - "name": "Floor", - "value": "FLOOR", - "description": "floor" - }, - { - "name": "HalfUp", - "value": "HALF_UP", - "description": "half up" - }, - { - "name": "HalfDown", - "value": "HALF_DOWN", - "description": "half down" - }, - { - "name": "HalfEven", - "value": "HALF_EVEN", - "description": "half even" - }, - { - "name": "Unnecessary", - "value": "UNNECESSARY", - "description": "unnecessary" - } - ] - } - }, - "SearchFacetItem": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "facet": { - "type": "string", - "description": "The name of the facet item." - }, - "sort": { - "$ref": "#/definitions/SearchFacetSort", - "description": "Define the sorting criteria for items" - } - } - }, - "SearchFacetItemValue": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "value": { - "type": "string", - "description": "The name of the facet item." - } - } - }, - "SearchFacetResultValue": { - "type": "object", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "properties": { - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "assetType": { - "type": "array", - "description": "Asset type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "classification": { - "type": "array", - "description": "Classification", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "term": { - "type": "array", - "description": "Term", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactId": { - "type": "array", - "description": "Contact id", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactType": { - "type": "array", - "description": "Contact type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "label": { - "type": "array", - "description": "Label", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "glossaryType": { - "type": "array", - "description": "Glossary type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termStatus": { - "type": "array", - "description": "Term status", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termTemplate": { - "type": "array", - "description": "Term template", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - } - } - }, - "SearchFacetSort": { - "type": "object", - "description": "The sorting criteria", - "properties": { - "count": { - "$ref": "#/definitions/SearchSortOrder", - "description": "Order by count" - }, - "value": { - "$ref": "#/definitions/SearchSortOrder", - "description": "Order by value" - } - } - }, - "SearchHighlights": { - "type": "object", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "properties": { - "id": { - "type": "array", - "description": "Id", - "items": { - "type": "string" - } - }, - "qualifiedName": { - "type": "array", - "description": "Qualified name", - "items": { - "type": "string" - } - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "type": "string" - } - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "type": "string" - } - }, - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "type": "string" - } - } - } - }, - "SearchResultValue": { - "type": "object", - "description": "The value item of the search result.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.highlights": { - "$ref": "#/definitions/SearchHighlights", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "x-ms-client-name": "searchHighlights" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "SearchSortOrder": { - "type": "string", - "description": "Search sort order", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "SearchSortOrder", - "modelAsString": true, - "values": [ - { - "name": "Ascend", - "value": "asc", - "description": "Use ascending order for sorting" - }, - { - "name": "Descend", - "value": "desc", - "description": "Use descending order for sorting" - } - ] - } - }, - "SearchTaxonomySetting": { - "type": "object", - "description": "Taxonomy setting for search request", - "properties": { - "assetTypes": { - "type": "array", - "description": "Asset types", - "items": { - "type": "string" - } - }, - "facet": { - "$ref": "#/definitions/SearchFacetItem", - "description": "The content of a search facet result item." - } - } - }, - "SortType": { - "type": "string", - "description": "Type for sorting", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "SortType", - "modelAsString": true, - "values": [ - { - "name": "None", - "value": "NONE", - "description": "No sorting order" - }, - { - "name": "Ascend", - "value": "ASC", - "description": "Use ascending order for sorting" - }, - { - "name": "Descend", - "value": "DESC", - "description": "Use descending order for sorting" - } - ] - } - }, - "StatusAtlasRelationship": { - "type": "string", - "description": "Status for atlas relationship", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "StatusAtlasRelationship", - "modelAsString": true, - "values": [ - { - "name": "Active", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "Deleted", - "value": "DELETED", - "description": "deleted" - } - ] - } - }, - "SuggestOptions": { - "type": "object", - "description": "The query of suggest request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the search." - } - } - }, - "SuggestResult": { - "type": "object", - "description": "The result item of the search suggest.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/SuggestResultValue" - } - } - } - }, - "SuggestResultValue": { - "type": "object", - "description": "The value item of the search suggest.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.text": { - "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", - "x-ms-client-name": "searchText" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "TermSearchResultValue": { - "type": "object", - "description": "The context.", - "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." - } - } - }, - "TermStatus": { - "type": "string", - "description": "Status for term", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true, - "values": [ - { - "name": "Draft", - "value": "Draft", - "description": "draft" - }, - { - "name": "Approved", - "value": "Approved", - "description": "approved" - }, - { - "name": "Alert", - "value": "Alert", - "description": "alert" - }, - { - "name": "Expired", - "value": "Expired", - "description": "expired" - } - ] - } - }, - "TermTemplateDef": { - "type": "object", - "description": "Term template definition for glossary term.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "int64", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "int64", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "TimeBoundary": { - "type": "object", - "description": "Captures time-boundary details", - "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." - } - } - }, - "TimeZone": { - "type": "object", - "description": "The timezone information.", - "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", - "description": "The timezone information." - }, - "displayName": { - "type": "string", - "description": "The display name of the timezone." - }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." - } - } - }, - "TypeCategory": { - "type": "string", - "description": "Type Category", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true, - "values": [ - { - "name": "Primitive", - "value": "PRIMITIVE", - "description": "primitive" - }, - { - "name": "ObjectIdType", - "value": "OBJECT_ID_TYPE", - "description": "object id type" - }, - { - "name": "Enum", - "value": "ENUM", - "description": "enum" - }, - { - "name": "Struct", - "value": "STRUCT", - "description": "struct" - }, - { - "name": "Classification", - "value": "CLASSIFICATION", - "description": "classification" - }, - { - "name": "Entity", - "value": "ENTITY", - "description": "entity" - }, - { - "name": "Array", - "value": "ARRAY", - "description": "array" - }, - { - "name": "Map", - "value": "MAP", - "description": "map" - }, - { - "name": "Relationship", - "value": "RELATIONSHIP", - "description": "relationship" - }, - { - "name": "TermTemplate", - "value": "TERM_TEMPLATE", - "description": "term template" - } - ] - } - }, - "TypeDef": { - "type": "string", - "description": "Type", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "TypeDef", - "modelAsString": true, - "values": [ - { - "name": "Enum", - "value": "enum", - "description": "enum" - }, - { - "name": "Entity", - "value": "entity", - "description": "entity" - }, - { - "name": "Classification", - "value": "classification", - "description": "classification" - }, - { - "name": "Relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "Struct", - "value": "struct", - "description": "struct" - }, - { - "name": "TermTemplate", - "value": "term_template", - "description": "term template" - } - ] - } - } - }, - "parameters": { - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - } - } -} From a75674d18325393ddf22fb5063acdfdb1d75bae2 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:39:06 +0800 Subject: [PATCH 089/132] fix typeSpec validation error --- .../examples/2023-09-01/Discovery_Query.json | 1 - .../examples/Discovery_AutoComplete.json | 6 +- .../2023-09-01/examples/Discovery_Query.json | 6 +- .../examples/Discovery_Query_And.json | 6 +- .../examples/Discovery_Query_AndOrNested.json | 6 +- .../examples/Discovery_Query_AssetType.json | 6 +- .../examples/Discovery_Query_Attribute.json | 6 +- ...overy_Query_BusinessMetadataAttribute.json | 6 +- .../Discovery_Query_Classification.json | 6 +- .../examples/Discovery_Query_Collection.json | 6 +- .../examples/Discovery_Query_Facet.json | 6 +- .../Discovery_Query_FileExtension.json | 6 +- .../Discovery_Query_GlossaryTerm.json | 6 +- .../examples/Discovery_Query_Id.json | 6 +- .../examples/Discovery_Query_Not.json | 6 +- .../examples/Discovery_Query_ObjectType.json | 6 +- ...very_Query_PaginationContinuationPage.json | 6 +- .../Discovery_Query_PaginationFirstPage.json | 6 +- .../Discovery_Query_PaginationLastPage.json | 6 +- .../examples/Discovery_Query_SystemTime.json | 6 +- .../examples/Discovery_Query_Taxonomy.json | 6 +- .../Discovery_Query_TermAssignment.json | 6 +- .../examples/Discovery_Query_Type.json | 6 +- .../examples/Discovery_Suggest.json | 6 +- ...tity_AddClassificationToEntityByGuids.json | 6 +- .../examples/Entity_AddClassifications.json | 6 +- ...y_AddClassificationsByUniqueAttribute.json | 6 +- .../examples/Entity_AddCustomAttribute.json | 7 +- .../Entity_AddLabelsByUniqueAttribute.json | 4 +- .../Entity_AddOrUpdate_BusinessAttribute.json | 6 +- .../examples/Entity_BulkCreateOrUpdate.json | 6 +- .../examples/Entity_BulkDelete.json | 4 +- .../Entity_BulkSetClassifications.json | 6 +- .../2023-09-01/examples/Entity_Create.json | 7 +- .../2023-09-01/examples/Entity_Delete.json | 4 +- .../Entity_DeleteByUniqueAttribute.json | 4 +- .../2023-09-01/examples/Entity_Get.json | 4 +- .../Entity_GetByUniqueAttributes.json | 4 +- .../examples/Entity_GetClassification.json | 4 +- .../examples/Entity_GetClassifications.json | 4 +- .../2023-09-01/examples/Entity_GetHeader.json | 4 +- ...ity_GetSampleBusinessMetadataTemplate.json | 7 +- .../Entity_ImportBusinessMetadata.json | 6 +- .../examples/Entity_ListByGuids.json | 4 +- .../Entity_ListByUniqueAttributes.json | 4 +- .../Entity_MoveEntitiesToCollection.json | 6 +- .../Entity_PartialUpdateAttributeByGuid.json | 4 +- ...ntity_PartialUpdateByUniqueAttributes.json | 10 +- .../Entity_RemoveBusinessAttribute.json | 6 +- .../Entity_RemoveBusinessMetadata.json | 4 +- .../examples/Entity_RemoveClassification.json | 4 +- ...RemoveClassificationByUniqueAttribute.json | 4 +- .../Entity_RemoveLabelsByUniqueAttribute.json | 4 +- .../Entity_SetLabelsByUniqueAttribute.json | 4 +- .../2023-09-01/examples/Entity_Update.json | 7 +- .../Entity_UpdateClassifications.json | 6 +- ...pdateClassificationsByUniqueAttribute.json | 6 +- .../Glossary_AssignTermToEntities.json | 8 +- .../2023-09-01/examples/Glossary_Create.json | 6 +- .../examples/Glossary_CreateCategories.json | 6 +- .../examples/Glossary_CreateCategory.json | 6 +- .../examples/Glossary_CreateTerm.json | 6 +- .../Glossary_CreateTermWithTemplate.json | 6 +- .../examples/Glossary_CreateTerms.json | 6 +- .../2023-09-01/examples/Glossary_Delete.json | 6 +- .../examples/Glossary_DeleteCategory.json | 6 +- .../examples/Glossary_DeleteTerm.json | 6 +- .../2023-09-01/examples/Glossary_Get.json | 6 +- .../examples/Glossary_GetCategory.json | 6 +- .../examples/Glossary_GetDetailed.json | 6 +- .../2023-09-01/examples/Glossary_GetTerm.json | 6 +- .../Glossary_GetTermWithoutAssets.json | 6 +- .../2023-09-01/examples/Glossary_List.json | 4 +- .../examples/Glossary_ListCategories.json | 6 +- .../Glossary_ListCategoriesHeaders.json | 6 +- .../examples/Glossary_ListCategoryTerms.json | 6 +- ...Glossary_ListEntitiesAssignedWithTerm.json | 6 +- .../Glossary_ListRelatedCategories.json | 6 +- .../examples/Glossary_ListRelatedTerms.json | 6 +- .../examples/Glossary_ListTermHeaders.json | 6 +- .../examples/Glossary_ListTerms.json | 6 +- .../examples/Glossary_PartialUpdate.json | 8 +- .../Glossary_PartialUpdateCategory.json | 8 +- .../examples/Glossary_PartialUpdateTerm.json | 10 +- ...sary_RemoveTermAssignmentFromEntities.json | 8 +- .../2023-09-01/examples/Glossary_Update.json | 8 +- .../examples/Glossary_UpdateCategory.json | 8 +- .../examples/Glossary_UpdateTerm.json | 8 +- .../2023-09-01/examples/Lineage_Get.json | 4 +- .../Lineage_GetByUniqueAttribute.json | 4 +- .../examples/Lineage_GetNextPage.json | 4 +- .../examples/Relationship_Create.json | 6 +- .../examples/Relationship_Delete.json | 4 +- .../2023-09-01/examples/Relationship_Get.json | 4 +- .../examples/Relationship_Update.json | 6 +- .../2023-09-01/examples/Type_BulkCreate.json | 6 +- .../Type_BulkCreateBusinessMetadataDefs.json | 6 +- .../2023-09-01/examples/Type_BulkDelete.json | 6 +- .../2023-09-01/examples/Type_BulkUpdate.json | 6 +- .../2023-09-01/examples/Type_Delete.json | 4 +- .../Type_GetBusinessMetadataDefByGuid.json | 4 +- .../Type_GetBusinessMetadataDefByName.json | 4 +- .../2023-09-01/examples/Type_GetByGuid.json | 4 +- .../2023-09-01/examples/Type_GetByName.json | 4 +- .../Type_GetClassificationDefByGuid.json | 4 +- .../Type_GetClassificationDefByName.json | 4 +- .../examples/Type_GetEntityDefByGuid.json | 4 +- .../examples/Type_GetEntityDefByName.json | 4 +- .../examples/Type_GetEnumDefByGuid.json | 4 +- .../examples/Type_GetEnumDefByName.json | 4 +- .../Type_GetRelationshipDefByGuid.json | 4 +- .../Type_GetRelationshipDefByName.json | 4 +- .../examples/Type_GetStructDefByGuid.json | 4 +- .../examples/Type_GetStructDefByName.json | 4 +- .../Type_GetTermTemplateDefByGuid.json | 4 +- .../Type_GetTermTemplateDefByName.json | 4 +- .../stable/2023-09-01/examples/Type_List.json | 4 +- .../examples/Type_ListEnumDefs.json | 4 +- .../2023-09-01/examples/Type_ListHeaders.json | 4 +- .../examples/Type_ListTermTemplateDefs.json | 4 +- .../stable/2023-09-01/openapi.json | 8864 +++++++++++++++++ 121 files changed, 9311 insertions(+), 206 deletions(-) create mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json index 28c2961eee1f..a7cde65a400e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Discovery_Query.json @@ -4,7 +4,6 @@ "body": { "keywords": "exampledata", "filter": { - "kind": "AndFilter", "and": [ { "objectType": "Files" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json index 6f9992091ded..b2f2665d5b36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_AutoComplete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "autoCompleteRequest": { + "body": { "keywords": "exa", "filter": { "and": [ @@ -34,5 +34,7 @@ ] } } - } + }, + "title": "Discovery_AutoComplete", + "operationId": "Discovery_AutoComplete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json index 01a3c24a0366..a7cde65a400e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -103,5 +103,7 @@ ] } } - } + }, + "title": "Discovery_Query", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json index 510076af8094..a1f45773a687 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_And.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -74,5 +74,7 @@ ] } } - } + }, + "title": "Discovery_Query_And", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json index a18f77f11ea4..7ec39b19f500 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AndOrNested.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_AndOrNested", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json index 6f134d2cbc92..deb289d5ea22 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_AssetType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -134,5 +134,7 @@ ] } } - } + }, + "title": "Discovery_Query_AssetType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json index 33e68dd2cc70..6d2ccf524020 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Attribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -91,5 +91,7 @@ ] } } - } + }, + "title": "Discovery_Query_Attribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json index 49a647d73822..2ab33726a034 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_BusinessMetadataAttribute.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -48,5 +48,7 @@ ] } } - } + }, + "title": "Discovery_Query_BusinessMetadataAttribute", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json index 1652e3eb3967..5150545e7d0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Classification.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -63,5 +63,7 @@ ] } } - } + }, + "title": "Discovery_Query_Classification", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json index 8d51d3b6a9c9..3779d9d497fe 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Collection.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -62,5 +62,7 @@ ] } } - } + }, + "title": "Discovery_Query_Collection", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json index d68b074a230f..b417487bea7d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Facet.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "filter": { "objectType": "Tables" @@ -144,5 +144,7 @@ ] } } - } + }, + "title": "Discovery_Query_Facet", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json index 9c2aed22a521..0b7fee10f958 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_FileExtension.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Discovery_Query_FileExtension", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json index 15d04904849c..1af1169192d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_GlossaryTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "", "limit": 10, "filter": { @@ -90,5 +90,7 @@ } } } - } + }, + "title": "Discovery_Query_GlossaryTerm", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json index a239b38b5c50..1a983534fbce 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Id.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Discovery_Query_Id", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json index 004b8283ffc2..4c6b90d682c4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Not.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Query_Not", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json index 1e48cd2210b5..f332749b05ee 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_ObjectType.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -69,5 +69,7 @@ ] } } - } + }, + "title": "Discovery_Query_ObjectType", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json index 99220e6552d4..cbe86e93e8fa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationContinuationPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -105,5 +105,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationContinuationPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json index 9de3ad93b2b7..fe5522da8ebf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationFirstPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationFirstPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json index 7320000e5082..4e64dd33405e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_PaginationLastPage.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -104,5 +104,7 @@ ] } } - } + }, + "title": "Discovery_Query_PaginationLastPage", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json index bde144d66d3f..d2196fa7ea91 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_SystemTime.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -49,5 +49,7 @@ ] } } - } + }, + "title": "Discovery_Query_SystemTime", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json index 6b05a5985854..f2f278e5c48b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Taxonomy.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Discovery_Query_Taxonomy", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json index 576c69a243c5..0c24709432b3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_TermAssignment.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": "", "limit": 3, "filter": { @@ -53,5 +53,7 @@ ] } } - } + }, + "title": "Discovery_Query_TermAssignment", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json index f78c96dd68ac..48480e13fc17 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Query_Type.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "searchRequest": { + "body": { "keywords": null, "limit": 10, "filter": { @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Discovery_Query_Type", + "operationId": "Discovery_Query" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json index f0886ed0c690..3ff80bee52ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Discovery_Suggest.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "suggestRequest": { + "body": { "keywords": "exampledata", "filter": { "and": [ @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Discovery_Suggest", + "operationId": "Discovery_Suggest" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json index c955f4586918..b94ab95331ec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationToEntityByGuids.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "request": { + "body": { "classification": { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "attributes": {}, @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationToEntityByGuids", + "operationId": "Entity_AddClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json index 6aa11763de71..5ab64b05faac 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", "entityGuid": "cc0730ba-9b30-41f0-6953-559d17626d2b" @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassifications", + "operationId": "Entity_AddClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json index e82bbe57a2f3..0a724e78e134 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddClassificationsByUniqueAttribute", + "operationId": "Entity_AddClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json index 5fafde7ea05e..5e50da3bc1c7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddCustomAttribute.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -51,5 +52,7 @@ } } } - } + }, + "title": "Entity_AddCustomAttribute", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json index 8d60d206619e..3a2bc5a3f537 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_AddLabelsByUniqueAttribute", + "operationId": "Entity_AddLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json index 6335668124ae..f91a2897c1e2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_AddOrUpdate_BusinessAttribute.json @@ -2,12 +2,14 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - } + }, + "title": "Entity_AddOrUpdate_BusinessAttribute", + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json index 779992eff9ba..81eb02f76d2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkCreateOrUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entities": { + "body": { "referredEntities": {}, "entities": [ { @@ -100,5 +100,7 @@ } } } - } + }, + "title": "Entity_BulkCreateOrUpdate", + "operationId": "Entity_BulkCreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json index 067d745f66c1..3b8c27b9b5fc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkDelete.json @@ -31,5 +31,7 @@ } } } - } + }, + "title": "Entity_BulkDelete", + "operationId": "Entity_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json index 907bbe9c1e97..ceac402f49a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_BulkSetClassifications.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entityHeaders": { + "body": { "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { @@ -35,5 +35,7 @@ "Update:7fcc43ab-55ea-45d4-9971-ce0443cb10bb:azure_storage_account:qualifiedName -> MICROSOFT.PERSONAL.IPADDRESS:(Done)" ] } - } + }, + "title": "Entity_BulkSetClassifications", + "operationId": "Entity_BulkSetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json index b4946962b191..cf8647830754 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Create.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -56,5 +57,7 @@ } } } - } + }, + "title": "Entity_Create", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json index 029021e09916..9e6ab2104d44 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Delete.json @@ -23,5 +23,7 @@ } } } - } + }, + "title": "Entity_Delete", + "operationId": "Entity_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json index 34948b6504ab..3df1ba7cee96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_DeleteByUniqueAttribute.json @@ -29,5 +29,7 @@ } } } - } + }, + "title": "Entity_DeleteByUniqueAttribute", + "operationId": "Entity_DeleteByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 918d06e41adc..2acf46b04d68 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -57,5 +57,7 @@ } } } - } + }, + "title": "Entity_Get", + "operationId": "Entity_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 1985ed6cb10e..113dab2d668f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -31,5 +31,7 @@ "referredEntities": {} } } - } + }, + "title": "Entity_GetByUniqueAttributes", + "operationId": "Entity_GetByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json index 1d976b1e21e0..968a4d7e0fcc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassification.json @@ -13,5 +13,7 @@ "entityStatus": "ACTIVE" } } - } + }, + "title": "Entity_GetClassification", + "operationId": "Entity_GetClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json index 8f89220119d7..ae0d81292c04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetClassifications.json @@ -18,5 +18,7 @@ "sortType": "NONE" } } - } + }, + "title": "Entity_GetClassifications", + "operationId": "Entity_GetClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json index c9ae29bce60d..029a55bbbb96 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetHeader.json @@ -24,5 +24,7 @@ "typeName": "azure_storage_account" } } - } + }, + "title": "Entity_GetHeader", + "operationId": "Entity_GetHeader" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json index b25d5b0cc239..34f5b284ae4b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetSampleBusinessMetadataTemplate.json @@ -1,10 +1,13 @@ { "parameters": { - "Endpoint": "{Endpoint}" + "Endpoint": "{Endpoint}", + "api-version": "2023-09-01" }, "responses": { "200": { "body": "EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]" } - } + }, + "title": "Entity_GetSampleBusinessMetadataTemplate", + "operationId": "Entity_GetSampleBusinessMetadataTemplate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 37325e736386..7b3743545b30 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "file": "examplefile.csv" + "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { @@ -16,5 +16,7 @@ ] } } - } + }, + "title": "Entity_ImportBusinessMetadata", + "operationId": "Entity_ImportBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index 8d8754364eed..ed6951961940 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -110,5 +110,7 @@ ] } } - } + }, + "title": "Entity_ListByGuids", + "operationId": "Entity_ListByGuids" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index 16c42a58932e..c4ce33dd6345 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -46,5 +46,7 @@ ] } } - } + }, + "title": "Entity_ListByUniqueAttributes", + "operationId": "Entity_ListByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json index 42e6555a9f4e..a9d546dacff1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_MoveEntitiesToCollection.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "collectionId": "ExampleNewCollection", "api-version": "2023-09-01", - "moveEntitiesRequest": { + "body": { "entityGuids": [ "321493e3-3fb7-4b3e-9df7-3b69154174c2", "b2f9c306-cf65-4bb0-878e-cfaafde156b1" @@ -41,5 +41,7 @@ } } } - } + }, + "title": "Entity_MoveEntitiesToCollection", + "operationId": "Entity_MoveEntitiesToCollection" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json index 343a0b2ecb25..4320bdb7e9a7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateAttributeByGuid.json @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateAttributeByGuid", + "operationId": "Entity_PartialUpdateAttributeByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json index a38dc403ff1d..40609617bfa7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_PartialUpdateByUniqueAttributes.json @@ -3,9 +3,9 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasEntityWithExtInfo": { + "body": { "entity": { - "createTime": 1.605766397985E12, + "createTime": 1605766397985.0, "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "relationshipAttributes": { @@ -13,7 +13,7 @@ "meanings": [] }, "status": "ACTIVE", - "updateTime": 1.605766397985E12, + "updateTime": 1605766397985.0, "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7", "lastModifiedTS": "1", "version": 0.0, @@ -56,5 +56,7 @@ ] } } - } + }, + "title": "Entity_PartialUpdateByUniqueAttributes", + "operationId": "Entity_PartialUpdateByUniqueAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json index 6335668124ae..717225e30454 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessAttribute.json @@ -2,12 +2,14 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "02c373fe-2823-4be3-97fa-55180a9faa06", - "bmName": "myBizMetaData1", + "businessMetadataName": "myBizMetaData1", "body": { "bizAttr1": "bizAttr1" } }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessAttribute", + "operationId": "Entity_RemoveBusinessMetadataAttributes" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json index 9292ad587d04..9e2de7361e36 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveBusinessMetadata.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveBusinessMetadata", + "operationId": "Entity_RemoveBusinessMetadata" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json index 0967940bc811..408744950b01 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassification.json @@ -6,5 +6,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassification", + "operationId": "Entity_RemoveClassification" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json index 4d2cc9927070..75717c4f59ad 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveClassificationByUniqueAttribute.json @@ -7,5 +7,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveClassificationByUniqueAttribute", + "operationId": "Entity_RemoveClassificationByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json index 8479ed0cfe43..3ae4c0b565f8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_RemoveLabelsByUniqueAttribute.json @@ -9,5 +9,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_RemoveLabelsByUniqueAttribute", + "operationId": "Entity_RemoveLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json index b2132f45f70b..9ffba096b022 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_SetLabelsByUniqueAttribute.json @@ -10,5 +10,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_SetLabelsByUniqueAttribute", + "operationId": "Entity_SetLabelsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json index 56799529f337..40e2350403a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Update.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "entity": { + "api-version": "2023-09-01", + "body": { "referredEntities": {}, "entity": { "typeName": "azure_storage_account", @@ -55,5 +56,7 @@ } } } - } + }, + "title": "Entity_Update", + "operationId": "Entity_CreateOrUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json index d558a272e7ea..274b565b8f81 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassifications.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24", - "classifications": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER", "entityGuid": "45dd4404-e897-b7e2-ca3c-f6e6b11b4f24" @@ -15,5 +15,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassifications", + "operationId": "Entity_UpdateClassifications" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json index e82bbe57a2f3..f3b1777a8e75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "atlasClassificationArray": [ + "body": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" }, @@ -14,5 +14,7 @@ }, "responses": { "204": {} - } + }, + "title": "Entity_UpdateClassificationsByUniqueAttribute", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json index 5ff085189499..82aae3a1b087 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_AssignTermToEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ { "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { @@ -18,5 +18,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_AssignTermToEntities", + "operationId": "Glossary_AssignTermToEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json index a1ec9e6bee07..01289fd09ee1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "atlasGlossary": { + "body": { "name": "Glossary", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -26,5 +26,7 @@ "updateTime": 1672892675688 } } - } + }, + "title": "Glossary_Create", + "operationId": "Glossary_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json index 17a515af1f09..7dfb49f4e1ae 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": [ + "body": [ { "name": "ExampleCategory2", "anchor": { @@ -41,5 +41,7 @@ } ] } - } + }, + "title": "Glossary_CreateCategories", + "operationId": "Glossary_CreateCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json index 7f31caaea342..912e40a4e7ef 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryCategory": { + "body": { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, @@ -33,5 +33,7 @@ ] } } - } + }, + "title": "Glossary_CreateCategory", + "operationId": "Glossary_CreateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json index efd7d2d547b2..bd988ea6973b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm1", "shortDescription": "Example Short Description", "longDescription": "Example Long Description", @@ -72,5 +72,7 @@ } } } - } + }, + "title": "Glossary_CreateTerm", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json index c9b7795a1b04..677877660bc8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTermWithTemplate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": { + "body": { "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -47,5 +47,7 @@ } } } - } + }, + "title": "Glossary_CreateTermWithTemplate", + "operationId": "Glossary_CreateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json index ddd48b3a0782..18fcddae9a04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_CreateTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryTerm": [ + "body": [ { "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" @@ -87,5 +87,7 @@ } ] } - } + }, + "title": "Glossary_CreateTerms", + "operationId": "Glossary_CreateTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json index 70b4059decdd..88b82510fb9f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Delete.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c0c54153-13d1-1608-13af-43457cdffe75" + "glossaryId": "c0c54153-13d1-1608-13af-43457cdffe75" }, "responses": { "204": {} - } + }, + "title": "Glossary_Delete", + "operationId": "Glossary_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json index 678b949d55e5..c281cd4c2450 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteCategory.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "0e391355-252a-e5f3-ac18-5a3602df7616" + "categoryId": "0e391355-252a-e5f3-ac18-5a3602df7616" }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteCategory", + "operationId": "Glossary_DeleteCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json index 32fd415f64d5..7fa8e97b845a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_DeleteTerm.json @@ -1,9 +1,11 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" + "termId": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef" }, "responses": { "204": {} - } + }, + "title": "Glossary_DeleteTerm", + "operationId": "Glossary_DeleteTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json index 1eb2a13b1f0b..6e1aaeaa5786 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Get.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "47029611-67a1-42d5-8766-90eb904f7f22" + "glossaryId": "47029611-67a1-42d5-8766-90eb904f7f22" }, "responses": { "200": { @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Glossary_Get", + "operationId": "Glossary_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json index 2329430d0e4d..1de42a99f57e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetCategory.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12" }, "responses": { "200": { @@ -35,5 +35,7 @@ ] } } - } + }, + "title": "Glossary_GetCategory", + "operationId": "Glossary_GetCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json index f5aea38d5f1d..0345a931a976 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetDetailed.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "responses": { "200": { @@ -225,5 +225,7 @@ } } } - } + }, + "title": "Glossary_GetDetailed", + "operationId": "Glossary_GetDetailed" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json index d1bf7157bbed..3b574ac3e20f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea" }, "responses": { "200": { @@ -80,5 +80,7 @@ ] } } - } + }, + "title": "Glossary_GetTerm", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json index c0dcc7655580..3bedbf11a9a4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_GetTermWithoutAssets.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "excludeRelationshipTypes": [ "AtlasGlossarySemanticAssignment" ] @@ -60,5 +60,7 @@ ] } } - } + }, + "title": "Glossary_GetTermWithoutAssets", + "operationId": "Glossary_GetTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json index f8bc74ada7f4..c454ce6b68f7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_List.json @@ -55,5 +55,7 @@ } ] } - } + }, + "title": "Glossary_List", + "operationId": "Glossary_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json index aabcc66dc2d0..30e8cf73dbfd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -68,5 +68,7 @@ } ] } - } + }, + "title": "Glossary_ListCategories", + "operationId": "Glossary_ListCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json index 277c967f7f0b..a04eb3cba127 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoriesHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -28,5 +28,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoriesHeaders", + "operationId": "Glossary_ListCategoriesHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json index 7fe35d8dd8f2..e1a99139221b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListCategoryTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -16,5 +16,7 @@ } ] } - } + }, + "title": "Glossary_ListCategoryTerms", + "operationId": "Glossary_ListCategoryTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json index ebfed3c2de40..99c872e87c99 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", + "termId": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "limit": "-1", "offset": "0", "sort": "ASC" @@ -53,5 +53,7 @@ } ] } - } + }, + "title": "Glossary_ListEntitiesAssignedWithTerm", + "operationId": "Glossary_ListEntitiesAssignedWithTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json index 7523745867a5..2e845fcb0944 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedCategories.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedCategories", + "operationId": "Glossary_ListRelatedCategories" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json index ca90bb6d08d7..56999a9dd79a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListRelatedTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", "limit": "-1", "offset": "0", "sort": "ASC" @@ -25,5 +25,7 @@ ] } } - } + }, + "title": "Glossary_ListRelatedTerms", + "operationId": "Glossary_ListRelatedTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json index 1375aa567f2b..6bcfbe8c9fc9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTermHeaders.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -21,5 +21,7 @@ } ] } - } + }, + "title": "Glossary_ListTermHeaders", + "operationId": "Glossary_ListTermHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json index 214bbd4c4f76..583aa635b462 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_ListTerms.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "limit": "-1", "offset": "0", "sort": "ASC" @@ -99,5 +99,7 @@ } ] } - } + }, + "title": "Glossary_ListTerms", + "operationId": "Glossary_ListTerms" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json index 4df90166a6b6..c06db55d9e38 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdate.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "partialUpdates": { + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { "longDescription": "Example Long Description" } }, @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdate", + "operationId": "Glossary_PartialUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json index 11516593b6bd..15be08095e73 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", - "partialUpdates": { + "categoryId": "3243ea0a-9492-47e1-392e-a84e64980af9", + "body": { "longDescription": "Example Long Description" } }, @@ -39,5 +39,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateCategory", + "operationId": "Glossary_PartialUpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json index 572d692fa4b6..356a70cf4da3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_PartialUpdateTerm.json @@ -1,9 +1,9 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "partialUpdates": { - "longDescription": "Example Long Descrition" + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { + "longDescription": "Example Long Description" } }, "responses": { @@ -54,5 +54,7 @@ ] } } - } + }, + "title": "Glossary_PartialUpdateTerm", + "operationId": "Glossary_PartialUpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json index ca978c5df1fc..2238f2443727 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_RemoveTermAssignmentFromEntities.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", - "relatedObjectIds": [ + "termId": "8a7f65ec-6429-0b9b-3734-ec57bf1e34c2", + "body": [ { "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd", "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5" @@ -11,5 +11,7 @@ }, "responses": { "204": {} - } + }, + "title": "Glossary_RemoveTermAssignmentFromEntities", + "operationId": "Glossary_DeleteTermAssignmentFromEntities" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json index ac2868693994..faca8b5cb2a2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_Update.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", - "updatedGlossary": { + "glossaryId": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", + "body": { "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", @@ -92,5 +92,7 @@ ] } } - } + }, + "title": "Glossary_Update", + "operationId": "Glossary_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json index fb8c92c94fd5..7c145590a59b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateCategory.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "glossaryCategory": { + "categoryId": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", + "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "qualifiedName": "ExampleCategory1@Glossary", "name": "ExampleCategory1", @@ -59,5 +59,7 @@ ] } } - } + }, + "title": "Glossary_UpdateCategory", + "operationId": "Glossary_UpdateCategory" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json index 065bba39f639..9ed4cb3964b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Glossary_UpdateTerm.json @@ -1,8 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "glossaryTerm": { + "termId": "54688d39-b298-4104-9e80-f2a16f44aaea", + "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", "qualifiedName": "ExampleTerm1@Glossary", "name": "ExampleTerm1", @@ -88,5 +88,7 @@ ] } } - } + }, + "title": "Glossary_UpdateTerm", + "operationId": "Glossary_UpdateTerm" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json index 122a1804289c..a08de217b1c0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_Get.json @@ -20,5 +20,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_Get", + "operationId": "Lineage_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json index 4b9886deec69..ab738e50995b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetByUniqueAttribute.json @@ -59,5 +59,7 @@ } } } - } + }, + "title": "Lineage_GetByUniqueAttribute", + "operationId": "Lineage_GetByUniqueAttribute" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json index 66f7aac1fb7a..778a391f5b59 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Lineage_GetNextPage.json @@ -21,5 +21,7 @@ "parentRelations": [] } } - } + }, + "title": "Lineage_GetNextPage", + "operationId": "Lineage_GetNextPage" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json index 8122eee5cd3a..89d3b4e5afec 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Create.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -54,5 +54,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Create", + "operationId": "Relationship_Create" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json index 291912c8ccac..c6e4848b9952 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Relationship_Delete", + "operationId": "Relationship_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json index 7a9054f95285..182684f354bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Get.json @@ -35,5 +35,7 @@ } } } - } + }, + "title": "Relationship_Get", + "operationId": "Relationship_Get" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json index 3664c81a3ec7..0cd955fe3154 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Relationship_Update.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "relationship": { + "body": { "typeName": "AtlasGlossarySynonym", "attributes": { "expression": "Example Expression", @@ -55,5 +55,7 @@ "version": 0 } } - } + }, + "title": "Relationship_Update", + "operationId": "Relationship_Update" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json index 3c08502d3e0f..d91723b6e888 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -67,5 +67,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_BulkCreate", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json index 66e7d50e8570..433ff8867948 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkCreateBusinessMetadataDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -71,5 +71,7 @@ ] } } - } + }, + "title": "Type_BulkCreateBusinessMetadataDefs", + "operationId": "Type_BulkCreate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json index 40e463be1ce9..60ba8acc3b75 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkDelete.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -29,5 +29,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_BulkDelete", + "operationId": "Type_BulkDelete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json index fd37acb1ec1c..7905abbea1af 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_BulkUpdate.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "typesDef": { + "body": { "enumDefs": [], "structDefs": [], "classificationDefs": [], @@ -284,5 +284,7 @@ ] } } - } + }, + "title": "Type_BulkUpdate", + "operationId": "Type_BulkUpdate" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json index d95c0728b9cb..8a364027401e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_Delete.json @@ -5,5 +5,7 @@ }, "responses": { "204": {} - } + }, + "title": "Type_Delete", + "operationId": "Type_Delete" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json index 5790a0df446e..34921a8239b7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByGuid", + "operationId": "Type_GetBusinessMetadataDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json index 89abf18c256d..64d92fefd723 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetBusinessMetadataDefByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetBusinessMetadataDefByName", + "operationId": "Type_GetBusinessMetadataDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json index ebd1ed4902de..e94b5ad8b518 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByGuid.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByGuid", + "operationId": "Type_GetByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json index 77ec05812c26..804029d070e1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetByName.json @@ -37,5 +37,7 @@ ] } } - } + }, + "title": "Type_GetByName", + "operationId": "Type_GetByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json index 31f09a6d61e6..bf27840af6aa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByGuid.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByGuid", + "operationId": "Type_GetClassificationDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json index b7d7ed8a4f74..e7a58bf32bfb 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetClassificationDefByName.json @@ -22,5 +22,7 @@ "subTypes": [] } } - } + }, + "title": "Type_GetClassificationDefByName", + "operationId": "Type_GetClassificationDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json index 2728fb2507c3..9c0d6ce53cb7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByGuid.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByGuid", + "operationId": "Type_GetEntityDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json index 0542db979369..140ba1a5b309 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEntityDefByName.json @@ -52,5 +52,7 @@ ] } } - } + }, + "title": "Type_GetEntityDefByName", + "operationId": "Type_GetEntityDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json index 9c324ce8d35b..ab9e4048b0d2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByGuid.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByGuid", + "operationId": "Type_GetEnumDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json index 6adfee266b61..62907f8f6a69 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetEnumDefByName.json @@ -32,5 +32,7 @@ ] } } - } + }, + "title": "Type_GetEnumDefByName", + "operationId": "Type_GetEnumDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json index 66b6efd3f8bf..71c9a03a65d9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByGuid.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByGuid", + "operationId": "Type_GetRelationshipDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json index 148c7d655371..ecdafc07a934 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetRelationshipDefByName.json @@ -35,5 +35,7 @@ "relationshipLabel": "r:storm_topology_nodes" } } - } + }, + "title": "Type_GetRelationshipDefByName", + "operationId": "Type_GetRelationshipDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json index d2e1e0901f30..c31ae06aeeb6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByGuid.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByGuid", + "operationId": "Type_GetStructDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json index 6bffd4888fa2..26f8e843a6d6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetStructDefByName.json @@ -42,5 +42,7 @@ ] } } - } + }, + "title": "Type_GetStructDefByName", + "operationId": "Type_GetStructDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json index fc5c6208e066..e6c263c691e5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByGuid.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByGuid", + "operationId": "Type_GetTermTemplateDefByGuid" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json index 72f8d97172d8..d8b28d19db05 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_GetTermTemplateDefByName.json @@ -79,5 +79,7 @@ ] } } - } + }, + "title": "Type_GetTermTemplateDefByName", + "operationId": "Type_GetTermTemplateDefByName" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4e6b37b8b6f1..4f9be7fe0434 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -265,5 +265,7 @@ ] } } - } + }, + "title": "Type_List", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index 0c3b2d78f851..c4118ef9957a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -86,5 +86,7 @@ "relationshipDefs": [] } } - } + }, + "title": "Type_ListEnumDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json index 99ec7d9d00b2..288c815d8a88 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListHeaders.json @@ -23,5 +23,7 @@ } ] } - } + }, + "title": "Type_ListHeaders", + "operationId": "Type_ListHeaders" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index 26902f2461c6..c9a13ccd7758 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -87,5 +87,7 @@ ] } } - } + }, + "title": "Type_ListTermTemplateDefs", + "operationId": "Type_List" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json new file mode 100644 index 000000000000..a7bee6134c9d --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -0,0 +1,8864 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Analytics Purview Data Map", + "version": "2023-09-01", + "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/datamap/api", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AuthToken": [ + "https://purview.azure.net/.default" + ] + } + ], + "securityDefinitions": { + "AuthToken": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://purview.azure.net/.default": "" + } + } + }, + "tags": [], + "paths": { + "/atlas/v2/entity": { + "post": { + "operationId": "Entity_CreateOrUpdate", + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + }, + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + } + } + } + }, + "/atlas/v2/entity/bulk": { + "get": { + "operationId": "Entity_ListByGuids", + "description": "List entities in bulk identified by its GUIDs.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to list.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } + } + }, + "post": { + "operationId": "Entity_BulkCreateOrUpdate", + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" + }, + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "body", + "in": "body", + "description": "An array of entities to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Entity_BulkDelete", + "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to delete.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } + } + } + }, + "/atlas/v2/entity/bulk/classification": { + "post": { + "operationId": "Entity_AddClassification", + "description": "Associate a classification to multiple entities in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The request to associate a classification to multiple entities.", + "required": true, + "schema": { + "$ref": "#/definitions/ClassificationAssociateOptions" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } + } + } + }, + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "operationId": "Entity_BulkSetClassifications", + "description": "Set classifications on entities in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "Atlas entity headers.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" + } + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_ListByUniqueAttributes", + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "operationId": "Entity_ImportBusinessMetadata", + "description": "Upload the file for creating Business Metadata in BULK", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "uploadedInputStream", + "in": "formData", + "description": "InputStream of file", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BulkImportResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import/template": { + "get": { + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "operationId": "Entity_Get", + "description": "Get complete definition of an entity given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" + } + } + }, + "put": { + "operationId": "Entity_PartialUpdateAttributeByGuid", + "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The value of the attribute.", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_PartialUpdateAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + } + } + }, + "delete": { + "operationId": "Entity_Delete", + "description": "Delete an entity identified by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "description": "Add business metadata to an entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "isOverwrite", + "in": "query", + "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", + "required": false, + "type": "boolean", + "x-ms-client-name": "overwrite" + }, + { + "name": "body", + "in": "body", + "description": "BusinessMetadata payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadata", + "description": "Remove business metadata from an entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Business metadata payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "description": "Add or update business metadata attributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "description": "Delete business metadata attributes from an entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "operationId": "Entity_GetClassification", + "description": "Get classification for a given entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveClassification", + "description": "Delete a given classification from an existing entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "operationId": "Entity_GetClassifications", + "description": "List classifications for a given entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } + } + }, + "put": { + "operationId": "Entity_UpdateClassifications", + "description": "Update classifications to an existing entity represented by a guid.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "An array of classifications to be updated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" + } + } + }, + "post": { + "operationId": "Entity_AddClassifications", + "description": "Add classifications to an existing entity represented by a GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "An array of classifications to be added.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/header": { + "get": { + "operationId": "Entity_GetHeader", + "description": "Get entity header given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetHeader": { + "$ref": "./examples/Entity_GetHeader.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/labels": { + "put": { + "operationId": "Entity_AddLabel", + "description": "Add given labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be added", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_AddLabel.json" + } + } + }, + "post": { + "operationId": "Entity_SetLabels", + "description": "Set labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be set to the entity", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_SetLabels": { + "$ref": "./examples/Entity_SetLabels.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveLabels", + "description": "Delete given labels to a given entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be deleted", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_RemoveLabels.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_GetByUniqueAttributes", + "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" + } + } + }, + "put": { + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_PartialUpdateByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + } + } + }, + "delete": { + "operationId": "Entity_DeleteByUniqueAttribute", + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { + "delete": { + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "put": { + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "description": "Update classification on an entity identified by its type and unique attributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "An array of classification to be updated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" + } + } + }, + "post": { + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "description": "Add classification to the entity identified by its type and unique attributes.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "An array of classification to be added.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { + "put": { + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be added", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } + } + }, + "post": { + "operationId": "Entity_SetLabelsByUniqueAttribute", + "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be set", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" + } + } + }, + "delete": { + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "set of labels to be deleted", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/glossary": { + "get": { + "operationId": "Glossary_List", + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossary" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } + } + }, + "post": { + "operationId": "Glossary_Create", + "description": "Create a glossary.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}": { + "get": { + "operationId": "Glossary_Get", + "description": "Get a specific Glossary by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" + } + } + }, + "put": { + "operationId": "Glossary_Update", + "description": "Update the given glossary.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "The glossary definition to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" + } + } + }, + "delete": { + "operationId": "Glossary_Delete", + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories": { + "get": { + "operationId": "Glossary_ListCategories", + "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories/headers": { + "get": { + "operationId": "Glossary_ListCategoriesHeaders", + "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/detailed": { + "get": { + "operationId": "Glossary_GetDetailed", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdate", + "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/terms": { + "get": { + "operationId": "Glossary_ListTerms", + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/terms/headers": { + "get": { + "operationId": "Glossary_ListTermHeaders", + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } + } + } + }, + "/atlas/v2/glossary/categories": { + "post": { + "operationId": "Glossary_CreateCategories", + "description": "Create glossary category in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "An array of glossary category definitions to be created.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" + } + } + } + }, + "/atlas/v2/glossary/category": { + "post": { + "operationId": "Glossary_CreateCategory", + "description": "Create a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}": { + "get": { + "operationId": "Glossary_GetCategory", + "description": "Get specific glossary category by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" + } + } + }, + "put": { + "operationId": "Glossary_UpdateCategory", + "description": "Update the given glossary category by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The glossary category to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteCategory", + "description": "Delete a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateCategory", + "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/related": { + "get": { + "operationId": "Glossary_ListRelatedCategories", + "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}/terms": { + "get": { + "operationId": "Glossary_ListCategoryTerms", + "description": "Get all terms associated with the specific category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" + } + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "operationId": "Glossary_CreateTerm", + "description": "Create a glossary term.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" + }, + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" + } + } + } + }, + "/atlas/v2/glossary/term/{termId}": { + "get": { + "operationId": "Glossary_GetTerm", + "description": "Get a specific glossary term by its GUID. ", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" + }, + "Glossary_GetTermWithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" + } + } + }, + "put": { + "operationId": "Glossary_UpdateTerm", + "description": "Update the given glossary term by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "The glossary term to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteTerm", + "description": "Delete a glossary term.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } + } + } + }, + "/atlas/v2/glossary/term/{termId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateTerm", + "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } + } + } + }, + "/atlas/v2/glossary/terms": { + "post": { + "operationId": "Glossary_CreateTerms", + "description": "Create glossary terms in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } + } + } + }, + "/atlas/v2/glossary/terms/{termId}/assignedEntities": { + "get": { + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" + } + } + }, + "post": { + "operationId": "Glossary_AssignTermToEntities", + "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "An array of related object IDs to which the term has to be associated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" + } + } + }, + "delete": { + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "description": "Delete the term assignment for the given list of related objects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } + } + } + }, + "/atlas/v2/glossary/terms/{termId}/related": { + "get": { + "operationId": "Glossary_ListRelatedTerms", + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" + } + } + } + }, + "/atlas/v2/lineage/{guid}": { + "get": { + "operationId": "Lineage_Get", + "description": "Get lineage info of the entity specified by GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } + } + } + }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Lineage_GetByUniqueAttribute", + "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } + } + } + }, + "/atlas/v2/relationship": { + "put": { + "operationId": "Relationship_Update", + "description": "Update an existing relationship between entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" + } + } + }, + "post": { + "operationId": "Relationship_Create", + "description": "Create a new relationship between entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } + } + } + }, + "/atlas/v2/relationship/guid/{guid}": { + "get": { + "operationId": "Relationship_Get", + "description": "Get relationship information between entities by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + }, + { + "name": "extendedInfo", + "in": "query", + "description": "Limits whether includes extended information.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" + } + } + }, + "delete": { + "operationId": "Relationship_Delete", + "description": "Delete a relationship between entities by its GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByGuid", + "description": "Get the businessMetadata definition for the given guid.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "businessMetadata guid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByName", + "description": "Get the businessMetadata definition by it's name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "businessMetadata name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } + } + } + }, + "/atlas/v2/types/classificationdef/guid/{guid}": { + "get": { + "operationId": "Type_GetClassificationDefByGuid", + "description": "Get the classification definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "operationId": "Type_GetClassificationDefByName", + "description": "Get the classification definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } + } + } + }, + "/atlas/v2/types/entitydef/guid/{guid}": { + "get": { + "operationId": "Type_GetEntityDefByGuid", + "description": "Get the Entity definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/entitydef/name/{name}": { + "get": { + "operationId": "Type_GetEntityDefByName", + "description": "Get the entity definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the entity.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEntityDefByName": { + "$ref": "./examples/Type_GetEntityDefByName.json" + } + } + } + }, + "/atlas/v2/types/enumdef/guid/{guid}": { + "get": { + "operationId": "Type_GetEnumDefByGuid", + "description": "Get the enum definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the enum.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/enumdef/name/{name}": { + "get": { + "operationId": "Type_GetEnumDefByName", + "description": "Get the enum definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the enum.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } + } + } + }, + "/atlas/v2/types/relationshipdef/guid/{guid}": { + "get": { + "operationId": "Type_GetRelationshipDefByGuid", + "description": "Get the relationship definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/relationshipdef/name/{name}": { + "get": { + "operationId": "Type_GetRelationshipDefByName", + "description": "Get the relationship definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the relationship.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } + } + } + }, + "/atlas/v2/types/structdef/guid/{guid}": { + "get": { + "operationId": "Type_GetStructDefByGuid", + "description": "Get the struct definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the struct.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetStructDefByGuid": { + "$ref": "./examples/Type_GetStructDefByGuid.json" + } + } + } + }, + "/atlas/v2/types/structdef/name/{name}": { + "get": { + "operationId": "Type_GetStructDefByName", + "description": "Get the struct definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the struct.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } + } + } + }, + "/atlas/v2/types/typedef/guid/{guid}": { + "get": { + "operationId": "Type_GetByGuid", + "description": "Get the type definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } + } + } + }, + "/atlas/v2/types/typedef/name/{name}": { + "get": { + "operationId": "Type_GetByName", + "description": "Get the type definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" + } + } + }, + "delete": { + "operationId": "Type_Delete", + "description": "Delete API for type identified by its name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } + } + } + }, + "/atlas/v2/types/typedefs": { + "get": { + "operationId": "Type_List", + "description": "List all type definitions in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" + }, + { + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "TypeDef", + "modelAsString": true, + "values": [ + { + "name": "Enum", + "value": "enum", + "description": "enum" + }, + { + "name": "Entity", + "value": "entity", + "description": "entity" + }, + { + "name": "Classification", + "value": "classification", + "description": "classification" + }, + { + "name": "Relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "Struct", + "value": "struct", + "description": "struct" + }, + { + "name": "TermTemplate", + "value": "term_template", + "description": "term template" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_List": { + "$ref": "./examples/Type_List.json" + }, + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" + } + } + }, + "put": { + "operationId": "Type_BulkUpdate", + "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "A composite object that captures all type definition changes.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkUpdate": { + "$ref": "./examples/Type_BulkUpdate.json" + } + } + }, + "post": { + "operationId": "Type_BulkCreate", + "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "A composite wrapper object with corresponding lists of the type definition.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + } + } + }, + "delete": { + "operationId": "Type_BulkDelete", + "description": "Delete API for all types in bulk.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "A composite object that captures all types to be deleted", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } + } + } + }, + "/atlas/v2/types/typedefs/headers": { + "get": { + "operationId": "Type_ListHeaders", + "description": "List all type definitions returned as a list of minimal information header.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" + }, + { + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "TypeDef", + "modelAsString": true, + "values": [ + { + "name": "Enum", + "value": "enum", + "description": "enum" + }, + { + "name": "Entity", + "value": "entity", + "description": "entity" + }, + { + "name": "Classification", + "value": "classification", + "description": "classification" + }, + { + "name": "Relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "Struct", + "value": "struct", + "description": "struct" + }, + { + "name": "TermTemplate", + "value": "term_template", + "description": "term template" + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasTypeDefHeader" + }, + "x-ms-identifiers": [] + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } + } + } + }, + "/entity/moveTo": { + "post": { + "operationId": "Entity_MoveEntitiesToCollection", + "description": "Move existing entities to the target collection.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "Entity guids to be moved to target collection.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Entity_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } + } + } + }, + "/lineage/{guid}/next": { + "get": { + "operationId": "Lineage_GetNextPage", + "description": "Return immediate next page lineage info about entity with pagination", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } + } + } + }, + "/search/autocomplete": { + "post": { + "operationId": "Discovery_AutoComplete", + "description": "Get auto complete options.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "An object specifying the autocomplete criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AutoCompleteResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } + } + } + }, + "/search/query": { + "post": { + "operationId": "Discovery_Query", + "description": "Get data using search.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "An object specifying the search criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_TermAssignment": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Type": { + "$ref": "./examples/Discovery_Query_Type.json" + } + } + } + }, + "/search/suggest": { + "post": { + "operationId": "Discovery_Suggest", + "description": "Get search suggestions by query criteria.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "An object specifying the suggest criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" + } + } + } + }, + "/types/termtemplatedef/guid/{guid}": { + "get": { + "operationId": "Type_GetTermTemplateDefByGuid", + "description": "Get the term template definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" + } + } + } + }, + "/types/termtemplatedef/name/{name}": { + "get": { + "operationId": "Type_GetTermTemplateDefByName", + "description": "Get the term template definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The unique name of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" + } + } + } + } + }, + "definitions": { + "ApiVersions": { + "type": "string", + "description": "Service API versions", + "enum": [ + "2023-09-01" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "v2023_09_01", + "value": "2023-09-01", + "description": "2023-09-01 service API version" + } + ] + } + }, + "AtlasAttributeDef": { + "type": "object", + "description": "class that captures details of a struct-attribute.", + "properties": { + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + } + } + }, + "AtlasBaseModelObject": { + "type": "object", + "description": "The base model object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + } + } + }, + "AtlasBaseTypeDef": { + "type": "object", + "description": "Base class that captures common-attributes for all types.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + } + } + }, + "AtlasBusinessMetadataDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassification": { + "type": "object", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityGuid": { + "type": "string", + "description": "The GUID of the entity." + }, + "entityStatus": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "removePropagationsOnEntityDelete": { + "type": "boolean", + "description": "Determines if propagations will be removed on entity deletion." + }, + "validityPeriods": { + "type": "array", + "description": "An array of time boundaries indicating validity periods.", + "items": { + "$ref": "#/definitions/TimeBoundary" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasClassificationDef": { + "type": "object", + "description": "class that captures details of a classification-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + } + } + }, + "AtlasClassifications": { + "type": "object", + "description": "REST serialization friendly list.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." + } + } + }, + "AtlasConstraintDef": { + "type": "object", + "description": "class that captures details of a constraint.", + "properties": { + "params": { + "type": "object", + "description": "The parameters of the constraint definition.", + "additionalProperties": {} + }, + "type": { + "type": "string", + "description": "The type of the constraint." + } + } + }, + "AtlasEntitiesWithExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "entities": { + "type": "array", + "description": "An array of entities.", + "items": { + "$ref": "#/definitions/AtlasEntity" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntity": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "businessAttributes": { + "type": "object", + "description": "Business attributes", + "additionalProperties": {} + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "customAttributes": { + "type": "object", + "description": "Custom Attribute", + "additionalProperties": { + "type": "string" + } + }, + "guid": { + "type": "string", + "description": "The GUID of the entity." + }, + "homeId": { + "type": "string", + "description": "The home ID of the entity." + }, + "collectionId": { + "type": "string", + "description": "The collection ID of the entity.", + "readOnly": true + }, + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" + }, + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers indicating the meanings of the entity.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship." + }, + "proxy": { + "type": "boolean", + "description": "Determines if there's a proxy." + }, + "relationshipAttributes": { + "type": "object", + "description": "The attributes of relationship.", + "additionalProperties": {} + }, + "status": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the entity." + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" + } + } + } + }, + "AtlasEntityDef": { + "type": "object", + "description": "class that captures details of a entity-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEntityExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + } + } + }, + "AtlasEntityHeader": { + "type": "object", + "description": "An instance of an entity - like hive_table, hive_database.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "classificationNames": { + "type": "array", + "description": "An array of classification names.", + "items": { + "type": "string" + } + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "guid": { + "type": "string", + "description": "The GUID of the record." + }, + "isIncomplete": { + "type": "boolean", + "description": "Whether it is a shell entity" + }, + "labels": { + "type": "array", + "description": "labels", + "items": { + "type": "string" + } + }, + "meaningNames": { + "type": "array", + "description": "An array of meanings.", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + } + } + }, + "AtlasEntityHeaders": { + "type": "object", + "description": "An instance of an entity header map.", + "properties": { + "guidHeaderMap": { + "type": "object", + "description": "The description of the guid header map,", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + } + } + }, + "AtlasEntityWithExtInfo": { + "type": "object", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "entity": { + "$ref": "#/definitions/AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database." + } + } + }, + "AtlasEnumDef": { + "type": "object", + "description": "class that captures details of an enum-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasEnumElementDef": { + "type": "object", + "description": "class that captures details of an enum-element.", + "properties": { + "description": { + "type": "string", + "description": "The description of the enum element definition." + }, + "ordinal": { + "type": "integer", + "format": "int32", + "description": "The ordinal of the enum element definition." + }, + "value": { + "type": "string", + "description": "The value of the enum element definition." + } + } + }, + "AtlasErrorResponse": { + "type": "object", + "description": "An error response from the service", + "properties": { + "requestId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The request ID." + }, + "errorCode": { + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "AtlasExtraTypeDef": { + "type": "object", + "description": "Extra properties for a type.", + "properties": { + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasGlossary": { + "type": "object", + "description": "The glossary object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + } + } + }, + "AtlasGlossaryBaseObject": { + "type": "object", + "description": "The glossary base object.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + } + } + }, + "AtlasGlossaryCategory": { + "type": "object", + "description": "The glossary category.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "childrenCategories": { + "type": "array", + "description": "An array of children categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "parentCategory": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader", + "description": "The header of the related category." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasGlossaryExtInfo": { + "type": "object", + "description": "The extended information of glossary.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + }, + "categoryInfo": { + "type": "object", + "description": "The glossary category information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "termInfo": { + "type": "object", + "description": "The glossary term information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + } + }, + "AtlasGlossaryHeader": { + "type": "object", + "description": "The glossary header with basic information.", + "properties": { + "displayText": { + "type": "string", + "description": "The display text." + }, + "glossaryGuid": { + "type": "string", + "description": "The GUID of the glossary." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + } + }, + "AtlasGlossaryTerm": { + "type": "object", + "description": "The glossary term.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "abbreviation": { + "type": "string", + "description": "The abbreviation of the term." + }, + "templateName": { + "type": "array", + "description": "The name of the template.", + "items": {} + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "antonyms": { + "type": "array", + "description": "An array of related term headers as antonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/TermStatus", + "description": "Status of the AtlasGlossaryTerm" + }, + "nickName": { + "type": "string", + "description": "The nick name of the term." + }, + "hierarchyInfo": { + "type": "array", + "description": "The hierarchy information of the term.", + "items": { + "$ref": "#/definitions/PurviewObjectId" + }, + "x-ms-identifiers": [] + }, + "resources": { + "type": "array", + "description": "An array of resource link for term", + "items": { + "$ref": "#/definitions/ResourceLink" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" + } + }, + "attributes": { + "type": "object", + "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + }, + "assignedEntities": { + "type": "array", + "description": "An array of related object IDs.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] + }, + "categories": { + "type": "array", + "description": "An array of term categorization headers.", + "items": { + "$ref": "#/definitions/AtlasTermCategorizationHeader" + }, + "x-ms-identifiers": [] + }, + "classifies": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "examples": { + "type": "array", + "description": "An array of examples.", + "items": { + "type": "string" + } + }, + "isA": { + "type": "array", + "description": "An array of related term headers indicating the is-a relationship.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "preferredTerms": { + "type": "array", + "description": "An array of preferred related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "preferredToTerms": { + "type": "array", + "description": "An array of related term headers that are preferred to.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "replacedBy": { + "type": "array", + "description": "An array of related term headers that are replaced by.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "replacementTerms": { + "type": "array", + "description": "An array of related term headers for replacement.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "seeAlso": { + "type": "array", + "description": "An array of related term headers for see also.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "synonyms": { + "type": "array", + "description": "An array of related term headers as synonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "translatedTerms": { + "type": "array", + "description": "An array of translated related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "translationTerms": { + "type": "array", + "description": "An array of related term headers for translation.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the term." + }, + "validValues": { + "type": "array", + "description": "An array of related term headers as valid values.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "validValuesFor": { + "type": "array", + "description": "An array of related term headers as valid values for other records.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasLineageInfo": { + "type": "object", + "description": "The lineage information.", + "properties": { + "baseEntityGuid": { + "type": "string", + "description": "The GUID of the base entity." + }, + "guidEntityMap": { + "type": "object", + "description": "The GUID entity map.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "widthCounts": { + "type": "object", + "description": "The entity count in specific direction.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } + }, + "lineageDepth": { + "type": "integer", + "format": "int32", + "description": "The depth of lineage." + }, + "lineageWidth": { + "type": "integer", + "format": "int32", + "description": "The width of lineage." + }, + "childrenCount": { + "type": "integer", + "format": "int32", + "description": "The number of children node." + }, + "lineageDirection": { + "$ref": "#/definitions/LineageDirection", + "description": "The enum of lineage direction." + }, + "parentRelations": { + "type": "array", + "description": "An array of parentRelations relations.", + "items": { + "$ref": "#/definitions/ParentRelation" + }, + "x-ms-identifiers": [] + }, + "relations": { + "type": "array", + "description": "An array of lineage relations.", + "items": { + "$ref": "#/definitions/LineageRelation" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasObjectId": { + "type": "object", + "description": "Reference to an object-instance of a type - like entity.", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + } + } + }, + "AtlasRelatedCategoryHeader": { + "type": "object", + "description": "The header of the related category.", + "properties": { + "categoryGuid": { + "type": "string", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the category header." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "parentCategoryGuid": { + "type": "string", + "description": "The GUID of the parent category." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + } + }, + "AtlasRelatedObjectId": { + "type": "object", + "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "entityStatus": { + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." + }, + "relationshipType": { + "type": "string", + "description": "Relationship type" + }, + "relationshipAttributes": { + "$ref": "#/definitions/AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." + }, + "relationshipGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "relationshipStatus": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." + } + } + }, + "AtlasRelatedTermHeader": { + "type": "object", + "description": "The header of the related term.", + "properties": { + "description": { + "type": "string", + "description": "The description of the related term." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + } + }, + "AtlasRelationship": { + "type": "object", + "description": "Atlas relationship instance.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "end1": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "end2": { + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "guid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "homeId": { + "type": "string", + "description": "The home ID of the relationship." + }, + "label": { + "type": "string", + "description": "The label of the relationship." + }, + "provenanceType": { + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship" + }, + "status": { + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the relationship." + } + } + }, + "AtlasRelationshipAttributeDef": { + "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", + "properties": { + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." + } + } + }, + "AtlasRelationshipDef": { + "type": "object", + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + } + } + }, + "AtlasRelationshipEndDef": { + "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", + "properties": { + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." + }, + "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." + } + } + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "description": "The relationship with extended information.", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "relationship": { + "$ref": "#/definitions/AtlasRelationship", + "description": "Atlas relationship instance." + } + } + }, + "AtlasStruct": { + "type": "object", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + } + } + }, + "AtlasStructDef": { + "type": "object", + "description": "class that captures details of a struct-type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasTermAssignmentHeader": { + "type": "object", + "description": "The header for term assignment.", + "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": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermAssignmentStatus", + "description": "The status of terms assignment." + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the term." + } + } + }, + "AtlasTermAssignmentStatus": { + "type": "string", + "description": "Status for term assignment", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Discovered", + "value": "DISCOVERED", + "description": "The status is discovered." + }, + { + "name": "Proposed", + "value": "PROPOSED", + "description": "The status is proposed." + }, + { + "name": "Imported", + "value": "IMPORTED", + "description": "The status is imported." + }, + { + "name": "Validated", + "value": "VALIDATED", + "description": "The status is validated." + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "The status is deprecated." + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "The status is obsolete." + }, + { + "name": "Other", + "value": "OTHER", + "description": "Other status." + } + ] + } + }, + "AtlasTermCategorizationHeader": { + "type": "object", + "description": "The basic information for term categorization.", + "properties": { + "categoryGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the record." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "relationGuid": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." + } + } + }, + "AtlasTermRelationshipStatus": { + "type": "string", + "description": "Status for atlas term relationship", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "DRAFT", + "description": "draft" + }, + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "deprecated" + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "obsolete" + }, + { + "name": "Other", + "value": "OTHER", + "description": "other" + } + ] + } + }, + "AtlasTypeDef": { + "type": "object", + "description": "The definitions of type.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + }, + "x-ms-identifiers": [] + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AtlasTypeDefHeader": { + "type": "object", + "description": "The basic information of the type definition.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + } + }, + "AtlasTypesDef": { + "type": "object", + "description": "The definitions of types.", + "properties": { + "businessMetadataDefs": { + "type": "array", + "description": "businessMetadataDefs", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + }, + "x-ms-identifiers": [] + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + }, + "x-ms-identifiers": [] + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + }, + "x-ms-identifiers": [] + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + }, + "x-ms-identifiers": [] + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + }, + "x-ms-identifiers": [] + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + }, + "x-ms-identifiers": [] + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + }, + "x-ms-identifiers": [] + } + } + }, + "AuthToken": { + "type": "object", + "description": "The Azure Active Directory OAuth2 Flow", + "properties": { + "type": { + "type": "string", + "description": "OAuth2 authentication", + "enum": [ + "oauth2" + ] + }, + "flows": { + "type": "array", + "description": "Supported OAuth2 flows", + "items": {} + } + }, + "required": [ + "type", + "flows" + ] + }, + "AutoCompleteOptions": { + "type": "object", + "description": "The query of autocomplete request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the autocomplete request." + } + } + }, + "AutoCompleteResult": { + "type": "object", + "description": "The result of the autocomplete request.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + }, + "x-ms-identifiers": [] + } + } + }, + "AutoCompleteResultValue": { + "type": "object", + "description": "The value item of the autocomplete suggest.", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BulkImportResult": { + "type": "object", + "description": "Bulk import result", + "properties": { + "failedImportInfoList": { + "type": "array", + "description": "failed importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + }, + "successImportInfoList": { + "type": "array", + "description": "successful importInfoList", + "items": { + "$ref": "#/definitions/ImportInfo" + }, + "x-ms-identifiers": [] + } + } + }, + "BusinessAttributeUpdateBehavior": { + "type": "string", + "description": "Enum for business attribute update behavior", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + "CardinalityValue": { + "type": "string", + "description": "Cardinality", + "enum": [ + "SINGLE", + "LIST", + "SET" + ], + "x-ms-enum": { + "name": "CardinalityValue", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "SINGLE", + "description": "single" + }, + { + "name": "List", + "value": "LIST", + "description": "list" + }, + { + "name": "Set", + "value": "SET", + "description": "set" + } + ] + } + }, + "ClassificationAssociateOptions": { + "type": "object", + "description": "The request content for classification association.", + "properties": { + "classification": { + "$ref": "#/definitions/AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." + }, + "entityGuids": { + "type": "array", + "description": "The GUID of the entity.", + "items": { + "type": "string" + } + } + } + }, + "ContactInfo": { + "type": "object", + "description": "ContactInfo", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, + "ContactSearchResultValue": { + "type": "object", + "description": "The contact in the search and suggest result.", + "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\nExpert or Steward for a glossary term." + } + } + }, + "DateFormat": { + "type": "object", + "description": "The date format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "An array of available locales.", + "items": { + "type": "string" + } + }, + "calendar": { + "type": "number", + "format": "float", + "description": "Calendar" + }, + "dateInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "dateTimeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "instance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "lenient": { + "type": "boolean", + "description": "Determines the leniency of the date format." + }, + "numberFormat": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "timeInstance": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "timeZone": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." + } + } + }, + "EntityMutationResult": { + "type": "object", + "description": "The mutation response result of entity.", + "properties": { + "guidAssignments": { + "type": "object", + "description": "A map of GUID assignments with entities.", + "additionalProperties": { + "type": "string" + } + }, + "mutatedEntities": { + "type": "object", + "description": "The entity headers of mutated entities.", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "partialUpdatedEntities": { + "type": "array", + "description": "An array of entity headers that partially updated.", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "EntityStatus": { + "type": "string", + "description": "Status - can be active or deleted", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "The status is deleted." + } + ] + } + }, + "FilterOperator": { + "type": "string", + "description": "Search Filter Operator", + "enum": [ + "eq", + "ne", + "gt", + "lt", + "ge", + "le", + "contains", + "startswith", + "prefix", + "timerange", + "exists" + ], + "x-ms-enum": { + "name": "FilterOperator", + "modelAsString": true, + "values": [ + { + "name": "eq", + "value": "eq", + "description": "equal" + }, + { + "name": "ne", + "value": "ne", + "description": "not equal" + }, + { + "name": "gt", + "value": "gt", + "description": "greater than" + }, + { + "name": "lt", + "value": "lt", + "description": "less than" + }, + { + "name": "ge", + "value": "ge", + "description": "greater than or equal to" + }, + { + "name": "le", + "value": "le", + "description": "less than or equal to" + }, + { + "name": "contains", + "value": "contains", + "description": "contains" + }, + { + "name": "startswith", + "value": "startswith", + "description": "start with" + }, + { + "name": "prefix", + "value": "prefix", + "description": "prefix" + }, + { + "name": "timerange", + "value": "timerange", + "description": "time range" + }, + { + "name": "exists", + "value": "exists", + "description": "exists" + } + ] + } + }, + "ImportInfo": { + "type": "object", + "description": "ImportInfo", + "properties": { + "childObjectName": { + "type": "string", + "description": "childObjectName" + }, + "importStatus": { + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "type": "string", + "description": "parentObjectName" + }, + "remarks": { + "type": "string", + "description": "remarks" + } + } + }, + "ImportStatus": { + "type": "string", + "description": "Status for import", + "enum": [ + "SUCCESS", + "FAILED" + ], + "x-ms-enum": { + "name": "ImportStatus", + "modelAsString": true, + "values": [ + { + "name": "Success", + "value": "SUCCESS", + "description": "Success" + }, + { + "name": "Failed", + "value": "FAILED", + "description": "Failed" + } + ] + } + }, + "LineageDirection": { + "type": "string", + "description": "Lineage direction", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + "LineageRelation": { + "type": "object", + "description": "The lineage relation with GUID of the from and to entity.", + "properties": { + "fromEntityId": { + "type": "string", + "description": "The GUID of from-entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "toEntityId": { + "type": "string", + "description": "The GUID of to-entity." + } + } + }, + "MoveEntitiesOptions": { + "type": "object", + "description": "MoveEntitiesContent", + "properties": { + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } + } + } + }, + "NumberFormat": { + "type": "object", + "description": "The number format.", + "properties": { + "availableLocales": { + "type": "array", + "description": "The number format.", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string", + "description": "The currency." + }, + "currencyInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "groupingUsed": { + "type": "boolean", + "description": "Determines if grouping is used." + }, + "instance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "integerInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "maximumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of fraction digits." + }, + "maximumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of integer digits." + }, + "minimumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of fraction digits." + }, + "minimumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of integer digits." + }, + "numberInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "parseIntegerOnly": { + "type": "boolean", + "description": "Determines if only integer is parsed." + }, + "percentInstance": { + "$ref": "#/definitions/NumberFormat", + "description": "The number format." + }, + "roundingMode": { + "$ref": "#/definitions/RoundingMode", + "description": "The enum of rounding mode." + } + } + }, + "PList": { + "type": "object", + "description": "Paginated-list, for returning search results.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." + } + } + }, + "ParentRelation": { + "type": "object", + "description": "The lineage parents relation with GUID of the parent entity and to child entity.", + "properties": { + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + } + }, + "PurviewObjectId": { + "type": "object", + "description": "PurviewObjectId", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "name": { + "type": "string", + "description": "Name" + }, + "displayText": { + "type": "string", + "description": "Display text" + }, + "itemPath": { + "type": "string", + "description": "Item path" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": {} + } + } + }, + "QueryOptions": { + "type": "object", + "description": "The search query of advanced search request.", + "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\nvalue is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} + }, + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, + "QueryResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "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", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + } + }, + "RelationshipCategory": { + "type": "string", + "description": "Relationship Category", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true, + "values": [ + { + "name": "Association", + "value": "ASSOCIATION", + "description": "association" + }, + { + "name": "Aggregation", + "value": "AGGREGATION", + "description": "aggregation" + }, + { + "name": "Composition", + "value": "COMPOSITION", + "description": "composition" + } + ] + } + }, + "ResourceLink": { + "type": "object", + "description": "ResourceLink", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } + } + }, + "RoundingMode": { + "type": "string", + "description": "Rounding Mode", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true, + "values": [ + { + "name": "Up", + "value": "UP", + "description": "up" + }, + { + "name": "Down", + "value": "DOWN", + "description": "down" + }, + { + "name": "Ceiling", + "value": "CEILING", + "description": "ceiling" + }, + { + "name": "Floor", + "value": "FLOOR", + "description": "floor" + }, + { + "name": "HalfUp", + "value": "HALF_UP", + "description": "half up" + }, + { + "name": "HalfDown", + "value": "HALF_DOWN", + "description": "half down" + }, + { + "name": "HalfEven", + "value": "HALF_EVEN", + "description": "half even" + }, + { + "name": "Unnecessary", + "value": "UNNECESSARY", + "description": "unnecessary" + } + ] + } + }, + "SearchFacetItem": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "$ref": "#/definitions/SearchFacetSort", + "description": "Define the sorting criteria for items" + } + } + }, + "SearchFacetItemValue": { + "type": "object", + "description": "The content of a search facet result item.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + } + }, + "SearchFacetResultValue": { + "type": "object", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "properties": { + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "assetType": { + "type": "array", + "description": "Asset type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "classification": { + "type": "array", + "description": "Classification", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "term": { + "type": "array", + "description": "Term", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactId": { + "type": "array", + "description": "Contact id", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactType": { + "type": "array", + "description": "Contact type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "label": { + "type": "array", + "description": "Label", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "glossaryType": { + "type": "array", + "description": "Glossary type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termStatus": { + "type": "array", + "description": "Term status", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termTemplate": { + "type": "array", + "description": "Term template", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + } + } + }, + "SearchFacetSort": { + "type": "object", + "description": "The sorting criteria", + "properties": { + "count": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by count" + }, + "value": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by value" + } + } + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "properties": { + "id": { + "type": "array", + "description": "Id", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "description": "Qualified name", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "type": "string" + } + } + } + }, + "SearchResultValue": { + "type": "object", + "description": "The value item of the search result.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "x-ms-client-name": "searchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" + }, + "x-ms-identifiers": [] + }, + "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\nAtlasGlossaryCategory." + }, + "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." + } + } + }, + "SearchSortOrder": { + "type": "string", + "description": "Search sort order", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "SearchSortOrder", + "modelAsString": true, + "values": [ + { + "name": "Ascend", + "value": "asc", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "desc", + "description": "Use descending order for sorting" + } + ] + } + }, + "SearchTaxonomySetting": { + "type": "object", + "description": "Taxonomy setting for search request", + "properties": { + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, + "SortType": { + "type": "string", + "description": "Type for sorting", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "NONE", + "description": "No sorting order" + }, + { + "name": "Ascend", + "value": "ASC", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "DESC", + "description": "Use descending order for sorting" + } + ] + } + }, + "StatusAtlasRelationship": { + "type": "string", + "description": "Status for atlas relationship", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "StatusAtlasRelationship", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "deleted" + } + ] + } + }, + "SuggestOptions": { + "type": "object", + "description": "The query of suggest request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the search." + } + } + }, + "SuggestResult": { + "type": "object", + "description": "The result item of the search suggest.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + } + }, + "SuggestResultValue": { + "type": "object", + "description": "The value item of the search suggest.", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", + "x-ms-client-name": "searchText" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to\ndistinguish 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" + }, + "x-ms-identifiers": [] + }, + "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\nAtlasGlossaryCategory." + }, + "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." + } + } + }, + "TermSearchResultValue": { + "type": "object", + "description": "The context.", + "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." + } + } + }, + "TermStatus": { + "type": "string", + "description": "Status for term", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "Draft", + "description": "draft" + }, + { + "name": "Approved", + "value": "Approved", + "description": "approved" + }, + { + "name": "Alert", + "value": "Alert", + "description": "alert" + }, + { + "name": "Expired", + "value": "Expired", + "description": "expired" + } + ] + } + }, + "TermTemplateDef": { + "type": "object", + "description": "Term template definition for glossary term.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + } + } + }, + "TimeBoundary": { + "type": "object", + "description": "Captures time-boundary details", + "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." + } + } + }, + "TimeZone": { + "type": "object", + "description": "The timezone information.", + "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", + "description": "The timezone information." + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + } + }, + "TypeCategory": { + "type": "string", + "description": "Type Category", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } + }, + "TypeDef": { + "type": "string", + "description": "Type", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "TypeDef", + "modelAsString": true, + "values": [ + { + "name": "Enum", + "value": "enum", + "description": "enum" + }, + { + "name": "Entity", + "value": "entity", + "description": "entity" + }, + { + "name": "Classification", + "value": "classification", + "description": "classification" + }, + { + "name": "Relationship", + "value": "relationship", + "description": "relationship" + }, + { + "name": "Struct", + "value": "struct", + "description": "struct" + }, + { + "name": "TermTemplate", + "value": "term_template", + "description": "term template" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} From a77264c028156db7d9ad978ae7058e427f12eecb Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 13:52:20 +0800 Subject: [PATCH 090/132] Update purviewdatamap.json --- .../stable/2023-09-01/purviewdatamap.json | 177 ++++++++---------- 1 file changed, 81 insertions(+), 96 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index ea558592b25a..9a6a3148152d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -64,7 +64,7 @@ "parameters": [ { "in": "body", - "name": "entity", + "name": "body", "description": "Atlas entity with extended information.", "required": true, "schema": { @@ -161,7 +161,7 @@ "parameters": [ { "in": "body", - "name": "entities", + "name": "body", "description": "An array of entities to create or update.", "required": true, "schema": { @@ -249,7 +249,7 @@ "parameters": [ { "in": "body", - "name": "request", + "name": "body", "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { @@ -503,7 +503,7 @@ }, { "in": "body", - "name": "classifications", + "name": "body", "description": "An array of classifications to be added.", "required": true, "schema": { @@ -544,7 +544,7 @@ }, { "in": "body", - "name": "classifications", + "name": "body", "description": "An array of classifications to be updated.", "required": true, "schema": { @@ -638,7 +638,7 @@ }, { "in": "body", - "name": "atlasEntityWithExtInfo", + "name": "body", "description": "Atlas entity with extended information.", "required": true, "schema": { @@ -765,7 +765,7 @@ }, { "in": "body", - "name": "atlasClassificationArray", + "name": "body", "description": "An array of classification to be added.", "required": true, "schema": { @@ -813,7 +813,7 @@ }, { "in": "body", - "name": "atlasClassificationArray", + "name": "body", "description": "An array of classification to be updated.", "required": true, "schema": { @@ -853,7 +853,7 @@ "parameters": [ { "in": "body", - "name": "entityHeaders", + "name": "body", "description": "Atlas entity headers.", "required": true, "schema": { @@ -980,7 +980,7 @@ "$ref": "#/parameters/guid" }, { - "name": "businessMetadata", + "name": "body", "required": false, "in": "body", "schema": { @@ -1026,7 +1026,7 @@ "required": false }, { - "name": "businessMetadata", + "name": "body", "required": false, "in": "body", "schema": { @@ -1074,7 +1074,7 @@ "$ref": "#/parameters/guid" }, { - "name": "businessMetadataAttributes", + "name": "body", "required": false, "in": "body", "schema": { @@ -1120,7 +1120,7 @@ "$ref": "#/parameters/guid" }, { - "name": "businessMetadataAttributes", + "name": "body", "required": false, "in": "body", "schema": { @@ -1527,7 +1527,7 @@ }, { "in": "body", - "name": "moveEntitiesRequest", + "name": "body", "description": "Entity guids to be moved to target collection.", "required": true, "schema": { @@ -1556,7 +1556,7 @@ "tags": [ "Glossary" ], - "description": "Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "description": "Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "operationId": "Glossary_List", "x-ms-examples": { "Glossary_List": { @@ -1612,7 +1612,7 @@ "parameters": [ { "in": "body", - "name": "atlasGlossary", + "name": "body", "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing the anchor attribute when creating the Term/Category.", "required": true, "schema": { @@ -1651,7 +1651,7 @@ "parameters": [ { "in": "body", - "name": "glossaryCategory", + "name": "body", "description": "An array of glossary category definitions to be created.", "required": true, "schema": { @@ -1698,7 +1698,7 @@ "parameters": [ { "in": "body", - "name": "glossaryCategory", + "name": "body", "description": "The glossary category definition. A category must be anchored to a Glossary when creating.\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation.", "required": true, "schema": { @@ -1722,7 +1722,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}": { + "/atlas/v2/glossary/category/{categoryId}": { "get": { "tags": [ "Glossary" @@ -1736,7 +1736,7 @@ }, "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/categoryId" } ], "responses": { @@ -1767,11 +1767,11 @@ }, "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/categoryId" }, { "in": "body", - "name": "glossaryCategory", + "name": "body", "description": "The glossary category to be updated.", "required": true, "schema": { @@ -1807,7 +1807,7 @@ }, "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/categoryId" } ], "responses": { @@ -1823,7 +1823,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}/partial": { + "/atlas/v2/glossary/category/{categoryId}/partial": { "put": { "tags": [ "Glossary" @@ -1837,11 +1837,11 @@ }, "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/categoryId" }, { "in": "body", - "name": "partialUpdates", + "name": "body", "description": "A map containing keys as attribute names and values as corresponding attribute values for partial update.", "required": true, "schema": { @@ -1866,7 +1866,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}/related": { + "/atlas/v2/glossary/category/{categoryId}/related": { "get": { "tags": [ "Glossary" @@ -1880,7 +1880,7 @@ }, "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/categoryId" }, { "$ref": "#/parameters/limit" @@ -1908,7 +1908,7 @@ } } }, - "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "/atlas/v2/glossary/category/{categoryId}/terms": { "get": { "tags": [ "Glossary" @@ -1922,7 +1922,7 @@ }, "parameters": [ { - "$ref": "#/parameters/categoryGuid" + "$ref": "#/parameters/categoryId" }, { "$ref": "#/parameters/limit" @@ -1972,7 +1972,7 @@ "parameters": [ { "in": "body", - "name": "glossaryTerm", + "name": "body", "description": "The glossary term definition. A term must be anchored to a Glossary at the time of creation.\nOptionally it can be categorized as well.", "required": true, "schema": { @@ -1999,7 +1999,7 @@ } } }, - "/atlas/v2/glossary/term/{termGuid}": { + "/atlas/v2/glossary/term/{termId}": { "get": { "tags": [ "Glossary" @@ -2019,7 +2019,7 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" } ], "responses": { @@ -2053,11 +2053,11 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" }, { "in": "body", - "name": "glossaryTerm", + "name": "body", "description": "The glossary term to be updated.", "required": true, "schema": { @@ -2096,7 +2096,7 @@ }, "parameters": [ { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" } ], "responses": { @@ -2112,7 +2112,7 @@ } } }, - "/atlas/v2/glossary/term/{termGuid}/partial": { + "/atlas/v2/glossary/term/{termId}/partial": { "put": { "tags": [ "Glossary" @@ -2129,14 +2129,14 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" }, { "$ref": "#/parameters/includeTermHierarchy" }, { "in": "body", - "name": "partialUpdates", + "name": "body", "description": "A map containing keys as attribute names and values as corresponding attribute values to be updated.", "required": true, "schema": { @@ -2179,7 +2179,7 @@ }, { "in": "body", - "name": "glossaryTerm", + "name": "body", "description": "An array of glossary term definitions to be created in bulk.", "required": true, "schema": { @@ -2214,7 +2214,7 @@ } } }, - "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "/atlas/v2/glossary/terms/{termId}/assignedEntities": { "get": { "tags": [ "Glossary" @@ -2228,7 +2228,7 @@ }, "parameters": [ { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" }, { "$ref": "#/parameters/limit" @@ -2272,11 +2272,11 @@ }, "parameters": [ { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" }, { "in": "body", - "name": "relatedObjectIds", + "name": "body", "description": "An array of related object IDs to which the term has to be associated.", "required": true, "schema": { @@ -2313,11 +2313,11 @@ }, "parameters": [ { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" }, { "in": "body", - "name": "relatedObjectIds", + "name": "body", "description": "An array of related object IDs from which the term has to be dissociated.", "required": true, "schema": { @@ -2342,7 +2342,7 @@ } } }, - "/atlas/v2/glossary/terms/{termGuid}/related": { + "/atlas/v2/glossary/terms/{termId}/related": { "get": { "tags": [ "Glossary" @@ -2359,7 +2359,7 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/termGuid" + "$ref": "#/parameters/termId" }, { "$ref": "#/parameters/limit" @@ -2387,7 +2387,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}": { + "/atlas/v2/glossary/{glossaryId}": { "get": { "tags": [ "Glossary" @@ -2401,7 +2401,7 @@ }, "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" } ], "responses": { @@ -2435,14 +2435,14 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" }, { "$ref": "#/parameters/ignoreTermsAndCategories" }, { "in": "body", - "name": "updatedGlossary", + "name": "body", "description": "The glossary definition to be updated.", "required": true, "schema": { @@ -2478,7 +2478,7 @@ }, "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" } ], "responses": { @@ -2494,7 +2494,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories": { + "/atlas/v2/glossary/{glossaryId}/categories": { "get": { "tags": [ "Glossary" @@ -2508,7 +2508,7 @@ }, "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" }, { "$ref": "#/parameters/limit" @@ -2540,7 +2540,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { + "/atlas/v2/glossary/{glossaryId}/categories/headers": { "get": { "tags": [ "Glossary" @@ -2554,7 +2554,7 @@ }, "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" }, { "$ref": "#/parameters/limit" @@ -2586,12 +2586,12 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "/atlas/v2/glossary/{glossaryId}/detailed": { "get": { "tags": [ "Glossary" ], - "description": "Get a specific glossary with detailed information. This API is not recommend.\n\nRecommend to fetch terms/categories details separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "description": "Get a specific glossary with detailed information. This API is not recommend.\n\nRecommend to fetch terms/categories details separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "operationId": "Glossary_GetDetailed", "x-ms-examples": { "Glossary_GetDetailed": { @@ -2603,7 +2603,7 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" } ], "responses": { @@ -2622,7 +2622,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/partial": { + "/atlas/v2/glossary/{glossaryId}/partial": { "put": { "tags": [ "Glossary" @@ -2639,14 +2639,14 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" }, { "$ref": "#/parameters/ignoreTermsAndCategories" }, { "in": "body", - "name": "partialUpdates", + "name": "body", "description": "A map containing keys as attribute names and values as corresponding attribute values.", "required": true, "schema": { @@ -2671,7 +2671,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/terms": { + "/atlas/v2/glossary/{glossaryId}/terms": { "get": { "tags": [ "Glossary" @@ -2688,7 +2688,7 @@ "$ref": "#/parameters/atlasAPIVersion" }, { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" }, { "$ref": "#/parameters/limit" @@ -2720,7 +2720,7 @@ } } }, - "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "/atlas/v2/glossary/{glossaryId}/terms/headers": { "get": { "tags": [ "Glossary" @@ -2734,7 +2734,7 @@ }, "parameters": [ { - "$ref": "#/parameters/glossaryGuid" + "$ref": "#/parameters/glossaryId" }, { "$ref": "#/parameters/limit" @@ -2841,7 +2841,7 @@ "parameters": [ { "in": "body", - "name": "searchRequest", + "name": "body", "description": "An object specifying the search criteria.", "required": true, "schema": { @@ -2883,7 +2883,7 @@ "parameters": [ { "in": "body", - "name": "suggestRequest", + "name": "body", "description": "An object specifying the suggest criteria.", "required": true, "schema": { @@ -2925,7 +2925,7 @@ "parameters": [ { "in": "body", - "name": "autoCompleteRequest", + "name": "body", "description": "An object specifying the autocomplete criteria.", "required": true, "schema": { @@ -3101,7 +3101,7 @@ "parameters": [ { "in": "body", - "name": "relationship", + "name": "body", "description": "The AtlasRelationship object containing the information for the relationship to be created.", "required": true, "schema": { @@ -3138,7 +3138,7 @@ "parameters": [ { "in": "body", - "name": "relationship", + "name": "body", "description": "The AtlasRelationship object containing the information for the relationship to be created.", "required": true, "schema": { @@ -3793,7 +3793,7 @@ "parameters": [ { "in": "body", - "name": "typesDef", + "name": "body", "description": "A composite wrapper object with corresponding lists of the type definition.", "required": true, "schema": { @@ -3830,7 +3830,7 @@ "parameters": [ { "in": "body", - "name": "typesDef", + "name": "body", "description": "A composite object that captures all type definition changes.", "required": true, "schema": { @@ -3867,7 +3867,7 @@ "parameters": [ { "in": "body", - "name": "typesDef", + "name": "body", "description": "A composite object that captures all types to be deleted", "required": true, "schema": { @@ -5955,11 +5955,6 @@ }, "description": "The number format." }, - "TermGuid": { - "type": "string", - "title": "termGuid", - "description": "The globally unique identifier for glossary term." - }, "PList": { "type": "object", "properties": { @@ -6815,8 +6810,8 @@ "maxLength": 4096, "x-ms-parameter-location": "method" }, - "categoryGuid": { - "name": "categoryGuid", + "categoryId": { + "name": "categoryId", "description": "The globally unique identifier of the category.", "in": "path", "required": true, @@ -6852,8 +6847,8 @@ "default": "ASC", "x-ms-parameter-location": "method" }, - "termGuid": { - "name": "termGuid", + "termId": { + "name": "termId", "in": "path", "description": "The globally unique identifier for glossary term.", "required": true, @@ -6872,8 +6867,8 @@ "maxLength": 4096, "x-ms-parameter-location": "method" }, - "glossaryGuid": { - "name": "glossaryGuid", + "glossaryId": { + "name": "glossaryId", "in": "path", "description": "The globally unique identifier for glossary.", "required": true, @@ -6882,16 +6877,6 @@ "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", From e5c83892f31f47c028ea8cca9c9fbecac1ffe12f Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 4 Jan 2024 14:01:39 +0800 Subject: [PATCH 091/132] Update purviewdatamap.json --- .../stable/2023-09-01/purviewdatamap.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 9a6a3148152d..504f71cecf2b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1047,7 +1047,7 @@ } } }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { "delete": { "tags": [ "Entity" @@ -1064,7 +1064,7 @@ }, "parameters": [ { - "name": "bmName", + "name": "businessMetadataName", "in": "path", "type": "string", "description": "BusinessMetadata name", @@ -1110,7 +1110,7 @@ }, "parameters": [ { - "name": "bmName", + "name": "businessMetadataName", "in": "path", "type": "string", "description": "BusinessMetadata name", From da258da0c090e01b16d538f1b6fbb3dd242c2777 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 10 Jan 2024 15:38:09 +0800 Subject: [PATCH 092/132] update --- .../models.tsp | 36 ++++++---- .../stable/2023-09-01/openapi.json | 72 +++++++++---------- 2 files changed, 60 insertions(+), 48 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index f9d6c739535f..61fdaa18a022 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -290,7 +290,8 @@ model AtlasEntity { classifications?: AtlasClassification[]; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @@ -334,7 +335,8 @@ removed. status?: EntityStatus; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; @@ -677,13 +679,15 @@ model AtlasGlossaryBaseObject { lastModifiedTS?: string; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; @@ -1087,10 +1091,12 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The last update time of the record. The Unix epoch format.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The GUID of the record.") id?: string; @@ -1247,10 +1253,12 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The last update time of the record. The Unix epoch format.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The GUID of the record.") id?: string; @@ -1401,7 +1409,8 @@ model AtlasRelationship { ...AtlasStruct; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @@ -1428,7 +1437,8 @@ model AtlasRelationship { status?: StatusAtlasRelationship; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; @@ -1517,7 +1527,8 @@ model AtlasBaseTypeDef { category?: TypeCategory; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @@ -1544,7 +1555,8 @@ model AtlasBaseTypeDef { typeVersion?: string; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index a7bee6134c9d..e89949b81bc4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -4807,7 +4807,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4847,7 +4847,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4875,7 +4875,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4915,7 +4915,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4990,7 +4990,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5030,7 +5030,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5179,7 +5179,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5245,7 +5245,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5279,7 +5279,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5319,7 +5319,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5492,7 +5492,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5532,7 +5532,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5708,7 +5708,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5717,7 +5717,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5788,7 +5788,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5797,7 +5797,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5844,7 +5844,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5853,7 +5853,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5924,7 +5924,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5933,7 +5933,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6036,7 +6036,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6045,7 +6045,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6441,7 +6441,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6479,7 +6479,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6578,7 +6578,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6618,7 +6618,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6736,7 +6736,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6776,7 +6776,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6977,7 +6977,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -7017,7 +7017,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -8204,12 +8204,12 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -8448,12 +8448,12 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -8609,7 +8609,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -8649,7 +8649,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { From 935554de57097d035ea00657f2a4f5023f71ac59 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 11 Jan 2024 10:52:39 +0800 Subject: [PATCH 093/132] update --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 2 +- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 4 ++-- .../stable/2023-09-01/openapi.json | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 61fdaa18a022..9fd1fc4c34d1 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -211,7 +211,7 @@ enum RelationshipCategory { } @doc("Type") -enum TypeDef { +enum TypeFilter { @doc("enum") Enum: "enum", diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 26af3b91725f..09f019d53c2f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -2131,7 +2131,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type?: TypeDef; + type?: TypeFilter; }, AtlasTypesDef, {}, @@ -2206,7 +2206,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type?: TypeDef; + type?: TypeFilter; }, OkResponse, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index e89949b81bc4..b8be95bf9e2b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -4050,7 +4050,7 @@ "term_template" ], "x-ms-enum": { - "name": "TypeDef", + "name": "TypeFilter", "modelAsString": true, "values": [ { @@ -4255,7 +4255,7 @@ "term_template" ], "x-ms-enum": { - "name": "TypeDef", + "name": "TypeFilter", "modelAsString": true, "values": [ { @@ -8800,7 +8800,7 @@ ] } }, - "TypeDef": { + "TypeFilter": { "type": "string", "description": "Type", "enum": [ @@ -8812,7 +8812,7 @@ "term_template" ], "x-ms-enum": { - "name": "TypeDef", + "name": "TypeFilter", "modelAsString": true, "values": [ { From 54d7fc78ef9f37a94c802b776ae2ab2a805f2ef0 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 11 Jan 2024 13:04:49 +0800 Subject: [PATCH 094/132] update --- .../client.tsp | 20 +- .../models.tsp | 21 --- .../routes.tsp | 4 +- .../stable/2023-09-01/openapi.json | 172 +++++++++--------- 4 files changed, 98 insertions(+), 119 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 8eb8854914c8..bfaf0c69db90 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -27,14 +27,14 @@ interface Entity { getClassifications is PurviewDataMap.Entity.getClassifications; addClassifications is PurviewDataMap.Entity.addClassifications; updateClassifications is PurviewDataMap.Entity.updateClassifications; - getByAttributes is PurviewDataMap.Entity.getByUniqueAttributes; - updateByAttributes is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; - deleteByAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; - removeClassificationByAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; - addClassificationsByAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; - updateClassificationsByAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute; + getByUniqueAttribute is PurviewDataMap.Entity.getByUniqueAttributes; + updateByUniqueAttribute is PurviewDataMap.Entity.partialUpdateByUniqueAttributes; + deleteByUniqueAttribute is PurviewDataMap.Entity.deleteByUniqueAttribute; + removeClassificationByUniqueAttribute is PurviewDataMap.Entity.removeClassificationByUniqueAttribute; + addClassificationsByUniqueAttribute is PurviewDataMap.Entity.addClassificationsByUniqueAttribute; + updateClassificationsUniqueByAttribute is PurviewDataMap.Entity.updateClassificationsByUniqueAttribute; batchSetClassifications is PurviewDataMap.Entity.bulkSetClassifications; - batchGetByAttributes is PurviewDataMap.Entity.listByUniqueAttributes; + batchGetByUniqueAttributes is PurviewDataMap.Entity.listByUniqueAttributes; getHeader is PurviewDataMap.Entity.getHeader; removeBusinessMetadata is PurviewDataMap.Entity.removeBusinessMetadata; addOrUpdateBusinessMetadata is PurviewDataMap.Entity.addOrUpdateBusinessMetadata; @@ -46,9 +46,9 @@ interface Entity { removeLabels is PurviewDataMap.Entity.removeLabels; setLabels is PurviewDataMap.Entity.setLabels; addLabel is PurviewDataMap.Entity.addLabel; - removeLabelsByAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute; - setLabelsByAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute; - addLabelsByAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute; + removeLabelsByUniqueAttribute is PurviewDataMap.Entity.removeLabelsByUniqueAttribute; + setLabelsByUniqueAttribute is PurviewDataMap.Entity.setLabelsByUniqueAttribute; + addLabelsByUniqueAttribute is PurviewDataMap.Entity.addLabelsByUniqueAttribute; moveEntitiesToCollection is PurviewDataMap.Entity.moveEntitiesToCollection; } diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 9fd1fc4c34d1..fe918207cf1f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -210,27 +210,6 @@ enum RelationshipCategory { Composition: "COMPOSITION", } -@doc("Type") -enum TypeFilter { - @doc("enum") - Enum: "enum", - - @doc("entity") - Entity: "entity", - - @doc("classification") - Classification: "classification", - - @doc("relationship") - Relationship: "relationship", - - @doc("struct") - Struct: "struct", - - @doc("term template") - TermTemplate: "term_template", -} - @doc("Search Filter Operator") enum FilterOperator { @doc("equal") diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 09f019d53c2f..654fc28245c8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -2131,7 +2131,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type?: TypeFilter; + type?: TypeCategory; }, AtlasTypesDef, {}, @@ -2206,7 +2206,7 @@ when search filter type=term_template @doc("Typedef name as search filter when get typedefs.") @query - type?: TypeFilter; + type?: TypeCategory; }, OkResponse, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index b8be95bf9e2b..99efe8cc3302 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -4042,45 +4042,69 @@ "required": false, "type": "string", "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" ], "x-ms-enum": { - "name": "TypeFilter", + "name": "TypeCategory", "modelAsString": true, "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, { "name": "Enum", - "value": "enum", + "value": "ENUM", "description": "enum" }, { - "name": "Entity", - "value": "entity", - "description": "entity" + "name": "Struct", + "value": "STRUCT", + "description": "struct" }, { "name": "Classification", - "value": "classification", + "value": "CLASSIFICATION", "description": "classification" }, { - "name": "Relationship", - "value": "relationship", - "description": "relationship" + "name": "Entity", + "value": "ENTITY", + "description": "entity" }, { - "name": "Struct", - "value": "struct", - "description": "struct" + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" }, { "name": "TermTemplate", - "value": "term_template", + "value": "TERM_TEMPLATE", "description": "term template" } ] @@ -4247,45 +4271,69 @@ "required": false, "type": "string", "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" ], "x-ms-enum": { - "name": "TypeFilter", + "name": "TypeCategory", "modelAsString": true, "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, { "name": "Enum", - "value": "enum", + "value": "ENUM", "description": "enum" }, { - "name": "Entity", - "value": "entity", - "description": "entity" + "name": "Struct", + "value": "STRUCT", + "description": "struct" }, { "name": "Classification", - "value": "classification", + "value": "CLASSIFICATION", "description": "classification" }, { - "name": "Relationship", - "value": "relationship", - "description": "relationship" + "name": "Entity", + "value": "ENTITY", + "description": "entity" }, { - "name": "Struct", - "value": "struct", - "description": "struct" + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" }, { "name": "TermTemplate", - "value": "term_template", + "value": "TERM_TEMPLATE", "description": "term template" } ] @@ -8799,54 +8847,6 @@ } ] } - }, - "TypeFilter": { - "type": "string", - "description": "Type", - "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" - ], - "x-ms-enum": { - "name": "TypeFilter", - "modelAsString": true, - "values": [ - { - "name": "Enum", - "value": "enum", - "description": "enum" - }, - { - "name": "Entity", - "value": "entity", - "description": "entity" - }, - { - "name": "Classification", - "value": "classification", - "description": "classification" - }, - { - "name": "Relationship", - "value": "relationship", - "description": "relationship" - }, - { - "name": "Struct", - "value": "struct", - "description": "struct" - }, - { - "name": "TermTemplate", - "value": "term_template", - "description": "term template" - } - ] - } } }, "parameters": { From 45f60f67f6906ea3885fed873331e2b75c49d4c3 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 11 Jan 2024 13:15:44 +0800 Subject: [PATCH 095/132] update --- .../examples/2023-09-01/Type_ListEnumDefs.json | 2 +- .../2023-09-01/Type_ListTermTemplateDefs.json | 2 +- .../2023-09-01/examples/Type_ListEnumDefs.json | 2 +- .../examples/Type_ListTermTemplateDefs.json | 2 +- .../stable/2023-09-01/purviewdatamap.json | 12 ++++++------ 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json index c4118ef9957a..17e836217556 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "enum" + "type": "ENUM" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json index c9a13ccd7758..ef6cd055807e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "term_template" + "type": "TERM_TEMPLATE" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index c4118ef9957a..17e836217556 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "enum" + "type": "ENUM" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index c9a13ccd7758..ef6cd055807e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "term_template" + "type": "TERM_TEMPLATE" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 504f71cecf2b..74a7471bb5f6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -7182,12 +7182,12 @@ "required": false, "type": "string", "enum": [ - "enum", - "entity", - "classification", - "relationship", - "struct", - "term_template" + "ENUM", + "ENTITY", + "CLASSIFICATION", + "RELATIONSHIP", + "STRUCT", + "TERM_TEMPLATE" ], "x-ms-enum": { "name": "type", From f48e21cda619709fe27a129f96a134a9a92eb0e9 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 18 Jan 2024 10:35:30 +0800 Subject: [PATCH 096/132] Update models.tsp --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index fe918207cf1f..474c7038d146 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -52,6 +52,7 @@ enum AtlasTermAssignmentStatus { } @doc("Type for sorting") +@projectedName("csharp", "AtlasSortType") enum SortType { @doc("No sorting order") None: "NONE", @@ -1549,6 +1550,7 @@ model AtlasBaseTypeDef { } @doc("The date format.") +@projectedName("csharp", "DateFormat") model DateFormat { @doc("An array of available locales.") availableLocales?: string[]; @@ -1579,6 +1581,7 @@ model DateFormat { } @doc("The number format.") +@projectedName("csharp", "AtlasNumberFormat") model NumberFormat { @doc("The number format.") availableLocales?: string[]; @@ -1624,6 +1627,7 @@ model NumberFormat { } @doc("The timezone information.") +@projectedName("csharp", "AtlasTimeZone") model TimeZone { @doc("The value of the daylight saving time.") dstSavings?: int32; From c9fc2316e40129439b3fefaaf070f8483a825dc8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 18 Jan 2024 10:35:48 +0800 Subject: [PATCH 097/132] Update models.tsp --- .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 474c7038d146..6192effb4142 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -1550,7 +1550,7 @@ model AtlasBaseTypeDef { } @doc("The date format.") -@projectedName("csharp", "DateFormat") +@projectedName("csharp", "AtlasDateFormat") model DateFormat { @doc("An array of available locales.") availableLocales?: string[]; From 0217486d3168074826d3ef60af075c19caf680fa Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 19 Jan 2024 09:59:25 +0800 Subject: [PATCH 098/132] Update readme.md --- specification/purview/data-plane/readme.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index be24c40594c6..915f42bf9353 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -46,6 +46,14 @@ These settings apply only when `--tag=package-2023-09` is specified on the comma input-file: - Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json ``` +### Tag: package-2023-09-datamap + +These settings apply only when `--tag=package-2023-09-datamap` is specified on the command line. + +```yaml $(tag) == 'package-2023-09' +input-file: + - Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +``` ### Tag: package-preview-2023-02 These settings apply only when `--tag=package-preview-2023-02` is specified on the command line. From b414505c35526e7f6c64c9351d2bf97ee95e7ff5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 19 Jan 2024 10:18:29 +0800 Subject: [PATCH 099/132] Update readme.md --- specification/purview/data-plane/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 915f42bf9353..c2bcf584ca42 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -50,7 +50,7 @@ input-file: These settings apply only when `--tag=package-2023-09-datamap` is specified on the command line. -```yaml $(tag) == 'package-2023-09' +```yaml $(tag) == 'package-2023-09-datamap' input-file: - Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json ``` From a371356b8bd9f1417c4dca1bbfce42f4044b57ac Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 26 Jan 2024 11:02:35 +0800 Subject: [PATCH 100/132] update --- .../examples/2023-09-01/Entity_ImportBusinessMetadata.json | 2 +- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 2 +- .../2023-09-01/examples/Entity_ImportBusinessMetadata.json | 2 +- .../stable/2023-09-01/openapi.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json index 7b3743545b30..5717a38aa7c8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "file": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 654fc28245c8..f97257c25052 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -763,7 +763,7 @@ default is false. importBusinessMetadata is AtlasImportOperation< { @doc("InputStream of file") - uploadedInputStream: bytes; + file: bytes; }, BulkImportResult, MultipartFormDataRequestHeadersTraits diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json index 7b3743545b30..5717a38aa7c8 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ImportBusinessMetadata.json @@ -1,7 +1,7 @@ { "parameters": { "Endpoint": "{Endpoint}", - "uploadedInputStream": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" + "file": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"\nContent-Type: application/octet-stream\n\n---multipart-boundary--" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 99efe8cc3302..31f88ec89200 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -455,7 +455,7 @@ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "uploadedInputStream", + "name": "file", "in": "formData", "description": "InputStream of file", "required": true, From 81e432fa280fb12fde48f8e7d1da0d9afd3bf24e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 31 Jan 2024 10:16:50 +0800 Subject: [PATCH 101/132] update --- .../Azure.Analytics.Purview.DataMap/tspconfig.yaml | 1 + specification/purview/data-plane/readme.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 0a9b306457e4..b634cf430ddd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -12,6 +12,7 @@ options: emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/openapi.json" + omit-unreachable-types: true "@azure-tools/typespec-python": package-dir: "azure-purview-datamap" package-name: "{package-dir}" diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index c2bcf584ca42..b43ca1dfa99c 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -303,6 +303,19 @@ See configuration in [readme.python.md](./readme.python.md) ## Suppression +``` yaml +directive: + - suppress: AvoidAnonymousParameter + from: openapi.json + reason: This rule is irrelevant for data-plane TypeSpec specs. + - suppress: AvoidAnonymousTypes + from: openapi.json + reason: This rule is irrelevant for data-plane TypeSpec specs. + - suppress: IntegerTypeMustHaveFormat + from: openapi.json + reason: This rule is irrelevant for SDKs generated directly by TypeSpec. +``` + ``` yaml directive: - suppress: R3013 From b7e79b416517cf20d25d22e7432d31322ad49db2 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 31 Jan 2024 10:22:27 +0800 Subject: [PATCH 102/132] Update openapi.json --- .../stable/2023-09-01/openapi.json | 400 ------------------ 1 file changed, 400 deletions(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json index 31f88ec89200..2cde7be06e2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json @@ -4750,24 +4750,6 @@ } }, "definitions": { - "ApiVersions": { - "type": "string", - "description": "Service API versions", - "enum": [ - "2023-09-01" - ], - "x-ms-enum": { - "name": "ApiVersions", - "modelAsString": true, - "values": [ - { - "name": "v2023_09_01", - "value": "2023-09-01", - "description": "2023-09-01 service API version" - } - ] - } - }, "AtlasAttributeDef": { "type": "object", "description": "class that captures details of a struct-attribute.", @@ -4835,84 +4817,6 @@ } } }, - "AtlasBaseModelObject": { - "type": "object", - "description": "The base model object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - } - } - }, - "AtlasBaseTypeDef": { - "type": "object", - "description": "Base class that captures common-attributes for all types.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, "AtlasBusinessMetadataDef": { "type": "object", "description": "class that captures details of a struct-type.", @@ -5415,19 +5319,6 @@ } } }, - "AtlasEntityExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - } - } - }, "AtlasEntityHeader": { "type": "object", "description": "An instance of an entity - like hive_table, hive_database.", @@ -5647,77 +5538,6 @@ } } }, - "AtlasExtraTypeDef": { - "type": "object", - "description": "Extra properties for a type.", - "properties": { - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, "AtlasGlossary": { "type": "object", "description": "The glossary object.", @@ -5798,62 +5618,6 @@ } } }, - "AtlasGlossaryBaseObject": { - "type": "object", - "description": "The glossary base object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - } - } - }, "AtlasGlossaryCategory": { "type": "object", "description": "The glossary category.", @@ -7228,28 +6992,6 @@ } } }, - "AuthToken": { - "type": "object", - "description": "The Azure Active Directory OAuth2 Flow", - "properties": { - "type": { - "type": "string", - "description": "OAuth2 authentication", - "enum": [ - "oauth2" - ] - }, - "flows": { - "type": "array", - "description": "Supported OAuth2 flows", - "items": {} - } - }, - "required": [ - "type", - "flows" - ] - }, "AutoCompleteOptions": { "type": "object", "description": "The query of autocomplete request.", @@ -7323,36 +7065,6 @@ } } }, - "BusinessAttributeUpdateBehavior": { - "type": "string", - "description": "Enum for business attribute update behavior", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "Ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "Replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "Merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, "CardinalityValue": { "type": "string", "description": "Cardinality", @@ -7534,84 +7246,6 @@ ] } }, - "FilterOperator": { - "type": "string", - "description": "Search Filter Operator", - "enum": [ - "eq", - "ne", - "gt", - "lt", - "ge", - "le", - "contains", - "startswith", - "prefix", - "timerange", - "exists" - ], - "x-ms-enum": { - "name": "FilterOperator", - "modelAsString": true, - "values": [ - { - "name": "eq", - "value": "eq", - "description": "equal" - }, - { - "name": "ne", - "value": "ne", - "description": "not equal" - }, - { - "name": "gt", - "value": "gt", - "description": "greater than" - }, - { - "name": "lt", - "value": "lt", - "description": "less than" - }, - { - "name": "ge", - "value": "ge", - "description": "greater than or equal to" - }, - { - "name": "le", - "value": "le", - "description": "less than or equal to" - }, - { - "name": "contains", - "value": "contains", - "description": "contains" - }, - { - "name": "startswith", - "value": "startswith", - "description": "start with" - }, - { - "name": "prefix", - "value": "prefix", - "description": "prefix" - }, - { - "name": "timerange", - "value": "timerange", - "description": "time range" - }, - { - "name": "exists", - "value": "exists", - "description": "exists" - } - ] - } - }, "ImportInfo": { "type": "object", "description": "ImportInfo", @@ -7788,40 +7422,6 @@ } } }, - "PList": { - "type": "object", - "description": "Paginated-list, for returning search results.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, "ParentRelation": { "type": "object", "description": "The lineage parents relation with GUID of the parent entity and to child entity.", From ddb280187c0b148ff64dc53fb83406ed35055b94 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 31 Jan 2024 14:53:08 +0800 Subject: [PATCH 103/132] move to cSpell.json --- cSpell.json | 6 ++++++ custom-words.txt | 1 - 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/cSpell.json b/cSpell.json index 53edfde971f0..a927fa03d723 100644 --- a/cSpell.json +++ b/cSpell.json @@ -966,6 +966,12 @@ "words": [ "throughputpool" ] + }, + { + "filename": "**/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/**/*.json", + "words": [ + "timerange" + ] } ], "enableFiletypes": [ diff --git a/custom-words.txt b/custom-words.txt index c8b24f722fc9..1d56eb206ca5 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2912,7 +2912,6 @@ timeseries timeseriesinsights timespan timestep -timerange timezones tinyint titledatakeyvalues From 0b87b77fbcfb83a5894d72c59c1fdfcea4c5f78c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 31 Jan 2024 16:37:31 +0800 Subject: [PATCH 104/132] update examples --- .../examples/2023-09-01/Entity_Get.json | 3 ++- .../examples/2023-09-01/Entity_GetByUniqueAttributes.json | 3 ++- .../examples/2023-09-01/Entity_ListByGuids.json | 3 ++- .../examples/2023-09-01/Entity_ListByUniqueAttributes.json | 3 ++- .../stable/2023-09-01/examples/Entity_Get.json | 3 ++- .../2023-09-01/examples/Entity_GetByUniqueAttributes.json | 3 ++- .../stable/2023-09-01/examples/Entity_ListByGuids.json | 3 ++- .../2023-09-01/examples/Entity_ListByUniqueAttributes.json | 3 ++- 8 files changed, 16 insertions(+), 8 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json index 2acf46b04d68..351a57c02c58 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb" + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json index 113dab2d668f..517ce8956b09 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json @@ -2,7 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://exampleaccount.core.windows.net" + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json index ed6951961940..0c99913a7492 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json @@ -4,7 +4,8 @@ "guid": [ "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" - ] + ], + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json index c4ce33dd6345..1b073540597a 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json @@ -2,7 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1" + "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 2acf46b04d68..351a57c02c58 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb" + "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 113dab2d668f..517ce8956b09 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -2,7 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://exampleaccount.core.windows.net" + "attr:qualifiedName": "https://exampleaccount.core.windows.net", + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index ed6951961940..0c99913a7492 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -4,7 +4,8 @@ "guid": [ "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" - ] + ], + "minExtInfo": "true" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index c4ce33dd6345..1b073540597a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -2,7 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1" + "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "minExtInfo": "true" }, "responses": { "200": { From 1c4269cf81619f9d9752f94b2b0003916f929ee4 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Wed, 31 Jan 2024 17:00:41 +0800 Subject: [PATCH 105/132] update examples --- .../examples/2023-09-01/Entity_Get.json | 2 +- .../examples/2023-09-01/Entity_GetByUniqueAttributes.json | 2 +- .../examples/2023-09-01/Entity_ListByGuids.json | 2 +- .../examples/2023-09-01/Entity_ListByUniqueAttributes.json | 2 +- .../stable/2023-09-01/examples/Entity_Get.json | 2 +- .../2023-09-01/examples/Entity_GetByUniqueAttributes.json | 2 +- .../stable/2023-09-01/examples/Entity_ListByGuids.json | 2 +- .../2023-09-01/examples/Entity_ListByUniqueAttributes.json | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json index 351a57c02c58..4c89ab5c8872 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_Get.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json index 517ce8956b09..f7ebf7d7d013 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_GetByUniqueAttributes.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json index 0c99913a7492..4f48451cdbbe 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByGuids.json @@ -5,7 +5,7 @@ "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" ], - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json index 1b073540597a..176e6972162b 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Entity_ListByUniqueAttributes.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json index 351a57c02c58..4c89ab5c8872 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_Get.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json index 517ce8956b09..f7ebf7d7d013 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_GetByUniqueAttributes.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr:qualifiedName": "https://exampleaccount.core.windows.net", - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json index 0c99913a7492..4f48451cdbbe 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByGuids.json @@ -5,7 +5,7 @@ "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "b4ebc8be-cef4-860a-bee9-28cc34cb5caa" ], - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json index 1b073540597a..176e6972162b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Entity_ListByUniqueAttributes.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", "attr_N:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", - "minExtInfo": "true" + "minExtInfo": true }, "responses": { "200": { From 82f66014232f7e0839f8af6c06c95b26201022b9 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 10:11:11 +0800 Subject: [PATCH 106/132] fix api doc preview --- .../tspconfig.yaml | 2 +- .../stable/2023-09-01/openapi.json | 8464 ---------------- .../stable/2023-09-01/purviewdatamap.json | 8932 ++++++++++------- specification/purview/data-plane/readme.md | 7 - 4 files changed, 5074 insertions(+), 12331 deletions(-) delete mode 100644 specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index b634cf430ddd..16d1cc8f38c8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -11,7 +11,7 @@ options: azure-resource-provider-folder: "data-plane" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" - output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/openapi.json" + output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/purviewdatamap.json" omit-unreachable-types: true "@azure-tools/typespec-python": package-dir: "azure-purview-datamap" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json deleted file mode 100644 index 2cde7be06e2e..000000000000 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json +++ /dev/null @@ -1,8464 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Analytics Purview Data Map", - "version": "2023-09-01", - "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}/datamap/api", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "AuthToken": [ - "https://purview.azure.net/.default" - ] - } - ], - "securityDefinitions": { - "AuthToken": { - "type": "oauth2", - "description": "The Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "https://purview.azure.net/.default": "" - } - } - }, - "tags": [], - "paths": { - "/atlas/v2/entity": { - "post": { - "operationId": "Entity_CreateOrUpdate", - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "Ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "Replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "Merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - }, - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" - }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" - } - } - } - }, - "/atlas/v2/entity/bulk": { - "get": { - "operationId": "Entity_ListByGuids", - "description": "List entities in bulk identified by its GUIDs.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to list.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - } - }, - "post": { - "operationId": "Entity_BulkCreateOrUpdate", - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", - "required": false, - "type": "string" - }, - { - "name": "businessAttributeUpdateBehavior", - "in": "query", - "description": "Used to define the update behavior for business attributes when updating\nentities.", - "required": false, - "type": "string", - "enum": [ - "ignore", - "replace", - "merge" - ], - "x-ms-enum": { - "name": "BusinessAttributeUpdateBehavior", - "modelAsString": true, - "values": [ - { - "name": "Ignore", - "value": "ignore", - "description": "Ignore the business attribute payload for update." - }, - { - "name": "Replace", - "value": "replace", - "description": "Replace all the business attributes using the payload." - }, - { - "name": "Merge", - "value": "merge", - "description": "Merge the business attributes. Business attributes will not be updated if not provided." - } - ] - } - }, - { - "name": "body", - "in": "body", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - } - }, - "delete": { - "operationId": "Entity_BulkDelete", - "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "query", - "description": "An array of GUIDs of entities to delete.", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - } - } - }, - "/atlas/v2/entity/bulk/classification": { - "post": { - "operationId": "Entity_AddClassification", - "description": "Associate a classification to multiple entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The request to associate a classification to multiple entities.", - "required": true, - "schema": { - "$ref": "#/definitions/ClassificationAssociateOptions" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "operationId": "Entity_BulkSetClassifications", - "description": "Set classifications on entities in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "Atlas entity headers.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" - } - } - } - }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_ListByUniqueAttributes", - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "operationId": "Entity_ImportBusinessMetadata", - "description": "Upload the file for creating Business Metadata in BULK", - "consumes": [ - "multipart/form-data" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "file", - "in": "formData", - "description": "InputStream of file", - "required": true, - "type": "file" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/BulkImportResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "produces": [ - "application/octet-stream", - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "file" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "operationId": "Entity_Get", - "description": "Get complete definition of an entity given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateAttributeByGuid", - "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "query", - "description": "The name of the attribute.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The value of the attribute.", - "required": true, - "schema": {} - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" - } - } - }, - "delete": { - "operationId": "Entity_Delete", - "description": "Delete an entity identified by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "description": "Add business metadata to an entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "isOverwrite", - "in": "query", - "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", - "required": false, - "type": "boolean", - "x-ms-client-name": "overwrite" - }, - { - "name": "body", - "in": "body", - "description": "BusinessMetadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadata", - "description": "Remove business metadata from an entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Business metadata payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { - "post": { - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "description": "Add or update business metadata attributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "businessMetadataName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddOrUpdate_BusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "description": "Delete business metadata attributes from an entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "businessMetadataName", - "in": "path", - "description": "BusinessMetadata name", - "required": true, - "type": "string" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Business metadata attribute payload", - "required": true, - "schema": { - "type": "object", - "additionalProperties": {} - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { - "get": { - "operationId": "Entity_GetClassification", - "description": "Get classification for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassification" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveClassification", - "description": "Delete a given classification from an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "operationId": "Entity_GetClassifications", - "description": "List classifications for a given entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassifications" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" - } - } - }, - "put": { - "operationId": "Entity_UpdateClassifications", - "description": "Update classifications to an existing entity represented by a guid.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of classifications to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassifications", - "description": "Add classifications to an existing entity represented by a GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of classifications to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "operationId": "Entity_GetHeader", - "description": "Get entity header given its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetHeader": { - "$ref": "./examples/Entity_GetHeader.json" - } - } - } - }, - "/atlas/v2/entity/guid/{guid}/labels": { - "put": { - "operationId": "Entity_AddLabel", - "description": "Add given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_AddLabel.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabels", - "description": "Set labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set to the entity", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabels": { - "$ref": "./examples/Entity_SetLabels.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabels", - "description": "Delete given labels to a given entity.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_RemoveLabels.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Entity_GetByUniqueAttributes", - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "minExtInfo", - "in": "query", - "description": "Whether to return minimal information for referred entities.", - "required": false, - "type": "boolean" - }, - { - "name": "ignoreRelationships", - "in": "query", - "description": "Whether to ignore relationship attributes.", - "required": false, - "type": "boolean" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - } - }, - "put": { - "operationId": "Entity_PartialUpdateByUniqueAttributes", - "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "Atlas entity with extended information.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_PartialUpdateByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" - } - } - }, - "delete": { - "operationId": "Entity_DeleteByUniqueAttribute", - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { - "delete": { - "operationId": "Entity_RemoveClassificationByUniqueAttribute", - "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "classificationName", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "put": { - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "description": "Update classification on an entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "An array of classification to be updated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "description": "Add classification to the entity identified by its type and unique attributes.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "An array of classification to be added.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "put": { - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be added", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" - } - } - }, - "post": { - "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be set", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - } - }, - "delete": { - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - }, - { - "name": "body", - "in": "body", - "description": "set of labels to be deleted", - "required": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/glossary": { - "get": { - "operationId": "Glossary_List", - "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossary" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - } - }, - "post": { - "operationId": "Glossary_Create", - "description": "Create a glossary.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}": { - "get": { - "operationId": "Glossary_Get", - "description": "Get a specific Glossary by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } - } - }, - "put": { - "operationId": "Glossary_Update", - "description": "Update the given glossary.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "The glossary definition to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - } - }, - "delete": { - "operationId": "Glossary_Delete", - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/categories": { - "get": { - "operationId": "Glossary_ListCategories", - "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/categories/headers": { - "get": { - "operationId": "Glossary_ListCategoriesHeaders", - "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/detailed": { - "get": { - "operationId": "Glossary_GetDetailed", - "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/partial": { - "put": { - "operationId": "Glossary_PartialUpdate", - "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "ignoreTermsAndCategories", - "in": "query", - "description": "Whether ignore terms and categories", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/terms": { - "get": { - "operationId": "Glossary_ListTerms", - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" - } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/terms/headers": { - "get": { - "operationId": "Glossary_ListTermHeaders", - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - } - } - }, - "/atlas/v2/glossary/categories": { - "post": { - "operationId": "Glossary_CreateCategories", - "description": "Create glossary category in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An array of glossary category definitions to be created.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "operationId": "Glossary_CreateCategory", - "description": "Create a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}": { - "get": { - "operationId": "Glossary_GetCategory", - "description": "Get specific glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateCategory", - "description": "Update the given glossary category by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The glossary category to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteCategory", - "description": "Delete a glossary category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateCategory", - "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}/related": { - "get": { - "operationId": "Glossary_ListRelatedCategories", - "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - } - } - }, - "/atlas/v2/glossary/category/{categoryId}/terms": { - "get": { - "operationId": "Glossary_ListCategoryTerms", - "description": "Get all terms associated with the specific category.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "categoryId", - "in": "path", - "description": "The globally unique identifier of the category.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - } - } - }, - "/atlas/v2/glossary/term": { - "post": { - "operationId": "Glossary_CreateTerm", - "description": "Create a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termId}": { - "get": { - "operationId": "Glossary_GetTerm", - "description": "Get a specific glossary term by its GUID. ", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" - }, - "Glossary_GetTermWithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" - } - } - }, - "put": { - "operationId": "Glossary_UpdateTerm", - "description": "Update the given glossary term by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "The glossary term to be updated.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTerm", - "description": "Delete a glossary term.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" - } - } - } - }, - "/atlas/v2/glossary/term/{termId}/partial": { - "put": { - "operationId": "Glossary_PartialUpdateTerm", - "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", - "required": true, - "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" - } - } - } - }, - "/atlas/v2/glossary/terms": { - "post": { - "operationId": "Glossary_CreateTerms", - "description": "Create glossary terms in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermHierarchy", - "in": "query", - "description": "Whether include term hierarchy", - "required": false, - "type": "boolean" - }, - { - "name": "body", - "in": "body", - "description": "An array of glossary term definitions to be created in bulk.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termId}/assignedEntities": { - "get": { - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - } - }, - "post": { - "operationId": "Glossary_AssignTermToEntities", - "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of related object IDs to which the term has to be associated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" - } - } - }, - "delete": { - "operationId": "Glossary_DeleteTermAssignmentFromEntities", - "description": "Delete the term assignment for the given list of related objects.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "An array of related object IDs from which the term has to be dissociated.", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" - } - } - } - }, - "/atlas/v2/glossary/terms/{termId}/related": { - "get": { - "operationId": "Glossary_ListRelatedTerms", - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "termId", - "in": "path", - "description": "The globally unique identifier for glossary term.", - "required": true, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "sort", - "in": "query", - "description": "The sort order, ASC (default) or DESC.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "operationId": "Lineage_Get", - "description": "Get lineage info of the entity specified by GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" - } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "operationId": "Lineage_GetByUniqueAttribute", - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "typeName", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - }, - { - "name": "depth", - "in": "query", - "description": "The number of hops for lineage.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", - "required": false, - "type": "string", - "x-ms-client-name": "attribute" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" - } - } - } - }, - "/atlas/v2/relationship": { - "put": { - "operationId": "Relationship_Update", - "description": "Update an existing relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" - } - } - }, - "post": { - "operationId": "Relationship_Create", - "description": "Create a new relationship between entities.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - } - } - }, - "/atlas/v2/relationship/guid/{guid}": { - "get": { - "operationId": "Relationship_Get", - "description": "Get relationship information between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - }, - { - "name": "extendedInfo", - "in": "query", - "description": "Limits whether includes extended information.", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - } - }, - "delete": { - "operationId": "Relationship_Delete", - "description": "Delete a relationship between entities by its GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByGuid", - "description": "Get the businessMetadata definition for the given guid.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "businessMetadata guid", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { - "get": { - "operationId": "Type_GetBusinessMetadataDefByName", - "description": "Get the businessMetadata definition by it's name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "businessMetadata name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/guid/{guid}": { - "get": { - "operationId": "Type_GetClassificationDefByGuid", - "description": "Get the classification definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/classificationdef/name/{name}": { - "get": { - "operationId": "Type_GetClassificationDefByName", - "description": "Get the classification definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the classification.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - } - } - }, - "/atlas/v2/types/entitydef/guid/{guid}": { - "get": { - "operationId": "Type_GetEntityDefByGuid", - "description": "Get the Entity definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/entitydef/name/{name}": { - "get": { - "operationId": "Type_GetEntityDefByName", - "description": "Get the entity definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the entity.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEntityDefByName": { - "$ref": "./examples/Type_GetEntityDefByName.json" - } - } - } - }, - "/atlas/v2/types/enumdef/guid/{guid}": { - "get": { - "operationId": "Type_GetEnumDefByGuid", - "description": "Get the enum definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/enumdef/name/{name}": { - "get": { - "operationId": "Type_GetEnumDefByName", - "description": "Get the enum definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the enum.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasEnumDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/guid/{guid}": { - "get": { - "operationId": "Type_GetRelationshipDefByGuid", - "description": "Get the relationship definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/relationshipdef/name/{name}": { - "get": { - "operationId": "Type_GetRelationshipDefByName", - "description": "Get the relationship definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the relationship.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasRelationshipDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } - } - } - }, - "/atlas/v2/types/structdef/guid/{guid}": { - "get": { - "operationId": "Type_GetStructDefByGuid", - "description": "Get the struct definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByGuid": { - "$ref": "./examples/Type_GetStructDefByGuid.json" - } - } - } - }, - "/atlas/v2/types/structdef/name/{name}": { - "get": { - "operationId": "Type_GetStructDefByName", - "description": "Get the struct definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the struct.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasStructDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - } - } - }, - "/atlas/v2/types/typedef/guid/{guid}": { - "get": { - "operationId": "Type_GetByGuid", - "description": "Get the type definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - } - } - }, - "/atlas/v2/types/typedef/name/{name}": { - "get": { - "operationId": "Type_GetByName", - "description": "Get the type definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypeDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - } - }, - "delete": { - "operationId": "Type_Delete", - "description": "Delete API for type identified by its name.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of the type.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" - } - } - } - }, - "/atlas/v2/types/typedefs": { - "get": { - "operationId": "Type_List", - "description": "List all type definitions in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true, - "values": [ - { - "name": "Primitive", - "value": "PRIMITIVE", - "description": "primitive" - }, - { - "name": "ObjectIdType", - "value": "OBJECT_ID_TYPE", - "description": "object id type" - }, - { - "name": "Enum", - "value": "ENUM", - "description": "enum" - }, - { - "name": "Struct", - "value": "STRUCT", - "description": "struct" - }, - { - "name": "Classification", - "value": "CLASSIFICATION", - "description": "classification" - }, - { - "name": "Entity", - "value": "ENTITY", - "description": "entity" - }, - { - "name": "Array", - "value": "ARRAY", - "description": "array" - }, - { - "name": "Map", - "value": "MAP", - "description": "map" - }, - { - "name": "Relationship", - "value": "RELATIONSHIP", - "description": "relationship" - }, - { - "name": "TermTemplate", - "value": "TERM_TEMPLATE", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - } - }, - "put": { - "operationId": "Type_BulkUpdate", - "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "A composite object that captures all type definition changes.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkUpdate": { - "$ref": "./examples/Type_BulkUpdate.json" - } - } - }, - "post": { - "operationId": "Type_BulkCreate", - "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "A composite wrapper object with corresponding lists of the type definition.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" - }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" - } - } - }, - "delete": { - "operationId": "Type_BulkDelete", - "description": "Delete API for all types in bulk.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "A composite object that captures all types to be deleted", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasTypesDef" - } - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - } - } - }, - "/atlas/v2/types/typedefs/headers": { - "get": { - "operationId": "Type_ListHeaders", - "description": "List all type definitions returned as a list of minimal information header.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "includeTermTemplate", - "in": "query", - "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", - "required": false, - "type": "boolean" - }, - { - "name": "type", - "in": "query", - "description": "Typedef name as search filter when get typedefs.", - "required": false, - "type": "string", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true, - "values": [ - { - "name": "Primitive", - "value": "PRIMITIVE", - "description": "primitive" - }, - { - "name": "ObjectIdType", - "value": "OBJECT_ID_TYPE", - "description": "object id type" - }, - { - "name": "Enum", - "value": "ENUM", - "description": "enum" - }, - { - "name": "Struct", - "value": "STRUCT", - "description": "struct" - }, - { - "name": "Classification", - "value": "CLASSIFICATION", - "description": "classification" - }, - { - "name": "Entity", - "value": "ENTITY", - "description": "entity" - }, - { - "name": "Array", - "value": "ARRAY", - "description": "array" - }, - { - "name": "Map", - "value": "MAP", - "description": "map" - }, - { - "name": "Relationship", - "value": "RELATIONSHIP", - "description": "relationship" - }, - { - "name": "TermTemplate", - "value": "TERM_TEMPLATE", - "description": "term template" - } - ] - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasTypeDefHeader" - }, - "x-ms-identifiers": [] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - } - } - }, - "/entity/moveTo": { - "post": { - "operationId": "Entity_MoveEntitiesToCollection", - "description": "Move existing entities to the target collection.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "collectionId", - "in": "query", - "description": "The collection where entities will be moved to.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/EntityMutationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Entity_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } - } - } - }, - "/lineage/{guid}/next": { - "get": { - "operationId": "Lineage_GetNextPage", - "description": "Return immediate next page lineage info about entity with pagination", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the entity.", - "required": true, - "type": "string" - }, - { - "name": "direction", - "in": "query", - "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", - "required": true, - "type": "string", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - }, - { - "name": "offset", - "in": "query", - "description": "The offset for pagination purpose.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "limit", - "in": "query", - "description": "The page size - by default there is no paging.", - "required": false, - "type": "integer", - "format": "int32" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AtlasLineageInfo" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - } - } - }, - "/search/autocomplete": { - "post": { - "operationId": "Discovery_AutoComplete", - "description": "Get auto complete options.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An object specifying the autocomplete criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/AutoCompleteOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/AutoCompleteResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - } - } - }, - "/search/query": { - "post": { - "operationId": "Discovery_Query", - "description": "Get data using search.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An object specifying the search criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/QueryOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/QueryResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" - }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" - }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" - }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_TermAssignment": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Type": { - "$ref": "./examples/Discovery_Query_Type.json" - } - } - } - }, - "/search/suggest": { - "post": { - "operationId": "Discovery_Suggest", - "description": "Get search suggestions by query criteria.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "An object specifying the suggest criteria.", - "required": true, - "schema": { - "$ref": "#/definitions/SuggestOptions" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/SuggestResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - } - } - }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "operationId": "Type_GetTermTemplateDefByGuid", - "description": "Get the term template definition for the given GUID.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "guid", - "in": "path", - "description": "The globally unique identifier of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - } - } - }, - "/types/termtemplatedef/name/{name}": { - "get": { - "operationId": "Type_GetTermTemplateDefByName", - "description": "Get the term template definition by its name (unique).", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The unique name of the term template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/TermTemplateDef" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/AtlasErrorResponse" - } - } - }, - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" - } - } - } - } - }, - "definitions": { - "AtlasAttributeDef": { - "type": "object", - "description": "class that captures details of a struct-attribute.", - "properties": { - "cardinality": { - "$ref": "#/definitions/CardinalityValue", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - } - } - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassification": { - "type": "object", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityGuid": { - "type": "string", - "description": "The GUID of the entity." - }, - "entityStatus": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "removePropagationsOnEntityDelete": { - "type": "boolean", - "description": "Determines if propagations will be removed on entity deletion." - }, - "validityPeriods": { - "type": "array", - "description": "An array of time boundaries indicating validity periods.", - "items": { - "$ref": "#/definitions/TimeBoundary" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasClassificationDef": { - "type": "object", - "description": "class that captures details of a classification-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - } - } - }, - "AtlasClassifications": { - "type": "object", - "description": "REST serialization friendly list.", - "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": {} - }, - "pageSize": { - "type": "integer", - "format": "int32", - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc." - }, - "startIndex": { - "type": "integer", - "format": "int32", - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int32", - "description": "The total count of items." - } - } - }, - "AtlasConstraintDef": { - "type": "object", - "description": "class that captures details of a constraint.", - "properties": { - "params": { - "type": "object", - "description": "The parameters of the constraint definition.", - "additionalProperties": {} - }, - "type": { - "type": "string", - "description": "The type of the constraint." - } - } - }, - "AtlasEntitiesWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entities": { - "type": "array", - "description": "An array of entities.", - "items": { - "$ref": "#/definitions/AtlasEntity" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntity": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "businessAttributes": { - "type": "object", - "description": "Business attributes", - "additionalProperties": {} - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "customAttributes": { - "type": "object", - "description": "Custom Attribute", - "additionalProperties": { - "type": "string" - } - }, - "guid": { - "type": "string", - "description": "The GUID of the entity." - }, - "homeId": { - "type": "string", - "description": "The home ID of the entity." - }, - "collectionId": { - "type": "string", - "description": "The collection ID of the entity.", - "readOnly": true - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers indicating the meanings of the entity.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship." - }, - "proxy": { - "type": "boolean", - "description": "Determines if there's a proxy." - }, - "relationshipAttributes": { - "type": "object", - "description": "The attributes of relationship.", - "additionalProperties": {} - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the entity." - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactInfo" - }, - "type": "array" - } - } - } - }, - "AtlasEntityDef": { - "type": "object", - "description": "class that captures details of a entity-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEntityHeader": { - "type": "object", - "description": "An instance of an entity - like hive_table, hive_database.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "classificationNames": { - "type": "array", - "description": "An array of classification names.", - "items": { - "type": "string" - } - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "guid": { - "type": "string", - "description": "The GUID of the record." - }, - "isIncomplete": { - "type": "boolean", - "description": "Whether it is a shell entity" - }, - "labels": { - "type": "array", - "description": "labels", - "items": { - "type": "string" - } - }, - "meaningNames": { - "type": "array", - "description": "An array of meanings.", - "items": { - "type": "string" - } - }, - "meanings": { - "type": "array", - "description": "An array of term assignment headers.", - "items": { - "$ref": "#/definitions/AtlasTermAssignmentHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - } - } - }, - "AtlasEntityHeaders": { - "type": "object", - "description": "An instance of an entity header map.", - "properties": { - "guidHeaderMap": { - "type": "object", - "description": "The description of the guid header map,", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - } - } - }, - "AtlasEntityWithExtInfo": { - "type": "object", - "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "entity": { - "$ref": "#/definitions/AtlasEntity", - "description": "An instance of an entity - like hive_table, hive_database." - } - } - }, - "AtlasEnumDef": { - "type": "object", - "description": "class that captures details of an enum-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasEnumElementDef": { - "type": "object", - "description": "class that captures details of an enum-element.", - "properties": { - "description": { - "type": "string", - "description": "The description of the enum element definition." - }, - "ordinal": { - "type": "integer", - "format": "int32", - "description": "The ordinal of the enum element definition." - }, - "value": { - "type": "string", - "description": "The value of the enum element definition." - } - } - }, - "AtlasErrorResponse": { - "type": "object", - "description": "An error response from the service", - "properties": { - "requestId": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The request ID." - }, - "errorCode": { - "type": "string", - "description": "The error code." - }, - "errorMessage": { - "type": "string", - "description": "The error message." - } - } - }, - "AtlasGlossary": { - "type": "object", - "description": "The glossary object.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - } - } - }, - "AtlasGlossaryCategory": { - "type": "object", - "description": "The glossary category.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "childrenCategories": { - "type": "array", - "description": "An array of children categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader", - "description": "The header of the related category." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasGlossaryExtInfo": { - "type": "object", - "description": "The extended information of glossary.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "categories": { - "type": "array", - "description": "An array of categories.", - "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - }, - "x-ms-identifiers": [] - }, - "language": { - "type": "string", - "description": "The language of the glossary." - }, - "terms": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the glossary." - }, - "categoryInfo": { - "type": "object", - "description": "The glossary category information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - }, - "termInfo": { - "type": "object", - "description": "The glossary term information.", - "additionalProperties": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } - } - }, - "AtlasGlossaryHeader": { - "type": "object", - "description": "The glossary header with basic information.", - "properties": { - "displayText": { - "type": "string", - "description": "The display text." - }, - "glossaryGuid": { - "type": "string", - "description": "The GUID of the glossary." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasGlossaryTerm": { - "type": "object", - "description": "The glossary term.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "classifications": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" - }, - "x-ms-identifiers": [] - }, - "longDescription": { - "type": "string", - "description": "The long version description." - }, - "name": { - "type": "string", - "description": "The name of the glossary object." - }, - "qualifiedName": { - "type": "string", - "description": "The qualified name of the glossary object." - }, - "shortDescription": { - "type": "string", - "description": "The short version of description." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "abbreviation": { - "type": "string", - "description": "The abbreviation of the term." - }, - "templateName": { - "type": "array", - "description": "The name of the template.", - "items": {} - }, - "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader", - "description": "The glossary header with basic information." - }, - "antonyms": { - "type": "array", - "description": "An array of related term headers as antonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "status": { - "$ref": "#/definitions/TermStatus", - "description": "Status of the AtlasGlossaryTerm" - }, - "nickName": { - "type": "string", - "description": "The nick name of the term." - }, - "hierarchyInfo": { - "type": "array", - "description": "The hierarchy information of the term.", - "items": { - "$ref": "#/definitions/PurviewObjectId" - }, - "x-ms-identifiers": [] - }, - "resources": { - "type": "array", - "description": "An array of resource link for term", - "items": { - "$ref": "#/definitions/ResourceLink" - }, - "x-ms-identifiers": [] - }, - "contacts": { - "type": "object", - "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/ContactInfo" - }, - "type": "array" - } - }, - "attributes": { - "type": "object", - "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "assignedEntities": { - "type": "array", - "description": "An array of related object IDs.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - }, - "x-ms-identifiers": [] - }, - "categories": { - "type": "array", - "description": "An array of term categorization headers.", - "items": { - "$ref": "#/definitions/AtlasTermCategorizationHeader" - }, - "x-ms-identifiers": [] - }, - "classifies": { - "type": "array", - "description": "An array of related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "examples": { - "type": "array", - "description": "An array of examples.", - "items": { - "type": "string" - } - }, - "isA": { - "type": "array", - "description": "An array of related term headers indicating the is-a relationship.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredTerms": { - "type": "array", - "description": "An array of preferred related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "preferredToTerms": { - "type": "array", - "description": "An array of related term headers that are preferred to.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacedBy": { - "type": "array", - "description": "An array of related term headers that are replaced by.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "replacementTerms": { - "type": "array", - "description": "An array of related term headers for replacement.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "seeAlso": { - "type": "array", - "description": "An array of related term headers for see also.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "synonyms": { - "type": "array", - "description": "An array of related term headers as synonyms.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translatedTerms": { - "type": "array", - "description": "An array of translated related term headers.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "translationTerms": { - "type": "array", - "description": "An array of related term headers for translation.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "usage": { - "type": "string", - "description": "The usage of the term." - }, - "validValues": { - "type": "array", - "description": "An array of related term headers as valid values.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - }, - "validValuesFor": { - "type": "array", - "description": "An array of related term headers as valid values for other records.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasLineageInfo": { - "type": "object", - "description": "The lineage information.", - "properties": { - "baseEntityGuid": { - "type": "string", - "description": "The GUID of the base entity." - }, - "guidEntityMap": { - "type": "object", - "description": "The GUID entity map.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "widthCounts": { - "type": "object", - "description": "The entity count in specific direction.", - "additionalProperties": { - "additionalProperties": {}, - "type": "object" - } - }, - "lineageDepth": { - "type": "integer", - "format": "int32", - "description": "The depth of lineage." - }, - "lineageWidth": { - "type": "integer", - "format": "int32", - "description": "The width of lineage." - }, - "childrenCount": { - "type": "integer", - "format": "int32", - "description": "The number of children node." - }, - "lineageDirection": { - "$ref": "#/definitions/LineageDirection", - "description": "The enum of lineage direction." - }, - "parentRelations": { - "type": "array", - "description": "An array of parentRelations relations.", - "items": { - "$ref": "#/definitions/ParentRelation" - }, - "x-ms-identifiers": [] - }, - "relations": { - "type": "array", - "description": "An array of lineage relations.", - "items": { - "$ref": "#/definitions/LineageRelation" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasObjectId": { - "type": "object", - "description": "Reference to an object-instance of a type - like entity.", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - } - } - }, - "AtlasRelatedCategoryHeader": { - "type": "object", - "description": "The header of the related category.", - "properties": { - "categoryGuid": { - "type": "string", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the category header." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "parentCategoryGuid": { - "type": "string", - "description": "The GUID of the parent category." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - } - } - }, - "AtlasRelatedObjectId": { - "type": "object", - "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "entityStatus": { - "$ref": "#/definitions/EntityStatus", - "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." - }, - "relationshipType": { - "type": "string", - "description": "Relationship type" - }, - "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." - }, - "relationshipGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the relationship." - }, - "relationshipStatus": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - } - } - }, - "AtlasRelatedTermHeader": { - "type": "object", - "description": "The header of the related term.", - "properties": { - "description": { - "type": "string", - "description": "The description of the related term." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "expression": { - "type": "string", - "description": "The expression of the term." - }, - "relationGuid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus", - "description": "The status of term relationship." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "type": "string", - "description": "The GUID of the term." - } - } - }, - "AtlasRelationship": { - "type": "object", - "description": "Atlas relationship instance.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "end1": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "end2": { - "$ref": "#/definitions/AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "guid": { - "type": "string", - "description": "The GUID of the relationship." - }, - "homeId": { - "type": "string", - "description": "The home ID of the relationship." - }, - "label": { - "type": "string", - "description": "The label of the relationship." - }, - "provenanceType": { - "type": "integer", - "format": "int32", - "description": "Used to record the provenance of an instance of an entity or relationship" - }, - "status": { - "$ref": "#/definitions/StatusAtlasRelationship", - "description": "The enum of relationship status." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the relationship." - } - } - }, - "AtlasRelationshipAttributeDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/CardinalityValue", - "description": "single-valued attribute or multi-valued attribute." - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value of the attribute." - }, - "description": { - "type": "string", - "description": "The description of the attribute." - }, - "includeInNotification": { - "type": "boolean", - "description": "Determines if it is included in notification." - }, - "isIndexable": { - "type": "boolean", - "description": "Determines if it is indexable." - }, - "isOptional": { - "type": "boolean", - "description": "Determines if it is optional." - }, - "isUnique": { - "type": "boolean", - "description": "Determines if it unique." - }, - "name": { - "type": "string", - "description": "The name of the attribute." - }, - "options": { - "type": "object", - "description": "The options for the attribute.", - "additionalProperties": { - "type": "string" - } - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "valuesMaxCount": { - "type": "integer", - "format": "int32", - "description": "The maximum count of the values." - }, - "valuesMinCount": { - "type": "integer", - "format": "int32", - "description": "The minimum count of the values." - }, - "isLegacyAttribute": { - "type": "boolean", - "description": "Determines if it is a legacy attribute." - }, - "relationshipTypeName": { - "type": "string", - "description": "The name of the relationship type." - } - } - }, - "AtlasRelationshipDef": { - "type": "object", - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - } - } - }, - "AtlasRelationshipEndDef": { - "type": "object", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", - "properties": { - "cardinality": { - "$ref": "#/definitions/CardinalityValue", - "description": "single-valued attribute or multi-valued attribute." - }, - "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." - } - } - }, - "AtlasRelationshipWithExtInfo": { - "type": "object", - "description": "The relationship with extended information.", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entity header.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntityHeader" - } - }, - "relationship": { - "$ref": "#/definitions/AtlasRelationship", - "description": "Atlas relationship instance." - } - } - }, - "AtlasStruct": { - "type": "object", - "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", - "properties": { - "attributes": { - "type": "object", - "description": "The attributes of the struct.", - "additionalProperties": {} - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - } - } - }, - "AtlasStructDef": { - "type": "object", - "description": "class that captures details of a struct-type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTermAssignmentHeader": { - "type": "object", - "description": "The header for term assignment.", - "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": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermAssignmentStatus", - "description": "The status of terms assignment." - }, - "steward": { - "type": "string", - "description": "The steward of the term." - }, - "termGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the term." - } - } - }, - "AtlasTermAssignmentStatus": { - "type": "string", - "description": "Status for term assignment", - "enum": [ - "DISCOVERED", - "PROPOSED", - "IMPORTED", - "VALIDATED", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermAssignmentStatus", - "modelAsString": true, - "values": [ - { - "name": "Discovered", - "value": "DISCOVERED", - "description": "The status is discovered." - }, - { - "name": "Proposed", - "value": "PROPOSED", - "description": "The status is proposed." - }, - { - "name": "Imported", - "value": "IMPORTED", - "description": "The status is imported." - }, - { - "name": "Validated", - "value": "VALIDATED", - "description": "The status is validated." - }, - { - "name": "Deprecated", - "value": "DEPRECATED", - "description": "The status is deprecated." - }, - { - "name": "Obsolete", - "value": "OBSOLETE", - "description": "The status is obsolete." - }, - { - "name": "Other", - "value": "OTHER", - "description": "Other status." - } - ] - } - }, - "AtlasTermCategorizationHeader": { - "type": "object", - "description": "The basic information for term categorization.", - "properties": { - "categoryGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the category." - }, - "description": { - "type": "string", - "description": "The description of the record." - }, - "displayText": { - "type": "string", - "description": "The display text." - }, - "relationGuid": { - "$ref": "#/definitions/Azure.Core.uuid", - "description": "The GUID of the relationship." - }, - "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus", - "description": "The status of term relationship." - } - } - }, - "AtlasTermRelationshipStatus": { - "type": "string", - "description": "Status for atlas term relationship", - "enum": [ - "DRAFT", - "ACTIVE", - "DEPRECATED", - "OBSOLETE", - "OTHER" - ], - "x-ms-enum": { - "name": "AtlasTermRelationshipStatus", - "modelAsString": true, - "values": [ - { - "name": "Draft", - "value": "DRAFT", - "description": "draft" - }, - { - "name": "Active", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "Deprecated", - "value": "DEPRECATED", - "description": "deprecated" - }, - { - "name": "Obsolete", - "value": "OBSOLETE", - "description": "obsolete" - }, - { - "name": "Other", - "value": "OTHER", - "description": "other" - } - ] - } - }, - "AtlasTypeDef": { - "type": "object", - "description": "The definitions of type.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "entityTypes": { - "type": "array", - "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", - "items": { - "type": "string" - } - }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } - }, - "superTypes": { - "type": "array", - "description": "An array of super types.", - "items": { - "type": "string" - } - }, - "relationshipAttributeDefs": { - "type": "array", - "description": "An array of relationship attributes.", - "items": { - "$ref": "#/definitions/AtlasRelationshipAttributeDef" - }, - "x-ms-identifiers": [] - }, - "defaultValue": { - "type": "string", - "description": "The default value." - }, - "elementDefs": { - "type": "array", - "description": "An array of enum element definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumElementDef" - }, - "x-ms-identifiers": [] - }, - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef", - "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." - }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory", - "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." - }, - "relationshipLabel": { - "type": "string", - "description": "The label of the relationship." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AtlasTypeDefHeader": { - "type": "object", - "description": "The basic information of the type definition.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - } - } - }, - "AtlasTypesDef": { - "type": "object", - "description": "The definitions of types.", - "properties": { - "businessMetadataDefs": { - "type": "array", - "description": "businessMetadataDefs", - "items": { - "$ref": "#/definitions/AtlasBusinessMetadataDef" - }, - "x-ms-identifiers": [] - }, - "classificationDefs": { - "type": "array", - "description": "An array of classification definitions.", - "items": { - "$ref": "#/definitions/AtlasClassificationDef" - }, - "x-ms-identifiers": [] - }, - "entityDefs": { - "type": "array", - "description": "An array of entity definitions.", - "items": { - "$ref": "#/definitions/AtlasEntityDef" - }, - "x-ms-identifiers": [] - }, - "enumDefs": { - "type": "array", - "description": "An array of enum definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumDef" - }, - "x-ms-identifiers": [] - }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" - }, - "x-ms-identifiers": [] - }, - "structDefs": { - "type": "array", - "description": "An array of struct definitions.", - "items": { - "$ref": "#/definitions/AtlasStructDef" - }, - "x-ms-identifiers": [] - }, - "termTemplateDefs": { - "type": "array", - "description": "An array of term template definitions.", - "items": { - "$ref": "#/definitions/TermTemplateDef" - }, - "x-ms-identifiers": [] - } - } - }, - "AutoCompleteOptions": { - "type": "object", - "description": "The query of autocomplete request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the autocomplete request." - } - } - }, - "AutoCompleteResult": { - "type": "object", - "description": "The result of the autocomplete request.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/AutoCompleteResultValue" - }, - "x-ms-identifiers": [] - } - } - }, - "AutoCompleteResultValue": { - "type": "object", - "description": "The value item of the autocomplete suggest.", - "properties": { - "text": { - "type": "string", - "description": "The completed term or phrase." - }, - "queryPlusText": { - "type": "string", - "description": "The completed search query text." - } - } - }, - "Azure.Core.uuid": { - "type": "string", - "format": "uuid", - "description": "Universally Unique Identifier" - }, - "BulkImportResult": { - "type": "object", - "description": "Bulk import result", - "properties": { - "failedImportInfoList": { - "type": "array", - "description": "failed importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - }, - "successImportInfoList": { - "type": "array", - "description": "successful importInfoList", - "items": { - "$ref": "#/definitions/ImportInfo" - }, - "x-ms-identifiers": [] - } - } - }, - "CardinalityValue": { - "type": "string", - "description": "Cardinality", - "enum": [ - "SINGLE", - "LIST", - "SET" - ], - "x-ms-enum": { - "name": "CardinalityValue", - "modelAsString": true, - "values": [ - { - "name": "Single", - "value": "SINGLE", - "description": "single" - }, - { - "name": "List", - "value": "LIST", - "description": "list" - }, - { - "name": "Set", - "value": "SET", - "description": "set" - } - ] - } - }, - "ClassificationAssociateOptions": { - "type": "object", - "description": "The request content for classification association.", - "properties": { - "classification": { - "$ref": "#/definitions/AtlasClassification", - "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." - }, - "entityGuids": { - "type": "array", - "description": "The GUID of the entity.", - "items": { - "type": "string" - } - } - } - }, - "ContactInfo": { - "type": "object", - "description": "ContactInfo", - "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." - } - } - }, - "ContactSearchResultValue": { - "type": "object", - "description": "The contact in the search and suggest result.", - "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\nExpert or Steward for a glossary term." - } - } - }, - "DateFormat": { - "type": "object", - "description": "The date format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "An array of available locales.", - "items": { - "type": "string" - } - }, - "calendar": { - "type": "number", - "format": "float", - "description": "Calendar" - }, - "dateInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "dateTimeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "instance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "lenient": { - "type": "boolean", - "description": "Determines the leniency of the date format." - }, - "numberFormat": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "timeInstance": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "timeZone": { - "$ref": "#/definitions/TimeZone", - "description": "The timezone information." - } - } - }, - "EntityMutationResult": { - "type": "object", - "description": "The mutation response result of entity.", - "properties": { - "guidAssignments": { - "type": "object", - "description": "A map of GUID assignments with entities.", - "additionalProperties": { - "type": "string" - } - }, - "mutatedEntities": { - "type": "object", - "description": "The entity headers of mutated entities.", - "additionalProperties": { - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "type": "array", - "x-ms-identifiers": [] - } - }, - "partialUpdatedEntities": { - "type": "array", - "description": "An array of entity headers that partially updated.", - "items": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "x-ms-identifiers": [] - } - } - }, - "EntityStatus": { - "type": "string", - "description": "Status - can be active or deleted", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "EntityStatus", - "modelAsString": true, - "values": [ - { - "name": "Active", - "value": "ACTIVE", - "description": "The status is active." - }, - { - "name": "Deleted", - "value": "DELETED", - "description": "The status is deleted." - } - ] - } - }, - "ImportInfo": { - "type": "object", - "description": "ImportInfo", - "properties": { - "childObjectName": { - "type": "string", - "description": "childObjectName" - }, - "importStatus": { - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" - }, - "parentObjectName": { - "type": "string", - "description": "parentObjectName" - }, - "remarks": { - "type": "string", - "description": "remarks" - } - } - }, - "ImportStatus": { - "type": "string", - "description": "Status for import", - "enum": [ - "SUCCESS", - "FAILED" - ], - "x-ms-enum": { - "name": "ImportStatus", - "modelAsString": true, - "values": [ - { - "name": "Success", - "value": "SUCCESS", - "description": "Success" - }, - { - "name": "Failed", - "value": "FAILED", - "description": "Failed" - } - ] - } - }, - "LineageDirection": { - "type": "string", - "description": "Lineage direction", - "enum": [ - "INPUT", - "OUTPUT", - "BOTH" - ], - "x-ms-enum": { - "name": "LineageDirection", - "modelAsString": true, - "values": [ - { - "name": "Input", - "value": "INPUT", - "description": "input" - }, - { - "name": "Output", - "value": "OUTPUT", - "description": "output" - }, - { - "name": "Both", - "value": "BOTH", - "description": "both" - } - ] - } - }, - "LineageRelation": { - "type": "object", - "description": "The lineage relation with GUID of the from and to entity.", - "properties": { - "fromEntityId": { - "type": "string", - "description": "The GUID of from-entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "toEntityId": { - "type": "string", - "description": "The GUID of to-entity." - } - } - }, - "MoveEntitiesOptions": { - "type": "object", - "description": "MoveEntitiesContent", - "properties": { - "entityGuids": { - "type": "array", - "description": "An array of entity guids to be moved to target collection.", - "items": { - "type": "string" - } - } - } - }, - "NumberFormat": { - "type": "object", - "description": "The number format.", - "properties": { - "availableLocales": { - "type": "array", - "description": "The number format.", - "items": { - "type": "string" - } - }, - "currency": { - "type": "string", - "description": "The currency." - }, - "currencyInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "groupingUsed": { - "type": "boolean", - "description": "Determines if grouping is used." - }, - "instance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "integerInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "maximumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of fraction digits." - }, - "maximumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The maximum of integer digits." - }, - "minimumFractionDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of fraction digits." - }, - "minimumIntegerDigits": { - "type": "integer", - "format": "int32", - "description": "The minimum of integer digits." - }, - "numberInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "parseIntegerOnly": { - "type": "boolean", - "description": "Determines if only integer is parsed." - }, - "percentInstance": { - "$ref": "#/definitions/NumberFormat", - "description": "The number format." - }, - "roundingMode": { - "$ref": "#/definitions/RoundingMode", - "description": "The enum of rounding mode." - } - } - }, - "ParentRelation": { - "type": "object", - "description": "The lineage parents relation with GUID of the parent entity and to child entity.", - "properties": { - "childEntityId": { - "type": "string", - "description": "The GUID of child entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "parentEntityId": { - "type": "string", - "description": "The GUID of parent entity." - } - } - }, - "PurviewObjectId": { - "type": "object", - "description": "PurviewObjectId", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - }, - "typeName": { - "type": "string", - "description": "The name of the type." - }, - "uniqueAttributes": { - "type": "object", - "description": "The unique attributes of the object.", - "additionalProperties": {} - }, - "name": { - "type": "string", - "description": "Name" - }, - "displayText": { - "type": "string", - "description": "Display text" - }, - "itemPath": { - "type": "string", - "description": "Item path" - }, - "resourceId": { - "type": "string", - "description": "Resource Id" - }, - "properties": { - "type": "object", - "description": "Dictionary of ", - "additionalProperties": {} - } - } - }, - "QueryOptions": { - "type": "object", - "description": "The search query of advanced search request.", - "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\nvalue is 1000." - }, - "continuationToken": { - "type": "string", - "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, 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": {} - }, - "filter": { - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "description": "The facets for search. See examples for the usage of supported facets.", - "items": { - "$ref": "#/definitions/SearchFacetItem" - }, - "x-ms-identifiers": [] - }, - "taxonomySetting": { - "$ref": "#/definitions/SearchTaxonomySetting", - "description": "The taxonomy setting for search." - } - } - }, - "QueryResult": { - "type": "object", - "description": "The result of the search result.", - "properties": { - "@search.count": { - "type": "integer", - "format": "int32", - "description": "The total number of search results (not the number of documents in a single\npage).", - "x-ms-client-name": "searchCount" - }, - "@search.count.approximate": { - "type": "boolean", - "description": "'True' if the '@search.count' is an approximate value and vise versa.", - "x-ms-client-name": "searchCountApproximate" - }, - "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", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "x-ms-client-name": "searchFacets" - }, - "value": { - "type": "array", - "description": "Search result value", - "items": { - "$ref": "#/definitions/SearchResultValue" - } - } - } - }, - "RelationshipCategory": { - "type": "string", - "description": "Relationship Category", - "enum": [ - "ASSOCIATION", - "AGGREGATION", - "COMPOSITION" - ], - "x-ms-enum": { - "name": "RelationshipCategory", - "modelAsString": true, - "values": [ - { - "name": "Association", - "value": "ASSOCIATION", - "description": "association" - }, - { - "name": "Aggregation", - "value": "AGGREGATION", - "description": "aggregation" - }, - { - "name": "Composition", - "value": "COMPOSITION", - "description": "composition" - } - ] - } - }, - "ResourceLink": { - "type": "object", - "description": "ResourceLink", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." - }, - "url": { - "type": "string", - "description": "web url. http or https" - } - } - }, - "RoundingMode": { - "type": "string", - "description": "Rounding Mode", - "enum": [ - "UP", - "DOWN", - "CEILING", - "FLOOR", - "HALF_UP", - "HALF_DOWN", - "HALF_EVEN", - "UNNECESSARY" - ], - "x-ms-enum": { - "name": "RoundingMode", - "modelAsString": true, - "values": [ - { - "name": "Up", - "value": "UP", - "description": "up" - }, - { - "name": "Down", - "value": "DOWN", - "description": "down" - }, - { - "name": "Ceiling", - "value": "CEILING", - "description": "ceiling" - }, - { - "name": "Floor", - "value": "FLOOR", - "description": "floor" - }, - { - "name": "HalfUp", - "value": "HALF_UP", - "description": "half up" - }, - { - "name": "HalfDown", - "value": "HALF_DOWN", - "description": "half down" - }, - { - "name": "HalfEven", - "value": "HALF_EVEN", - "description": "half even" - }, - { - "name": "Unnecessary", - "value": "UNNECESSARY", - "description": "unnecessary" - } - ] - } - }, - "SearchFacetItem": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "facet": { - "type": "string", - "description": "The name of the facet item." - }, - "sort": { - "$ref": "#/definitions/SearchFacetSort", - "description": "Define the sorting criteria for items" - } - } - }, - "SearchFacetItemValue": { - "type": "object", - "description": "The content of a search facet result item.", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The count of the facet item." - }, - "value": { - "type": "string", - "description": "The name of the facet item." - } - } - }, - "SearchFacetResultValue": { - "type": "object", - "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", - "properties": { - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "assetType": { - "type": "array", - "description": "Asset type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "classification": { - "type": "array", - "description": "Classification", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "term": { - "type": "array", - "description": "Term", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactId": { - "type": "array", - "description": "Contact id", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "contactType": { - "type": "array", - "description": "Contact type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "label": { - "type": "array", - "description": "Label", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "glossaryType": { - "type": "array", - "description": "Glossary type", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termStatus": { - "type": "array", - "description": "Term status", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - }, - "termTemplate": { - "type": "array", - "description": "Term template", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - }, - "x-ms-identifiers": [] - } - } - }, - "SearchFacetSort": { - "type": "object", - "description": "The sorting criteria", - "properties": { - "count": { - "$ref": "#/definitions/SearchSortOrder", - "description": "Order by count" - }, - "value": { - "$ref": "#/definitions/SearchSortOrder", - "description": "Order by value" - } - } - }, - "SearchHighlights": { - "type": "object", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "properties": { - "id": { - "type": "array", - "description": "Id", - "items": { - "type": "string" - } - }, - "qualifiedName": { - "type": "array", - "description": "Qualified name", - "items": { - "type": "string" - } - }, - "name": { - "type": "array", - "description": "Name", - "items": { - "type": "string" - } - }, - "description": { - "type": "array", - "description": "Description", - "items": { - "type": "string" - } - }, - "entityType": { - "type": "array", - "description": "Entity type", - "items": { - "type": "string" - } - } - } - }, - "SearchResultValue": { - "type": "object", - "description": "The value item of the search result.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.highlights": { - "$ref": "#/definitions/SearchHighlights", - "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", - "x-ms-client-name": "searchHighlights" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The create time of the record. The Unix epoch format." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "SearchSortOrder": { - "type": "string", - "description": "Search sort order", - "enum": [ - "asc", - "desc" - ], - "x-ms-enum": { - "name": "SearchSortOrder", - "modelAsString": true, - "values": [ - { - "name": "Ascend", - "value": "asc", - "description": "Use ascending order for sorting" - }, - { - "name": "Descend", - "value": "desc", - "description": "Use descending order for sorting" - } - ] - } - }, - "SearchTaxonomySetting": { - "type": "object", - "description": "Taxonomy setting for search request", - "properties": { - "assetTypes": { - "type": "array", - "description": "Asset types", - "items": { - "type": "string" - } - }, - "facet": { - "$ref": "#/definitions/SearchFacetItem", - "description": "The content of a search facet result item." - } - } - }, - "SortType": { - "type": "string", - "description": "Type for sorting", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "SortType", - "modelAsString": true, - "values": [ - { - "name": "None", - "value": "NONE", - "description": "No sorting order" - }, - { - "name": "Ascend", - "value": "ASC", - "description": "Use ascending order for sorting" - }, - { - "name": "Descend", - "value": "DESC", - "description": "Use descending order for sorting" - } - ] - } - }, - "StatusAtlasRelationship": { - "type": "string", - "description": "Status for atlas relationship", - "enum": [ - "ACTIVE", - "DELETED" - ], - "x-ms-enum": { - "name": "StatusAtlasRelationship", - "modelAsString": true, - "values": [ - { - "name": "Active", - "value": "ACTIVE", - "description": "active" - }, - { - "name": "Deleted", - "value": "DELETED", - "description": "deleted" - } - ] - } - }, - "SuggestOptions": { - "type": "object", - "description": "The query of suggest request.", - "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." - }, - "filter": { - "description": "The filter for the search." - } - } - }, - "SuggestResult": { - "type": "object", - "description": "The result item of the search suggest.", - "properties": { - "value": { - "type": "array", - "description": "The result value", - "items": { - "$ref": "#/definitions/SuggestResultValue" - } - } - } - }, - "SuggestResultValue": { - "type": "object", - "description": "The value item of the search suggest.", - "properties": { - "@search.score": { - "type": "number", - "format": "float", - "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", - "x-ms-client-name": "searchScore" - }, - "@search.text": { - "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", - "x-ms-client-name": "searchText" - }, - "objectType": { - "type": "string", - "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The create time of the record. The Unix epoch format." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "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" - }, - "x-ms-identifiers": [] - }, - "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\nAtlasGlossaryCategory." - }, - "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." - } - } - }, - "TermSearchResultValue": { - "type": "object", - "description": "The context.", - "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." - } - } - }, - "TermStatus": { - "type": "string", - "description": "Status for term", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true, - "values": [ - { - "name": "Draft", - "value": "Draft", - "description": "draft" - }, - { - "name": "Approved", - "value": "Approved", - "description": "approved" - }, - { - "name": "Alert", - "value": "Alert", - "description": "alert" - }, - { - "name": "Expired", - "value": "Expired", - "description": "expired" - } - ] - } - }, - "TermTemplateDef": { - "type": "object", - "description": "Term template definition for glossary term.", - "properties": { - "category": { - "$ref": "#/definitions/TypeCategory", - "description": "The enum of type category." - }, - "createTime": { - "type": "integer", - "format": "unixtime", - "description": "The created time of the record." - }, - "createdBy": { - "type": "string", - "description": "The user who created the record." - }, - "dateFormatter": { - "$ref": "#/definitions/DateFormat", - "description": "The date format." - }, - "description": { - "type": "string", - "description": "The description of the type definition." - }, - "guid": { - "type": "string", - "description": "The GUID of the type definition." - }, - "name": { - "type": "string", - "description": "The name of the type definition." - }, - "options": { - "type": "object", - "description": "The options for the type definition.", - "additionalProperties": { - "type": "string" - } - }, - "serviceType": { - "type": "string", - "description": "The service type." - }, - "typeVersion": { - "type": "string", - "description": "The version of the type." - }, - "updateTime": { - "type": "integer", - "format": "unixtime", - "description": "The update time of the record." - }, - "updatedBy": { - "type": "string", - "description": "The user who updated the record." - }, - "version": { - "type": "integer", - "format": "int64", - "description": "The version of the record." - }, - "lastModifiedTS": { - "type": "string", - "description": "ETag for concurrency control." - }, - "attributeDefs": { - "type": "array", - "description": "An array of attribute definitions.", - "items": { - "$ref": "#/definitions/AtlasAttributeDef" - }, - "x-ms-identifiers": [] - } - } - }, - "TimeBoundary": { - "type": "object", - "description": "Captures time-boundary details", - "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." - } - } - }, - "TimeZone": { - "type": "object", - "description": "The timezone information.", - "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", - "description": "The timezone information." - }, - "displayName": { - "type": "string", - "description": "The display name of the timezone." - }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." - } - } - }, - "TypeCategory": { - "type": "string", - "description": "Type Category", - "enum": [ - "PRIMITIVE", - "OBJECT_ID_TYPE", - "ENUM", - "STRUCT", - "CLASSIFICATION", - "ENTITY", - "ARRAY", - "MAP", - "RELATIONSHIP", - "TERM_TEMPLATE" - ], - "x-ms-enum": { - "name": "TypeCategory", - "modelAsString": true, - "values": [ - { - "name": "Primitive", - "value": "PRIMITIVE", - "description": "primitive" - }, - { - "name": "ObjectIdType", - "value": "OBJECT_ID_TYPE", - "description": "object id type" - }, - { - "name": "Enum", - "value": "ENUM", - "description": "enum" - }, - { - "name": "Struct", - "value": "STRUCT", - "description": "struct" - }, - { - "name": "Classification", - "value": "CLASSIFICATION", - "description": "classification" - }, - { - "name": "Entity", - "value": "ENTITY", - "description": "entity" - }, - { - "name": "Array", - "value": "ARRAY", - "description": "array" - }, - { - "name": "Map", - "value": "MAP", - "description": "map" - }, - { - "name": "Relationship", - "value": "RELATIONSHIP", - "description": "relationship" - }, - { - "name": "TermTemplate", - "value": "TERM_TEMPLATE", - "description": "term template" - } - ] - } - } - }, - "parameters": { - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - } - } -} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 74a7471bb5f6..2cde7be06e2e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1,115 +1,149 @@ { "swagger": "2.0", "info": { - "title": "Purview Data Map Service REST API Document", - "description": "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service.", - "version": "2023-09-01" + "title": "Azure Analytics Purview Data Map", + "version": "2023-09-01", + "description": "Purview Data Map Service is a fully managed cloud service whose users can\ndiscover the data sources they need and understand the data sources they find.\nAt the same time, Data Map helps organizations get more value from their\nexisting investments. This spec defines REST API of Purview Data Map Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, + "schemes": [ + "https" + ], "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", + "hostTemplate": "{endpoint}/datamap/api", "useSchemePrefix": false, "parameters": [ { - "$ref": "#/parameters/endpoint" + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, - "basePath": "/datamap/api", - "schemes": [ - "https" + "produces": [ + "application/json" ], "consumes": [ "application/json" ], - "produces": [ - "application/json" + "security": [ + { + "AuthToken": [ + "https://purview.azure.net/.default" + ] + } ], "securityDefinitions": { - "azure_auth": { + "AuthToken": { + "type": "oauth2", + "description": "The Azure Active Directory OAuth2 Flow", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow." + "https://purview.azure.net/.default": "" + } } }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], + "tags": [], "paths": { "/atlas/v2/entity": { "post": { - "tags": [ - "Entity" - ], - "description": "Create or update an entity.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "operationId": "Entity_CreateOrUpdate", - "x-ms-examples": { - "Entity_Create": { - "$ref": "./examples/Entity_Create.json" + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - "Entity_Update": { - "$ref": "./examples/Entity_Update.json" + { + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" }, - "Entity_AddCustomAttribute": { - "$ref": "./examples/Entity_AddCustomAttribute.json" - } - }, - "parameters": [ { - "in": "body", "name": "body", + "in": "body", "description": "Atlas entity with extended information.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" } - }, - { - "$ref": "#/parameters/businessAttributeUpdateBehavior" - }, - { - "$ref": "#/parameters/collectionId" - }, - { - "$ref": "#/parameters/atlasAPIVersion" } ], "responses": { "200": { - "description": "Created with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + }, + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + } } } }, "/atlas/v2/entity/bulk": { "get": { - "tags": [ - "Entity" - ], - "description": "List entities in bulk identified by its GUIDs.", "operationId": "Entity_ListByGuids", - "x-ms-examples": { - "Entity_ListByGuids": { - "$ref": "./examples/Entity_ListByGuids.json" - } - }, + "description": "List entities in bulk identified by its GUIDs.", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "guid", "in": "query", @@ -119,92 +153,127 @@ "items": { "type": "string" }, - "collectionFormat": "multi", - "x-ms-client-name": "guids" - }, - { - "$ref": "#/parameters/minExtInfo" + "collectionFormat": "multi" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasEntitiesWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } } }, "post": { - "tags": [ - "Entity" - ], - "description": "Create or update entities in bulk.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "operationId": "Entity_BulkCreateOrUpdate", - "x-ms-examples": { - "Entity_BulkCreateOrUpdate": { - "$ref": "./examples/Entity_BulkCreateOrUpdate.json" - } - }, + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", "parameters": [ { - "in": "body", - "name": "body", - "description": "An array of entities to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/collectionId" + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to. Only specify a value if you\nneed to move an entity to another collection.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "businessAttributeUpdateBehavior", + "in": "query", + "description": "Used to define the update behavior for business attributes when updating\nentities.", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "BusinessAttributeUpdateBehavior", + "modelAsString": true, + "values": [ + { + "name": "Ignore", + "value": "ignore", + "description": "Ignore the business attribute payload for update." + }, + { + "name": "Replace", + "value": "replace", + "description": "Replace all the business attributes using the payload." + }, + { + "name": "Merge", + "value": "merge", + "description": "Merge the business attributes. Business attributes will not be updated if not provided." + } + ] + } }, { - "$ref": "#/parameters/businessAttributeUpdateBehavior" + "name": "body", + "in": "body", + "description": "An array of entities to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } } ], "responses": { "200": { - "description": "Ok.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } } }, "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a list of entities in bulk identified by their GUIDs or unique attributes.", "operationId": "Entity_BulkDelete", - "x-ms-examples": { - "Entity_BulkDelete": { - "$ref": "./examples/Entity_BulkDelete.json" - } - }, + "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "guid", "in": "query", @@ -214,1406 +283,1499 @@ "items": { "type": "string" }, - "collectionFormat": "multi", - "x-ms-client-name": "guids" + "collectionFormat": "multi" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } } } }, "/atlas/v2/entity/bulk/classification": { "post": { - "tags": [ - "Entity" - ], - "description": "Associate a classification to multiple entities in bulk.", "operationId": "Entity_AddClassification", - "x-ms-examples": { - "Entity_AddClassificationToEntityByGuids": { - "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" - } - }, + "description": "Associate a classification to multiple entities in bulk.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", + "in": "body", "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { - "$ref": "#/definitions/ClassificationAssociateRequest" + "$ref": "#/definitions/ClassificationAssociateOptions" } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } } } }, - "/atlas/v2/entity/guid/{guid}": { - "get": { - "tags": [ - "Entity" - ], - "operationId": "Entity_Get", - "x-ms-examples": { - "Entity_Get": { - "$ref": "./examples/Entity_Get.json" - } - }, - "description": "Get complete definition of an entity given its GUID.", + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "operationId": "Entity_BulkSetClassifications", + "description": "Set classifications on entities in bulk.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/minExtInfo" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "body", + "in": "body", + "description": "Atlas entity headers.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" + "type": "array", + "items": { + "type": "string" + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update entity partially - create or update entity attribute identified by its GUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", - "operationId": "Entity_PartialUpdateAttributeByGuid", + }, "x-ms-examples": { - "Entity_PartialUpdateEntityAttributeByGuid": { - "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" } - }, + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_ListByUniqueAttributes", + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "name", - "in": "query", - "description": "The name of the attribute.", + "name": "typeName", + "in": "path", + "description": "The name of the type.", "required": true, "type": "string" }, { - "in": "body", - "name": "body", - "description": "The value of the attribute.", - "required": true, - "schema": { - "type": "object" - } + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set\nattrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an\nexample. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "Updated with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete an entity identified by its GUID.", - "operationId": "Entity_Delete", + }, "x-ms-examples": { - "Entity_Delete": { - "$ref": "./examples/Entity_Delete.json" + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" } - }, + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "operationId": "Entity_ImportBusinessMetadata", + "description": "Upload the file for creating Business Metadata in BULK", + "consumes": [ + "multipart/form-data" + ], "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "file", + "in": "formData", + "description": "InputStream of file", + "required": true, + "type": "file" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/BulkImportResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } } } }, - "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "/atlas/v2/entity/businessmetadata/import/template": { "get": { - "tags": [ - "Entity" + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "produces": [ + "application/octet-stream", + "application/json" ], - "description": "Get classification for a given entity represented by a GUID.", - "operationId": "Entity_GetClassification", - "x-ms-examples": { - "Entity_GetClassification": { - "$ref": "./examples/Entity_GetClassification.json" + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + } + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "operationId": "Entity_Get", + "description": "Get complete definition of an entity given its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/classificationName" + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "The classification for the given entity GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassification" + "$ref": "#/definitions/AtlasEntityWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a given classification from an existing entity represented by a GUID.", - "operationId": "Entity_RemoveClassification", + }, "x-ms-examples": { - "Entity_RemoveClassification": { - "$ref": "./examples/Entity_RemoveClassification.json" + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" } - }, + } + }, + "put": { + "operationId": "Entity_PartialUpdateAttributeByGuid", + "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/classificationName" + "name": "body", + "in": "body", + "description": "The value of the attribute.", + "required": true, + "schema": {} } ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/classifications": { - "get": { - "tags": [ - "Entity" - ], - "description": "List classifications for a given entity represented by a GUID.", - "operationId": "Entity_GetClassifications", + }, "x-ms-examples": { - "Entity_GetClassifications": { - "$ref": "./examples/Entity_GetClassifications.json" + "Entity_PartialUpdateAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" } - }, + } + }, + "delete": { + "operationId": "Entity_Delete", + "description": "Delete an entity identified by its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "An array of classifications for the given entity GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasClassifications" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Add classifications to an existing entity represented by a GUID.", - "operationId": "Entity_AddClassifications", + }, "x-ms-examples": { - "Entity_AddClassifications": { - "$ref": "./examples/Entity_AddClassifications.json" + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" } - }, + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "description": "Add business metadata to an entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "isOverwrite", + "in": "query", + "description": "Whether to overwrite the existing business metadata on the entity or not,\ndefault is false.", + "required": false, + "type": "boolean", + "x-ms-client-name": "overwrite" }, { - "in": "body", "name": "body", - "description": "An array of classifications to be added.", + "in": "body", + "description": "BusinessMetadata payload", "required": true, "schema": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update classifications to an existing entity represented by a guid.", - "operationId": "Entity_UpdateClassifications", + }, "x-ms-examples": { - "Entity_UpdateClassifications": { - "$ref": "./examples/Entity_UpdateClassifications.json" + "Entity_AddOrUpdate_BusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadata", + "description": "Remove business metadata from an entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", - "description": "An array of classifications to be updated.", + "in": "body", + "description": "Business metadata payload", "required": true, "schema": { - "type": "array", - "description": "An array of classifications.", - "items": { - "$ref": "#/definitions/AtlasClassification" + "type": "object", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" } } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } } } }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nGET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_GetByUniqueAttributes", - "x-ms-examples": { - "Entity_GetByUniqueAttributes": { - "$ref": "./examples/Entity_GetByUniqueAttributes.json" - } - }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { + "post": { + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "description": "Add or update business metadata attributes.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/minExtInfo" + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ignoreRelationships" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" + "name": "body", + "in": "body", + "description": "Business metadata attribute payload", + "required": true, + "schema": { + "type": "object", + "additionalProperties": {} + } } ], "responses": { - "200": { - "description": "AtlasEntityWithExtInfo.", - "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\n\nattr:=.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nPUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_PartialUpdateByUniqueAttributes", + }, "x-ms-examples": { - "Entity_PartialUpdateEntityByUniqueAttributes": { - "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + "Entity_AddOrUpdate_BusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "description": "Delete business metadata attributes from an entity.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "businessMetadataName", + "in": "path", + "description": "BusinessMetadata name", + "required": true, + "type": "string" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" }, { - "in": "body", "name": "body", - "description": "Atlas entity with extended information.", + "in": "body", + "description": "Business metadata attribute payload", "required": true, "schema": { - "$ref": "#/definitions/AtlasEntityWithExtInfo" + "type": "object", + "additionalProperties": {} } } ], "responses": { - "200": { - "description": "Updated with EntityMutationResponse.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete an entity identified by its type and unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=\\.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\nDELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Entity_DeleteByUniqueAttribute", + }, "x-ms-examples": { - "Entity_DeleteByUniqueAttribute": { - "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" } - }, + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "operationId": "Entity_GetClassification", + "description": "Get classification for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, "type": "string" } ], "responses": { "200": { - "description": "Deleted with EntityMutationResponse.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/EntityMutationResponse" + "$ref": "#/definitions/AtlasClassification" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete a given classification from an entity identified by its type and unique attributes.", - "operationId": "Entity_RemoveClassificationByUniqueAttribute", + }, "x-ms-examples": { - "Entity_RemoveClassificationByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveClassification", + "description": "Delete a given classification from an existing entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/classificationName" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, "type": "string" } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } } } }, - "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { - "post": { - "tags": [ - "Entity" - ], - "description": "Add classification to the entity identified by its type and unique attributes.", - "operationId": "Entity_AddClassificationsByUniqueAttribute", - "x-ms-examples": { - "Entity_AddClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" - } - }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "operationId": "Entity_GetClassifications", + "description": "List classifications for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, - "type": "string" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "An array of classification to be added.", + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", "required": true, - "schema": { - "type": "array", - "description": "An array of classification.", - "items": { - "$ref": "#/definitions/AtlasClassification" - } - } + "type": "string" } ], "responses": { - "204": { - "description": "No Content." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } } }, "put": { - "tags": [ - "Entity" - ], - "description": "Update classification on an entity identified by its type and unique attributes.", - "operationId": "Entity_UpdateClassificationsByUniqueAttribute", - "x-ms-examples": { - "Entity_UpdateClassificationsByUniqueAttribute": { - "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" - } - }, + "operationId": "Entity_UpdateClassifications", + "description": "Update classifications to an existing entity represented by a guid.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" }, { - "in": "body", "name": "body", - "description": "An array of classification to be updated.", + "in": "body", + "description": "An array of classifications to be updated.", "required": true, "schema": { "type": "array", - "description": "An array of classification.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] } } ], "responses": { "204": { - "description": "No Content." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/bulk/setClassifications": { - "post": { - "tags": [ - "Entity" - ], - "description": "Set classifications on entities in bulk.", - "operationId": "Entity_BulkSetClassifications", + }, "x-ms-examples": { - "Entity_BulkSetClassifications": { - "$ref": "./examples/Entity_BulkSetClassifications.json" + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" } - }, + } + }, + "post": { + "operationId": "Entity_AddClassifications", + "description": "Add classifications to an existing entity represented by a GUID.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { "name": "body", - "description": "Atlas entity headers.", + "in": "body", + "description": "An array of classifications to be added.", "required": true, "schema": { - "$ref": "#/definitions/AtlasEntityHeaders" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] } } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "description": "Response that indicates each classification mutation result.", - "items": { - "type": "string" - } - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } } } }, - "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "/atlas/v2/entity/guid/{guid}/header": { "get": { - "tags": [ - "Entity" - ], - "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE: The attrName should be an unique attribute for the given entity-type.\nThe REST request would look something like this\n\nGET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote: at least one unique attribute must be provided.", - "operationId": "Entity_ListByUniqueAttributes", - "x-ms-examples": { - "Entity_ListByUniqueAttributes": { - "$ref": "./examples/Entity_ListByUniqueAttributes.json" - } - }, + "operationId": "Entity_GetHeader", + "description": "Get entity header given its GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/minExtInfo" - }, - { - "$ref": "#/parameters/ignoreRelationships" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "attr_N:qualifiedName", - "in": "query", - "description": "Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, "type": "string" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + "$ref": "#/definitions/AtlasEntityHeader" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/header": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get entity header given its GUID.", - "operationId": "Entity_GetHeader", + }, "x-ms-examples": { "Entity_GetHeader": { "$ref": "./examples/Entity_GetHeader.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/guid" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasEntityHeader" - }, - "description": "AtlasEntityHeader" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } } } }, - "/atlas/v2/entity/guid/{guid}/businessmetadata": { - "delete": { - "tags": [ - "Entity" - ], - "description": "Remove business metadata from an entity.", - "operationId": "Entity_RemoveBusinessMetadata", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveBusinessMetadata": { - "$ref": "./examples/Entity_RemoveBusinessMetadata.json" - } - }, + "/atlas/v2/entity/guid/{guid}/labels": { + "put": { + "operationId": "Entity_AddLabel", + "description": "Add given labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be added", + "required": true, "schema": { - "$ref": "#/definitions/BusinessMetadata" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_AddLabel.json" + } } }, "post": { - "tags": [ - "Entity" - ], - "description": "Add business metadata to an entity.", - "operationId": "Entity_AddOrUpdateBusinessMetadata", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_AddOrUpdateBusinessMetadata": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessMetadata.json" - } - }, + "operationId": "Entity_SetLabels", + "description": "Set labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "query", - "type": "boolean", - "name": "isOverwrite", - "description": "Whether to overwrite the existing business metadata on the entity or not, default is false.", - "required": false + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be set to the entity", + "required": true, "schema": { - "$ref": "#/definitions/BusinessMetadata" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}": { - "delete": { - "tags": [ - "Entity" - ], - "description": "Delete business metadata attributes from an entity.", - "operationId": "Entity_RemoveBusinessMetadataAttributes", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_RemoveBusinessAttribute": { - "$ref": "./examples/Entity_RemoveBusinessAttribute.json" + "Entity_SetLabels": { + "$ref": "./examples/Entity_SetLabels.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveLabels", + "description": "Delete given labels to a given entity.", "parameters": [ { - "name": "businessMetadataName", - "in": "path", - "type": "string", - "description": "BusinessMetadata name", - "required": true + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/guid" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be deleted", + "required": true, "schema": { - "$ref": "#/definitions/BusinessMetadataAttributes" + "type": "array", + "items": { + "type": "string" + } } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Add or update business metadata attributes.", - "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddOrUpdateBusinessAttribute": { - "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_RemoveLabels.json" } - }, + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Entity_GetByUniqueAttributes", + "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "name": "businessMetadataName", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", "in": "path", - "type": "string", - "description": "BusinessMetadata name", - "required": true + "description": "The name of the type.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/guid" + "name": "minExtInfo", + "in": "query", + "description": "Whether to return minimal information for referred entities.", + "required": false, + "type": "boolean" }, { - "name": "body", + "name": "ignoreRelationships", + "in": "query", + "description": "Whether to ignore relationship attributes.", "required": false, - "in": "body", - "schema": { - "$ref": "#/definitions/BusinessMetadataAttributes" - } + "type": "boolean" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { - "204": { - "description": "Success" + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/businessmetadata/import/template": { - "get": { - "tags": [ - "Entity" - ], - "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", - "operationId": "Entity_GetSampleBusinessMetadataTemplate", - "produces": [ - "application/octet-stream" - ], + }, "x-ms-examples": { - "Entity_GetSampleBusinessMetadataTemplate": { - "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" } - }, - "parameters": [], + } + }, + "put": { + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", + "in": "body", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "description": "Template File", - "type": "file" - }, - "description": "Template File" + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/entity/businessmetadata/import": { - "post": { - "tags": [ - "Entity" - ], - "description": "Upload the file for creating Business Metadata in BULK", - "operationId": "Entity_ImportBusinessMetadata", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_ImportBusinessMetadata": { - "$ref": "./examples/Entity_ImportBusinessMetadata.json" + "Entity_PartialUpdateByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" } - }, + } + }, + "delete": { + "operationId": "Entity_DeleteByUniqueAttribute", + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "name": "uploadedInputStream", - "in": "formData", - "type": "file", - "description": "InputStream of file" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/BulkImportResponse", - "description": "If Business Metadata creation was successful" - }, - "description": "If Business Metadata creation was successful" + "$ref": "#/definitions/EntityMutationResult" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } } } }, - "/atlas/v2/entity/guid/{guid}/labels": { + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { "delete": { - "tags": [ - "Entity" - ], - "description": "Delete given labels to a given entity.", - "operationId": "Entity_RemoveLabels", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveLabels": { - "$ref": "./examples/Entity_RemoveLabels.json" - } - }, + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "classificationName", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "in": "body", - "schema": { - "description": "set of labels to be deleted", - "type": "array", - "items": { - "type": "string" - } - }, - "description": "set of labels to be deleted" + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Entity" - ], - "description": "Set labels to a given entity.", - "operationId": "Entity_SetLabels", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_SetLabel": { - "$ref": "./examples/Entity_SetLabels.json" + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" } - }, + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "put": { + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "description": "Update classification on an entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", "in": "body", + "description": "An array of classification to be updated.", + "required": true, "schema": { - "description": "set of labels to be set to the entity", "type": "array", "items": { - "type": "string" - } - }, - "description": "set of labels to be set to the entity" + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "description": "Add given labels to a given entity.", - "operationId": "Entity_AddLabel", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddLabel": { - "$ref": "./examples/Entity_AddLabel.json" + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" } - }, + } + }, + "post": { + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "description": "Add classification to the entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "body", + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, + "type": "string", + "x-ms-client-name": "attribute" + }, + { + "name": "body", "in": "body", + "description": "An array of classification to be added.", + "required": true, "schema": { - "description": "set of labels to be added", "type": "array", "items": { - "type": "string" - } - }, - "description": "set of labels to be added" + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } } } }, "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { - "delete": { - "tags": [ - "Entity" - ], - "operationId": "Entity_RemoveLabelsByUniqueAttribute", - "description": "Delete given labels to a given entity identified by its type and unique attribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_RemoveLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" - } - }, + "put": { + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be added", + "required": true, "schema": { - "description": "set of labels to be deleted", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be deleted" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } } }, "post": { - "tags": [ - "Entity" - ], "operationId": "Entity_SetLabelsByUniqueAttribute", - "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf labels is null/empty, existing labels will all be removed.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Entity_SetLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" - } - }, + "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be set", + "required": true, "schema": { - "description": "set of labels to be set", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be set" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Entity" - ], - "operationId": "Entity_AddLabelsByUniqueAttribute", - "description": "Add given labels to a given entity identified by its type and unique attributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=.\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "consumes": [ - "application/json" - ], + }, "x-ms-examples": { - "Entity_AddLabelsByUniqueAttribute": { - "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" } - }, + } + }, + "delete": { + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/typeName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" }, { "name": "attr:qualifiedName", "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", "required": false, - "type": "string" + "type": "string", + "x-ms-client-name": "attribute" }, { "name": "body", - "required": false, "in": "body", + "description": "set of labels to be deleted", + "required": true, "schema": { - "description": "set of labels to be added", "type": "array", "items": { "type": "string" } - }, - "description": "set of labels to be added" + } } ], "responses": { "204": { - "description": "Success" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/entity/moveTo": { - "post": { - "tags": [ - "Entity" - ], - "description": "Move existing entities to the target collection.", - "operationId": "Entity_MoveEntitiesToCollection", - "x-ms-examples": { - "Collection_MoveEntitiesToCollection": { - "$ref": "./examples/Entity_MoveEntitiesToCollection.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/requiredCollectionId" - }, - { - "$ref": "#/parameters/purviewAPIVersion" - }, - { - "in": "body", - "name": "body", - "description": "Entity guids to be moved to target collection.", - "required": true, - "schema": { - "$ref": "#/definitions/MoveEntitiesRequest" - } - } - ], - "responses": { - "200": { - "description": "Created with EntityMutationResponse.", - "schema": { - "$ref": "#/definitions/EntityMutationResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" } } } }, "/atlas/v2/glossary": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "operationId": "Glossary_List", - "x-ms-examples": { - "Glossary_List": { - "$ref": "./examples/Glossary_List.json" - } - }, + "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "parameters": [ { - "$ref": "#/parameters/limit" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/offset" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/atlasAPIVersion" + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "An array of existing glossaries fitting the search criteria or empty list if nothing matches.", + "description": "The request has succeeded.", "schema": { "type": "array", "items": { "$ref": "#/definitions/AtlasGlossary" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } } }, "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary.", "operationId": "Glossary_Create", - "x-ms-examples": { - "Glossary_Create": { - "$ref": "./examples/Glossary_Create.json" - } - }, + "description": "Create a glossary.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing the anchor attribute when creating the Term/Category.", + "in": "body", + "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -1622,2179 +1784,2370 @@ ], "responses": { "200": { - "description": "OK. If glossary creation was successful.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } } } }, - "/atlas/v2/glossary/categories": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create glossary category in bulk.", - "operationId": "Glossary_CreateCategories", - "x-ms-examples": { - "Glossary_CreateCategories": { - "$ref": "./examples/Glossary_CreateCategories.json" - } - }, + "/atlas/v2/glossary/{glossaryId}": { + "get": { + "operationId": "Glossary_Get", + "description": "Get a specific Glossary by its GUID.", "parameters": [ { - "in": "body", - "name": "body", - "description": "An array of glossary category definitions to be created.", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "type": "array", - "description": "An array of glossary category definitions.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } - } + "type": "string" } ], "responses": { "200": { - "description": "OK. If bulk glossary category creation was successful.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary category created successfully in bulk.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/category": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary category.", - "operationId": "Glossary_CreateCategory", + }, "x-ms-examples": { - "Glossary_CreateCategory": { - "$ref": "./examples/Glossary_CreateCategory.json" + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" } - }, - "parameters": [ - { - "in": "body", - "name": "body", - "description": "The glossary category definition. A category must be anchored to a Glossary when creating.\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation.", + } + }, + "put": { + "operationId": "Glossary_Update", + "description": "Update the given glossary.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "The glossary definition to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } } ], "responses": { "200": { - "description": "OK. If glossary category creation was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" + } } - } - }, - "/atlas/v2/glossary/category/{categoryId}": { - "get": { - "tags": [ - "Glossary" + }, + "delete": { + "operationId": "Glossary_Delete", + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + } ], - "description": "Get specific glossary category by its GUID.", - "operationId": "Glossary_GetCategory", - "x-ms-examples": { - "Glossary_GetCategory": { - "$ref": "./examples/Glossary_GetCategory.json" + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" + } + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories": { + "get": { + "operationId": "Glossary_ListCategories", + "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/categoryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary category exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary category by its GUID.", - "operationId": "Glossary_UpdateCategory", + }, "x-ms-examples": { - "Glossary_UpdateCategory": { - "$ref": "./examples/Glossary_UpdateCategory.json" + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" } - }, + } + } + }, + "/atlas/v2/glossary/{glossaryId}/categories/headers": { + "get": { + "operationId": "Glossary_ListCategoriesHeaders", + "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/categoryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "The glossary category to be updated.", + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", "required": true, - "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary category partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary category.", - "operationId": "Glossary_DeleteCategory", + }, "x-ms-examples": { - "Glossary_DeleteCategory": { - "$ref": "./examples/Glossary_DeleteCategory.json" + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" } - }, + } + } + }, + "/atlas/v2/glossary/{glossaryId}/detailed": { + "get": { + "operationId": "Glossary_GetDetailed", + "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", "parameters": [ { - "$ref": "#/parameters/categoryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" } ], "responses": { - "204": { - "description": "OK. If glossary category deletion is successful." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryExtInfo" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } } } }, - "/atlas/v2/glossary/category/{categoryId}/partial": { + "/atlas/v2/glossary/{glossaryId}/partial": { "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.", - "operationId": "Glossary_PartialUpdateCategory", - "x-ms-examples": { - "Glossary_PartialUpdateCategory": { - "$ref": "./examples/Glossary_PartialUpdateCategory.json" - } - }, + "operationId": "Glossary_PartialUpdate", + "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", "parameters": [ { - "$ref": "#/parameters/categoryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" + }, + { + "name": "ignoreTermsAndCategories", + "in": "query", + "description": "Whether ignore terms and categories", + "required": false, + "type": "boolean" }, { - "in": "body", "name": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute values for partial update.", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues.", "required": true, "schema": { "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "additionalProperties": { + "type": "string" + } } } ], "responses": { "200": { - "description": "OK. If glossary category partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryCategory" + "$ref": "#/definitions/AtlasGlossary" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } } } }, - "/atlas/v2/glossary/category/{categoryId}/related": { + "/atlas/v2/glossary/{glossaryId}/terms": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", - "operationId": "Glossary_ListRelatedCategories", - "x-ms-examples": { - "Glossary_ListRelatedCategories": { - "$ref": "./examples/Glossary_ListRelatedCategories.json" - } - }, + "operationId": "Glossary_ListTerms", + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", "parameters": [ { - "$ref": "#/parameters/categoryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. Gets an array of related categories.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/RelatedCategoryHeaders" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } } } }, - "/atlas/v2/glossary/category/{categoryId}/terms": { + "/atlas/v2/glossary/{glossaryId}/terms/headers": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all terms associated with the specific category.", - "operationId": "Glossary_ListCategoryTerms", - "x-ms-examples": { - "Glossary_ListCategoryTerms": { - "$ref": "./examples/Glossary_ListCategoryTerms.json" - } - }, + "operationId": "Glossary_ListTermHeaders", + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", "parameters": [ { - "$ref": "#/parameters/categoryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "glossaryId", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "An array of terms for the given category or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of terms for the given category or an empty list.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } } } }, - "/atlas/v2/glossary/term": { + "/atlas/v2/glossary/categories": { "post": { - "tags": [ - "Glossary" - ], - "description": "Create a glossary term.", - "operationId": "Glossary_CreateTerm", - "x-ms-examples": { - "Glossary_CreateTerm": { - "$ref": "./examples/Glossary_CreateTerm.json" - }, - "Glossary_CreateTermWithTemplate": { - "$ref": "./examples/Glossary_CreateTermWithTemplate.json" - } - }, + "operationId": "Glossary_CreateCategories", + "description": "Create glossary category in bulk.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time of creation.\nOptionally it can be categorized as well.", + "in": "body", + "description": "An array of glossary category definitions to be created.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } - }, - { - "$ref": "#/parameters/includeTermHierarchy" } ], "responses": { "200": { - "description": "OK. If glossary term creation was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" + } } } }, - "/atlas/v2/glossary/term/{termId}": { - "get": { - "tags": [ - "Glossary" + "/atlas/v2/glossary/category": { + "post": { + "operationId": "Glossary_CreateCategory", + "description": "Create a glossary category.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } ], - "description": "Get a specific glossary term by its GUID. ", - "operationId": "Glossary_GetTerm", - "x-ms-examples": { - "Glossary_GetTerm": { - "$ref": "./examples/Glossary_GetTerm.json" + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } }, - "Glossary_GetTerm_WithoutAssets": { - "$ref": "./examples/Glossary_GetTermWithoutAssets.json" + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" + } + } + } + }, + "/atlas/v2/glossary/category/{categoryId}": { + "get": { + "operationId": "Glossary_GetCategory", + "description": "Get specific glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/termId" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary term exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" + } } }, "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary term by its GUID.", - "operationId": "Glossary_UpdateTerm", - "x-ms-examples": { - "Glossary_UpdateTerm": { - "$ref": "./examples/Glossary_UpdateTerm.json" - } - }, + "operationId": "Glossary_UpdateCategory", + "description": "Update the given glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/termId" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", - "description": "The glossary term to be updated.", + "in": "body", + "description": "The glossary category to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } - }, - { - "$ref": "#/parameters/includeTermHierarchy" } ], "responses": { "200": { - "description": "OK. If glossary term update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } } }, "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary term.", - "operationId": "Glossary_DeleteTerm", - "x-ms-examples": { - "Glossary_DeleteTerm": { - "$ref": "./examples/Glossary_DeleteTerm.json" - } - }, + "operationId": "Glossary_DeleteCategory", + "description": "Delete a glossary category.", "parameters": [ { - "$ref": "#/parameters/termId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "OK. If glossary term delete was successful." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } } } }, - "/atlas/v2/glossary/term/{termId}/partial": { + "/atlas/v2/glossary/category/{categoryId}/partial": { "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.", - "operationId": "Glossary_PartialUpdateTerm", - "x-ms-examples": { - "Glossary_PartialUpdateTerm": { - "$ref": "./examples/Glossary_PartialUpdateTerm.json" - } - }, + "operationId": "Glossary_PartialUpdateCategory", + "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/includeTermHierarchy" + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute values to be updated.", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues for partial update.", "required": true, "schema": { "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "additionalProperties": { + "type": "string" + } } } ], "responses": { "200": { - "description": "OK. If glossary partial update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "$ref": "#/definitions/AtlasGlossaryCategory" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } } } }, - "/atlas/v2/glossary/terms": { - "post": { - "tags": [ - "Glossary" - ], - "description": "Create glossary terms in bulk.", - "operationId": "Glossary_CreateTerms", - "x-ms-examples": { - "Glossary_CreateTerms": { - "$ref": "./examples/Glossary_CreateTerms.json" - } - }, + "/atlas/v2/glossary/category/{categoryId}/related": { + "get": { + "operationId": "Glossary_ListRelatedCategories", + "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "An array of glossary term definitions to be created in bulk.", + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", "required": true, - "schema": { - "type": "array", - "description": "An array of glossary term definitions.", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } - } + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/includeTermHierarchy" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If bulk glossary terms creation was successful.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "If bulk glossary terms creation was successful.", - "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "type": "array", + "x-ms-identifiers": [] } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" + } } } }, - "/atlas/v2/glossary/terms/{termId}/assignedEntities": { + "/atlas/v2/glossary/category/{categoryId}/terms": { "get": { - "tags": [ - "Glossary" - ], - "description": "List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListEntitiesAssignedWithTerm", - "x-ms-examples": { - "Glossary_ListEntitiesAssignedWithTerm": { - "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" - } - }, + "operationId": "Glossary_ListCategoryTerms", + "description": "Get all terms associated with the specific category.", "parameters": [ { - "$ref": "#/parameters/termId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "categoryId", + "in": "path", + "description": "The globally unique identifier of the category.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of related objects (if any) for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of related objects (if any) for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Glossary" - ], - "description": "Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.\n\n[Entities Create Or Update operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities.", - "operationId": "Glossary_AssignTermToEntities", + }, "x-ms-examples": { - "Glossary_AssignTermToEntities": { - "$ref": "./examples/Glossary_AssignTermToEntities.json" + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" } - }, + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "operationId": "Glossary_CreateTerm", + "description": "Create a glossary term.", "parameters": [ { - "$ref": "#/parameters/termId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "in": "body", "name": "body", - "description": "An array of related object IDs to which the term has to be associated.", + "in": "body", + "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", "required": true, "schema": { - "type": "array", - "description": "An array of related object IDs to which the term has to be associated.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasGlossaryTerm" } } ], "responses": { - "204": { - "description": "OK. If the term assignment was successful." - }, - "default": { - "description": "Error response describing why the operation failed.", + "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasGlossaryTerm" } - } - } - }, - "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete the term assignment for the given list of related objects.", - "operationId": "Glossary_DeleteTermAssignmentFromEntities", - "x-ms-examples": { - "Glossary_RemoveTermAssignmentFromEntities": { - "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/termId" }, - { - "in": "body", - "name": "body", - "description": "An array of related object IDs from which the term has to be dissociated.", - "required": true, + "default": { + "description": "An unexpected error response.", "schema": { - "type": "array", - "description": "An array of related object IDs from which the term has to be dissociated.", - "items": { - "$ref": "#/definitions/AtlasRelatedObjectId" - } + "$ref": "#/definitions/AtlasErrorResponse" } } - ], - "responses": { - "204": { - "description": "OK. If glossary term dissociation was successful." + }, + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" } } } }, - "/atlas/v2/glossary/terms/{termId}/related": { + "/atlas/v2/glossary/term/{termId}": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", - "operationId": "Glossary_ListRelatedTerms", - "x-ms-examples": { - "Glossary_ListRelatedTerms": { - "$ref": "./examples/Glossary_ListRelatedTerms.json" - } - }, + "operationId": "Glossary_GetTerm", + "description": "Get a specific glossary term by its GUID. ", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/termId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/limit" - }, - { - "$ref": "#/parameters/offset" - }, - { - "$ref": "#/parameters/sort" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of related glossary terms for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/RelatedTermHeaders" + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryId}": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific Glossary by its GUID.", - "operationId": "Glossary_Get", - "x-ms-examples": { - "Glossary_Get": { - "$ref": "./examples/Glossary_Get.json" - } }, - "parameters": [ - { - "$ref": "#/parameters/glossaryId" - } - ], - "responses": { - "200": { - "description": "OK. If glossary with given guid exists.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } + "Glossary_GetTermWithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" } } }, "put": { - "tags": [ - "Glossary" - ], - "description": "Update the given glossary.", - "operationId": "Glossary_Update", - "x-ms-examples": { - "Glossary_Update": { - "$ref": "./examples/Glossary_Update.json" - } - }, + "operationId": "Glossary_UpdateTerm", + "description": "Update the given glossary term by its GUID.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/glossaryId" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "in": "body", "name": "body", - "description": "The glossary definition to be updated.", + "in": "body", + "description": "The glossary term to be updated.", "required": true, "schema": { - "$ref": "#/definitions/AtlasGlossary" + "$ref": "#/definitions/AtlasGlossaryTerm" } } ], "responses": { "200": { - "description": "OK. If glossary update was successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossary" + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } } }, "delete": { - "tags": [ - "Glossary" - ], - "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.", - "operationId": "Glossary_Delete", - "x-ms-examples": { - "Glossary_Delete": { - "$ref": "./examples/Glossary_Delete.json" - } - }, + "operationId": "Glossary_DeleteTerm", + "description": "Delete a glossary term.", "parameters": [ { - "$ref": "#/parameters/glossaryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "OK. If glossary delete was successful." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } } } }, - "/atlas/v2/glossary/{glossaryId}/categories": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListCategories", - "x-ms-examples": { - "Glossary_ListCategories": { - "$ref": "./examples/Glossary_ListCategories.json" - } - }, + "/atlas/v2/glossary/term/{termId}/partial": { + "put": { + "operationId": "Glossary_PartialUpdateTerm", + "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", "parameters": [ { - "$ref": "#/parameters/glossaryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/limit" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/offset" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "A map containing keys as attribute names and values as corresponding attribute\nvalues to be updated.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } } ], "responses": { "200": { - "description": "OK. An array of glossary categories for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary categories for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasGlossaryCategory" - } + "$ref": "#/definitions/AtlasGlossaryTerm" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } } } }, - "/atlas/v2/glossary/{glossaryId}/categories/headers": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListCategoriesHeaders", - "x-ms-examples": { - "Glossary_ListCategoriesHeaders": { - "$ref": "./examples/Glossary_ListCategoriesHeaders.json" - } - }, + "/atlas/v2/glossary/terms": { + "post": { + "operationId": "Glossary_CreateTerms", + "description": "Create glossary terms in bulk.", "parameters": [ { - "$ref": "#/parameters/glossaryId" - }, - { - "$ref": "#/parameters/limit" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/offset" + "name": "includeTermHierarchy", + "in": "query", + "description": "Whether include term hierarchy", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/sort" + "name": "body", + "in": "body", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] + } } ], "responses": { "200": { - "description": "OK. An array of glossary category headers for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of glossary category headers for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + "$ref": "#/definitions/AtlasGlossaryTerm" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } } } }, - "/atlas/v2/glossary/{glossaryId}/detailed": { + "/atlas/v2/glossary/terms/{termId}/assignedEntities": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get a specific glossary with detailed information. This API is not recommend.\n\nRecommend to fetch terms/categories details separately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", - "operationId": "Glossary_GetDetailed", - "x-ms-examples": { - "Glossary_GetDetailed": { - "$ref": "./examples/Glossary_GetDetailed.json" - } - }, + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/glossaryId" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. If glossary exists for given GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasGlossaryExtInfo" + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/partial": { - "put": { - "tags": [ - "Glossary" - ], - "description": "Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.\n\nSo far we only supports partial updating shortDescription, longDescription, language and usage for glossary. \n\nRecommend using 'ignoreTermsAndCategories=true' to reduce response body size.", - "operationId": "Glossary_PartialUpdate", + }, "x-ms-examples": { - "Glossary_PartialUpdate": { - "$ref": "./examples/Glossary_PartialUpdate.json" + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" } - }, + } + }, + "post": { + "operationId": "Glossary_AssignTermToEntities", + "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/glossaryId" - }, - { - "$ref": "#/parameters/ignoreTermsAndCategories" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", - "description": "A map containing keys as attribute names and values as corresponding attribute values.", + "in": "body", + "description": "An array of related object IDs to which the term has to be associated.", "required": true, "schema": { - "type": "object", - "description": "A map containing keys as attribute names and values as corresponding attribute values." + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } } ], "responses": { - "200": { - "description": "OK. If glossary partial update was successful.", - "schema": { - "$ref": "#/definitions/AtlasGlossary" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/glossary/{glossaryId}/terms": { - "get": { - "tags": [ - "Glossary" - ], - "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListTerms", + }, "x-ms-examples": { - "Glossary_ListTerms": { - "$ref": "./examples/Glossary_ListTerms.json" + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" } - }, + } + }, + "delete": { + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "description": "Delete the term assignment for the given list of related objects.", "parameters": [ { - "$ref": "#/parameters/atlasAPIVersion" - }, - { - "$ref": "#/parameters/glossaryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/limit" - }, - { - "$ref": "#/parameters/offset" + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/sort" - } - ], - "responses": { - "200": { - "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "name": "body", + "in": "body", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, "schema": { "type": "array", - "description": "An array of glossary terms for the given glossary or an empty list.", "items": { - "$ref": "#/definitions/AtlasGlossaryTerm" - } + "$ref": "#/definitions/AtlasRelatedObjectId" + }, + "x-ms-identifiers": [] } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } } } }, - "/atlas/v2/glossary/{glossaryId}/terms/headers": { + "/atlas/v2/glossary/terms/{termId}/related": { "get": { - "tags": [ - "Glossary" - ], - "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", - "operationId": "Glossary_ListTermHeaders", - "x-ms-examples": { - "Glossary_ListTermHeaders": { - "$ref": "./examples/Glossary_ListTermHeaders.json" - } - }, + "operationId": "Glossary_ListRelatedTerms", + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/glossaryId" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "termId", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/limit" + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/offset" + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "#/parameters/sort" + "name": "sort", + "in": "query", + "description": "The sort order, ASC (default) or DESC.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "description": "The request has succeeded.", "schema": { - "type": "array", - "description": "An array of glossary terms for the given glossary or an empty list.", - "items": { - "$ref": "#/definitions/AtlasRelatedTermHeader" + "type": "object", + "additionalProperties": { + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "type": "array", + "x-ms-identifiers": [] } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" + } } } }, - "/search/query": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get data using search.", - "operationId": "Discovery_Query", - "x-ms-examples": { - "Discovery_Query": { - "$ref": "./examples/Discovery_Query.json" - }, - "Discovery_Query_And": { - "$ref": "./examples/Discovery_Query_And.json" - }, - "Discovery_Query_Not": { - "$ref": "./examples/Discovery_Query_Not.json" - }, - "Discovery_Query_AndOrNested": { - "$ref": "./examples/Discovery_Query_AndOrNested.json" - }, - "Discovery_Query_SystemTime": { - "$ref": "./examples/Discovery_Query_SystemTime.json" - }, - "Discovery_Query_BusinessMetadataAttribute": { - "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" - }, - "Discovery_Query_Attribute": { - "$ref": "./examples/Discovery_Query_Attribute.json" - }, - "Discovery_Query_Classification": { - "$ref": "./examples/Discovery_Query_Classification.json" - }, - "Discovery_Query_FileExtension": { - "$ref": "./examples/Discovery_Query_FileExtension.json" - }, - "Discovery_Query_Id": { - "$ref": "./examples/Discovery_Query_Id.json" - }, - "Discovery_Query_EntityType": { - "$ref": "./examples/Discovery_Query_Type.json" - }, - "Discovery_Query_AssetType": { - "$ref": "./examples/Discovery_Query_AssetType.json" - }, - "Discovery_Query_Term": { - "$ref": "./examples/Discovery_Query_TermAssignment.json" - }, - "Discovery_Query_Facet": { - "$ref": "./examples/Discovery_Query_Facet.json" - }, - "Discovery_Query_Taxonomy": { - "$ref": "./examples/Discovery_Query_Taxonomy.json" - }, - "Discovery_Query_Collection": { - "$ref": "./examples/Discovery_Query_Collection.json" - }, - "Discovery_Query_GlossaryTerm": { - "$ref": "./examples/Discovery_Query_GlossaryTerm.json" - }, - "Discovery_Query_ObjectType": { - "$ref": "./examples/Discovery_Query_ObjectType.json" + "/atlas/v2/lineage/{guid}": { + "get": { + "operationId": "Lineage_Get", + "description": "Get lineage info of the entity specified by GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, - "Discovery_Query_PaginationFirstPage": { - "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" }, - "Discovery_Query_PaginationContinuationPage": { - "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" }, - "Discovery_Query_PaginationLastPage": { - "$ref": "./examples/Discovery_Query_PaginationLastPage.json" - } - }, - "parameters": [ { - "in": "body", - "name": "body", - "description": "An object specifying the search criteria.", + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", "required": true, - "schema": { - "$ref": "#/definitions/SearchRequest" + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] } - }, - { - "$ref": "#/parameters/purviewAPIVersion" } ], "responses": { "200": { - "description": "OK. On successful lookup of the advanced search.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SearchResult" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } } } }, - "/search/suggest": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get search suggestions by query criteria.", - "operationId": "Discovery_Suggest", - "x-ms-examples": { - "Discovery_Suggest": { - "$ref": "./examples/Discovery_Suggest.json" - } - }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "operationId": "Lineage_GetByUniqueAttribute", + "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "in": "body", - "name": "body", - "description": "An object specifying the suggest criteria.", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "typeName", + "in": "path", + "description": "The name of the type.", "required": true, - "schema": { - "$ref": "#/definitions/SuggestRequest" + "type": "string" + }, + { + "name": "depth", + "in": "query", + "description": "The number of hops for lineage.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] } }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can\nbe changed to other unique attributes)", + "required": false, + "type": "string", + "x-ms-client-name": "attribute" } ], "responses": { "200": { - "description": "OK. On successful lookup of the suggestions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/SuggestResult" + "$ref": "#/definitions/AtlasLineageInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } } } }, - "/search/autocomplete": { - "post": { - "tags": [ - "Discovery" - ], - "description": "Get auto complete options.", - "operationId": "Discovery_AutoComplete", - "x-ms-examples": { - "Discovery_AutoComplete": { - "$ref": "./examples/Discovery_AutoComplete.json" - } - }, + "/atlas/v2/relationship": { + "put": { + "operationId": "Relationship_Update", + "description": "Update an existing relationship between entities.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", - "description": "An object specifying the autocomplete criteria.", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", "required": true, "schema": { - "$ref": "#/definitions/AutoCompleteRequest" + "$ref": "#/definitions/AtlasRelationship" } - }, - { - "$ref": "#/parameters/purviewAPIVersion" } ], "responses": { "200": { - "description": "OK. On successful lookup of the auto complete options.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AutoCompleteResult" + "$ref": "#/definitions/AtlasRelationship" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" + } } - } - }, - "/atlas/v2/lineage/{guid}": { - "get": { - "tags": [ - "Lineage" - ], - "description": "Get lineage info of the entity specified by GUID.", - "operationId": "Lineage_Get", - "x-ms-examples": { - "Lineage_Get": { - "$ref": "./examples/Lineage_Get.json" - } - }, + }, + "post": { + "operationId": "Relationship_Create", + "description": "Create a new relationship between entities.", "parameters": [ { - "$ref": "#/parameters/guid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/depth" - }, - { - "$ref": "#/parameters/direction" + "name": "body", + "in": "body", + "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } } ], "responses": { "200": { - "description": "OK. If the request is valid.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasLineageInfo" + "$ref": "#/definitions/AtlasRelationship" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } } } }, - "/lineage/{guid}/next/": { + "/atlas/v2/relationship/guid/{guid}": { "get": { - "tags": [ - "Lineage" - ], - "description": "Return immediate next page lineage info about entity with pagination", - "operationId": "Lineage_GetNextPage", - "x-ms-examples": { - "Lineage_GetNextPage": { - "$ref": "./examples/Lineage_GetNextPage.json" - } - }, + "operationId": "Relationship_Get", + "description": "Get relationship information between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/guid" - }, - { - "$ref": "#/parameters/direction" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/offset" - }, - { - "$ref": "#/parameters/limit" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "extendedInfo", + "in": "query", + "description": "Limits whether includes extended information.", + "required": false, + "type": "boolean" } ], "responses": { "200": { - "description": "OK. If the input is valid.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasLineageInfo" + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { - "get": { - "tags": [ - "Lineage" - ], - "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\nThe REST request would look something like this:\n\nGET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", - "operationId": "Lineage_GetByUniqueAttribute", + }, "x-ms-examples": { - "Lineage_GetByUniqueAttribute": { - "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" } - }, - "produces": [ - "application/json" - ], + } + }, + "delete": { + "operationId": "Relationship_Delete", + "description": "Delete a relationship between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/typeName" - }, - { - "$ref": "#/parameters/depth" - }, - { - "$ref": "#/parameters/direction" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "name": "attr:qualifiedName", - "in": "query", - "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", - "required": false, + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, "type": "string" } ], "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasLineageInfo", - "description": "If Lineage exists for the given entity" - }, - "description": "If Lineage exists for the given entity" + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } } } }, - "/atlas/v2/relationship": { - "post": { - "tags": [ - "Relationship" - ], - "description": "Create a new relationship between entities.", - "operationId": "Relationship_Create", - "x-ms-examples": { - "Relationship_Create": { - "$ref": "./examples/Relationship_Create.json" - } - }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByGuid", + "description": "Get the businessMetadata definition for the given guid.", "parameters": [ { - "in": "body", - "name": "body", - "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "businessMetadata guid", "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } + "type": "string" } ], "responses": { "200": { - "description": "OK. The relationship is created.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasBusinessMetadataDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Relationship" - ], - "description": "Update an existing relationship between entities.", - "operationId": "Relationship_Update", + }, "x-ms-examples": { - "Relationship_Update": { - "$ref": "./examples/Relationship_Update.json" + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" } - }, + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "operationId": "Type_GetBusinessMetadataDefByName", + "description": "Get the businessMetadata definition by it's name (unique).", "parameters": [ { - "in": "body", - "name": "body", - "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "businessMetadata name", "required": true, - "schema": { - "$ref": "#/definitions/AtlasRelationship" - } + "type": "string" } ], "responses": { "200": { - "description": "OK. The relationship is updated.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasBusinessMetadataDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } } } }, - "/atlas/v2/relationship/guid/{guid}": { + "/atlas/v2/types/classificationdef/guid/{guid}": { "get": { - "tags": [ - "Relationship" - ], - "description": "Get relationship information between entities by its GUID.", - "operationId": "Relationship_Get", - "x-ms-examples": { - "Relationship_Get": { - "$ref": "./examples/Relationship_Get.json" - } - }, + "operationId": "Type_GetClassificationDefByGuid", + "description": "Get the classification definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/relationshipGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/extendedInfo" + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the classification.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + "$ref": "#/definitions/AtlasClassificationDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Relationship" - ], - "description": "Delete a relationship between entities by its GUID.", - "operationId": "Relationship_Delete", + }, "x-ms-examples": { - "Relationship_Delete": { - "$ref": "./examples/Relationship_Delete.json" + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" } - }, + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "operationId": "Type_GetClassificationDefByName", + "description": "Get the classification definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/relationshipGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the classification.", + "required": true, + "type": "string" } ], "responses": { - "204": { - "description": "OK. The relationship is deleted." + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } } } }, - "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "/atlas/v2/types/entitydef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the businessMetadata definition for the given guid.", - "operationId": "Type_GetBusinessMetadataDefByGuid", - "x-ms-examples": { - "Type_GetBusinessMetadataDefByGuid": { - "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" - } - }, - "produces": [ - "application/json" - ], + "operationId": "Type_GetEntityDefByGuid", + "description": "Get the Entity definition for the given GUID.", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "guid", "in": "path", - "type": "string", - "description": "businessMetadata guid", - "required": true + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef", - "description": "On successful lookup of the the businessMetadata definition by it's guid" - }, - "description": "On successful lookup of the the businessMetadata definition by it's guid" + "$ref": "#/definitions/AtlasEntityDef" + } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } } } }, - "/atlas/v2/types/businessmetadatadef/name/{name}": { + "/atlas/v2/types/entitydef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the businessMetadata definition by it's name (unique).", - "operationId": "Type_GetBusinessMetadataDefByName", - "x-ms-examples": { - "Type_GetBusinessMetadataDefByName": { - "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" - } - }, - "produces": [ - "application/json" - ], + "operationId": "Type_GetEntityDefByName", + "description": "Get the entity definition by its name (unique).", "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, { "name": "name", "in": "path", - "type": "string", - "description": "businessMetadata name", - "required": true - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/AtlasBusinessMetadataDef", - "description": "On successful lookup of the the businessMetadata definition by it's name" - }, - "description": "On successful lookup of the the businessMetadata definition by it's name" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/classificationdef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the classification definition for the given GUID.", - "operationId": "Type_GetClassificationDefByGuid", - "x-ms-examples": { - "Type_GetClassificationDefByGuid": { - "$ref": "./examples/Type_GetClassificationDefByGuid.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/classificationDefGuid" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the classification definition by its GUID.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/classificationdef/name/{name}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the classification definition by its name (unique).", - "operationId": "Type_GetClassificationDefByName", - "x-ms-examples": { - "Type_GetClassificationDefByName": { - "$ref": "./examples/Type_GetClassificationDefByName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/classificationDefName" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the classification definition by its name.", - "schema": { - "$ref": "#/definitions/AtlasClassificationDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/atlas/v2/types/entitydef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the Entity definition for the given GUID.", - "operationId": "Type_GetEntityDefByGuid", - "x-ms-examples": { - "Type_GetEntityDefByGuid": { - "$ref": "./examples/Type_GetEntityDefByGuid.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/entityDefGuid" + "description": "The name of the entity.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the entity definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasEntityDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - } - }, - "/atlas/v2/types/entitydef/name/{name}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the entity definition by its name (unique).", - "operationId": "Type_GetEntityDefByName", + }, "x-ms-examples": { "Type_GetEntityDefByName": { "$ref": "./examples/Type_GetEntityDefByName.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/entityDefName" - } - ], - "responses": { - "200": { - "description": "OK. On successful lookup of the the entity definition by its name.", - "schema": { - "$ref": "#/definitions/AtlasEntityDef" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } } } }, "/atlas/v2/types/enumdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the enum definition for the given GUID.", "operationId": "Type_GetEnumDefByGuid", - "x-ms-examples": { - "Type_GetEnumDefByGuid": { - "$ref": "./examples/Type_GetEnumDefByGuid.json" - } - }, + "description": "Get the enum definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/enumDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the enum.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the enum definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasEnumDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } } } }, "/atlas/v2/types/enumdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the enum definition by its name (unique).", "operationId": "Type_GetEnumDefByName", - "x-ms-examples": { - "Type_GetEnumDefByName": { - "$ref": "./examples/Type_GetEnumDefByName.json" - } - }, + "description": "Get the enum definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/enumDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the enum.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the enum definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasEnumDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } } } }, "/atlas/v2/types/relationshipdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the relationship definition for the given GUID.", "operationId": "Type_GetRelationshipDefByGuid", - "x-ms-examples": { - "Type_GetRelationshipDefByGuid": { - "$ref": "./examples/Type_GetRelationshipDefByGuid.json" - } - }, + "description": "Get the relationship definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/relationshipDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the relationship.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the relationship definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasRelationshipDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } } } }, "/atlas/v2/types/relationshipdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the relationship definition by its name (unique).", "operationId": "Type_GetRelationshipDefByName", - "x-ms-examples": { - "Type_GetRelationshipDefByName": { - "$ref": "./examples/Type_GetRelationshipDefByName.json" - } - }, + "description": "Get the relationship definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/relationshipDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the relationship.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the relationship definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasRelationshipDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } } } }, "/atlas/v2/types/structdef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the struct definition for the given GUID.", "operationId": "Type_GetStructDefByGuid", - "x-ms-examples": { - "Type_GetStructDefByGuid": { - "$ref": "./examples/Type_GetStructDefByGuid.json" - } - }, + "description": "Get the struct definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/structDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the struct.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the struct definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasStructDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetStructDefByGuid": { + "$ref": "./examples/Type_GetStructDefByGuid.json" + } } } }, "/atlas/v2/types/structdef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the struct definition by its name (unique).", "operationId": "Type_GetStructDefByName", - "x-ms-examples": { - "Type_GetStructDefByName": { - "$ref": "./examples/Type_GetStructDefByName.json" - } - }, + "description": "Get the struct definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/structDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the struct.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the struct definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasStructDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } } } }, "/atlas/v2/types/typedef/guid/{guid}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the type definition for the given GUID.", "operationId": "Type_GetByGuid", - "x-ms-examples": { - "Type_GetByGuid": { - "$ref": "./examples/Type_GetByGuid.json" - } - }, + "description": "Get the type definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/typeDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the type.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the type definition by its GUID.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypeDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } } } }, "/atlas/v2/types/typedef/name/{name}": { "get": { - "tags": [ - "Type" - ], - "description": "Get the type definition by its name (unique).", "operationId": "Type_GetByName", - "x-ms-examples": { - "Type_GetByName": { - "$ref": "./examples/Type_GetByName.json" - } - }, + "description": "Get the type definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/typeDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "OK. On successful lookup of the the type definition by its name.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypeDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "delete": { - "tags": [ - "Type" - ], - "description": "Delete API for type identified by its name.", - "operationId": "Type_Delete", + }, "x-ms-examples": { - "Type_Delete": { - "$ref": "./examples/Type_Delete.json" + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" } - }, + } + }, + "delete": { + "operationId": "Type_Delete", + "description": "Delete API for type identified by its name.", "parameters": [ { - "$ref": "#/parameters/typeDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the type.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "On successful deletion of the requested type definitions" + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } } } }, "/atlas/v2/types/typedefs": { "get": { - "tags": [ - "Type" - ], - "description": "List all type definitions in bulk.", "operationId": "Type_List", - "x-ms-examples": { - "Type_List": { - "$ref": "./examples/Type_List.json" - }, - "Type_ListEnumDefs": { - "$ref": "./examples/Type_ListEnumDefs.json" - }, - "Type_ListTermTemplateDefs": { - "$ref": "./examples/Type_ListTermTemplateDefs.json" - } - }, + "description": "List all type definitions in bulk.", "parameters": [ { - "$ref": "#/parameters/includeTermTemplate" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/type" + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } } ], "responses": { "200": { - "description": "OK. AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "post": { - "tags": [ - "Type" - ], - "description": "Create all atlas type definitions in bulk, only new definitions will be created.\nAny changes to the existing definitions will be discarded.", - "operationId": "Type_BulkCreate", + }, "x-ms-examples": { - "Type_BulkCreate": { - "$ref": "./examples/Type_BulkCreate.json" + "Type_List": { + "$ref": "./examples/Type_List.json" }, - "Type_BulkCreateBusinessMetadataDefs": { - "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" } - }, + } + }, + "put": { + "operationId": "Type_BulkUpdate", + "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", - "description": "A composite wrapper object with corresponding lists of the type definition.", + "in": "body", + "description": "A composite object that captures all type definition changes.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3803,35 +4156,35 @@ ], "responses": { "200": { - "description": "OK. On successful update of requested type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } - } - }, - "put": { - "tags": [ - "Type" - ], - "description": "Update all types in bulk, changes detected in the type definitions would be persisted.", - "operationId": "Type_BulkUpdate", + }, "x-ms-examples": { "Type_BulkUpdate": { "$ref": "./examples/Type_BulkUpdate.json" } - }, + } + }, + "post": { + "operationId": "Type_BulkCreate", + "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", - "description": "A composite object that captures all type definition changes.", + "in": "body", + "description": "A composite wrapper object with corresponding lists of the type definition.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3840,34 +4193,37 @@ ], "responses": { "200": { - "description": "OK. On successful update of requested type definitions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AtlasTypesDef" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + } } }, "delete": { - "tags": [ - "Type" - ], - "description": "Delete API for all types in bulk.", "operationId": "Type_BulkDelete", - "x-ms-examples": { - "Type_BulkDelete": { - "$ref": "./examples/Type_BulkDelete.json" - } - }, + "description": "Delete API for all types in bulk.", "parameters": [ { - "in": "body", + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { "name": "body", + "in": "body", "description": "A composite object that captures all types to be deleted", "required": true, "schema": { @@ -3877,147 +4233,539 @@ ], "responses": { "204": { - "description": "OK. On successful deletion of the requested type definitions." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } } } }, "/atlas/v2/types/typedefs/headers": { "get": { - "tags": [ - "Type" - ], - "description": "List all type definitions returned as a list of minimal information header.", "operationId": "Type_ListHeaders", - "x-ms-examples": { - "Type_ListHeaders": { - "$ref": "./examples/Type_ListHeaders.json" - } - }, + "description": "List all type definitions returned as a list of minimal information header.", "parameters": [ { - "$ref": "#/parameters/includeTermTemplate" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/type" + "name": "includeTermTemplate", + "in": "query", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true\nwhen search filter type=term_template", + "required": false, + "type": "boolean" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "type", + "in": "query", + "description": "Typedef name as search filter when get typedefs.", + "required": false, + "type": "string", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } } ], "responses": { "200": { - "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", + "description": "The request has succeeded.", "schema": { "type": "array", - "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", "items": { "$ref": "#/definitions/AtlasTypeDefHeader" - } + }, + "x-ms-identifiers": [] } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } } } }, - "/types/termtemplatedef/guid/{guid}": { - "get": { - "tags": [ - "Type" - ], - "description": "Get the term template definition for the given GUID.", - "operationId": "Type_GetTermTemplateDefByGuid", - "x-ms-examples": { - "Type_GetTermTemplateDefByGuid": { - "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" - } - }, + "/entity/moveTo": { + "post": { + "operationId": "Entity_MoveEntitiesToCollection", + "description": "Move existing entities to the target collection.", "parameters": [ { - "$ref": "#/parameters/termTemplateDefGuid" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "collectionId", + "in": "query", + "description": "The collection where entities will be moved to.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "body", + "in": "body", + "description": "Entity guids to be moved to target collection.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesOptions" + } } ], "responses": { "200": { - "description": "OK. On successful lookup of the the term template definition by its GUID.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TermTemplateDef" + "$ref": "#/definitions/EntityMutationResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Entity_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } } } }, - "/types/termtemplatedef/name/{name}": { + "/lineage/{guid}/next": { "get": { - "tags": [ - "Type" + "operationId": "Lineage_GetNextPage", + "description": "Return immediate next page lineage info about entity with pagination", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the entity.", + "required": true, + "type": "string" + }, + { + "name": "direction", + "in": "query", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "required": true, + "type": "string", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] + } + }, + { + "name": "offset", + "in": "query", + "description": "The offset for pagination purpose.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "in": "query", + "description": "The page size - by default there is no paging.", + "required": false, + "type": "integer", + "format": "int32" + } ], - "description": "Get the term template definition by its name (unique).", - "operationId": "Type_GetTermTemplateDefByName", - "x-ms-examples": { - "Type_GetTermTemplateDefByName": { - "$ref": "./examples/Type_GetTermTemplateDefByName.json" + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } } }, + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } + } + } + }, + "/search/autocomplete": { + "post": { + "operationId": "Discovery_AutoComplete", + "description": "Get auto complete options.", "parameters": [ { - "$ref": "#/parameters/termTemplateDefName" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/purviewAPIVersion" + "name": "body", + "in": "body", + "description": "An object specifying the autocomplete criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteOptions" + } } ], "responses": { "200": { - "description": "OK. On successful lookup of the the term template definition by its name.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/TermTemplateDef" + "$ref": "#/definitions/AutoCompleteResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/AtlasErrorResponse" } } + }, + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } } } - } - }, - "definitions": { - "AtlasAttributeDef": { - "type": "object", - "properties": { - "cardinality": { - "$ref": "#/definitions/Cardinality" - }, - "constraints": { - "type": "array", - "description": "An array of constraints.", - "items": { - "$ref": "#/definitions/AtlasConstraintDef" + }, + "/search/query": { + "post": { + "operationId": "Discovery_Query", + "description": "Get data using search.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "An object specifying the search criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryOptions" + } } - }, + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_TermAssignment": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Type": { + "$ref": "./examples/Discovery_Query_Type.json" + } + } + } + }, + "/search/suggest": { + "post": { + "operationId": "Discovery_Suggest", + "description": "Get search suggestions by query criteria.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "An object specifying the suggest criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" + } + } + } + }, + "/types/termtemplatedef/guid/{guid}": { + "get": { + "operationId": "Type_GetTermTemplateDefByGuid", + "description": "Get the term template definition for the given GUID.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "guid", + "in": "path", + "description": "The globally unique identifier of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" + } + } + } + }, + "/types/termtemplatedef/name/{name}": { + "get": { + "operationId": "Type_GetTermTemplateDefByName", + "description": "Get the term template definition by its name (unique).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "name", + "in": "path", + "description": "The unique name of the term template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/AtlasErrorResponse" + } + } + }, + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" + } + } + } + } + }, + "definitions": { + "AtlasAttributeDef": { + "type": "object", + "description": "class that captures details of a struct-attribute.", + "properties": { + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] + }, "defaultValue": { "type": "string", "description": "The default value of the attribute." @@ -4067,30 +4815,19 @@ "format": "int32", "description": "The minimum count of the values." } - }, - "title": "AtlasAttributeDef", - "description": "class that captures details of a struct-attribute." - }, - "AtlasBaseModelObject": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "description": "The GUID of the object." - } - }, - "title": "AtlasBaseModelObject", - "description": "The base model object." + } }, - "AtlasBaseTypeDef": { + "AtlasBusinessMetadataDef": { "type": "object", + "description": "class that captures details of a struct-type.", "properties": { "category": { - "$ref": "#/definitions/TypeCategory" + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4098,7 +4835,8 @@ "description": "The user who created the record." }, "dateFormatter": { - "$ref": "#/definitions/DateFormat" + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "description": { "type": "string", @@ -4120,9 +4858,8 @@ } }, "serviceType": { - "readOnly": false, - "description": "The service type.", - "type": "string" + "type": "string", + "description": "The service type." }, "typeVersion": { "type": "string", @@ -4130,7 +4867,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4138,36 +4875,48 @@ "description": "The user who updated the record." }, "version": { - "type": "number", + "type": "integer", + "format": "int64", "description": "The version of the record." }, "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" - } - }, - "title": "AtlasBaseTypeDef", - "description": "Base class that captures common-attributes for all types." - }, - "AtlasBusinessMetadataDef": { - "type": "object", - "title": "AtlasBusinessMetadataDef", - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] } - ], - "description": "class that captures details of a struct-type." + } }, "AtlasClassification": { "type": "object", - "title": "AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity.", "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, "entityGuid": { "type": "string", "description": "The GUID of the entity." }, "entityStatus": { - "$ref": "#/definitions/Status" + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "removePropagationsOnEntityDelete": { "type": "boolean", @@ -4178,61 +4927,145 @@ "description": "An array of time boundaries indicating validity periods.", "items": { "$ref": "#/definitions/TimeBoundary" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" + }, + "x-ms-identifiers": [] } - ], - "description": "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + } }, "AtlasClassificationDef": { "type": "object", - "title": "AtlasClassificationDef", + "description": "class that captures details of a classification-type.", "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

    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", - "items": { - "type": "string" - } + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." }, - "subTypes": { - "type": "array", - "description": "An array of sub types.", - "items": { - "type": "string" - } + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." }, - "superTypes": { - "type": "array", - "description": "An array of super types.", + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", "items": { "type": "string" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "class that captures details of a classification-type." + } }, "AtlasClassifications": { "type": "object", - "title": "AtlasClassifications", - "allOf": [ - { - "$ref": "#/definitions/PList" + "description": "REST serialization friendly list.", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": {} + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc." + }, + "startIndex": { + "type": "integer", + "format": "int32", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "The total count of items." } - ], - "description": "REST serialization friendly list." + } }, "AtlasConstraintDef": { "type": "object", + "description": "class that captures details of a constraint.", "properties": { "params": { "type": "object", @@ -4243,51 +5076,62 @@ "type": "string", "description": "The type of the constraint." } - }, - "title": "AtlasConstraintDef", - "description": "class that captures details of a constraint." + } }, "AtlasEntitiesWithExtInfo": { "type": "object", - "title": "AtlasEntitiesWithExtInfo", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, "entities": { "type": "array", "description": "An array of entities.", "items": { "$ref": "#/definitions/AtlasEntity" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasEntityExtInfo" + }, + "x-ms-identifiers": [] } - ], - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, "AtlasEntity": { "type": "object", - "title": "AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database.", "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, "businessAttributes": { - "readOnly": false, - "description": "Business Attributes", "type": "object", - "additionalProperties": { - "type": "object" - } + "description": "Business attributes", + "additionalProperties": {} }, "classifications": { "type": "array", "description": "An array of classifications.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4295,9 +5139,8 @@ "description": "The user who created the record." }, "customAttributes": { - "readOnly": false, - "description": "Custom Attribute", "type": "object", + "description": "Custom Attribute", "additionalProperties": { "type": "string" } @@ -4311,19 +5154,17 @@ "description": "The home ID of the entity." }, "collectionId": { - "readOnly": true, "type": "string", - "description": "The collection ID of the entity." + "description": "The collection ID of the entity.", + "readOnly": true }, "isIncomplete": { - "readOnly": false, - "description": "Whether it is a shell entity", - "type": "boolean" + "type": "boolean", + "description": "Whether it is a shell entity" }, "labels": { - "readOnly": false, - "description": "labels", "type": "array", + "description": "labels", "items": { "type": "string" } @@ -4333,12 +5174,13 @@ "description": "An array of term assignment headers indicating the meanings of the entity.", "items": { "$ref": "#/definitions/AtlasTermAssignmentHeader" - } + }, + "x-ms-identifiers": [] }, "provenanceType": { - "readOnly": false, - "description": "Used to record the provenance of an instance of an entity or relationship.", - "type": "number" + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship." }, "proxy": { "type": "boolean", @@ -4350,11 +5192,12 @@ "additionalProperties": {} }, "status": { - "$ref": "#/definitions/Status" + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4362,41 +5205,96 @@ "description": "The user who updated the record." }, "version": { - "type": "number", + "type": "integer", + "format": "int64", "description": "The version of the entity." }, "contacts": { "type": "object", "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", "additionalProperties": { - "type": "array", "items": { - "$ref": "#/definitions/ContactBasic" - } + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "An instance of an entity - like hive_table, hive_database." - }, - "TermTemplateDef": { - "type": "object", - "title": "TermTemplateDef", - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "term template definition for glossary term." + } }, "AtlasEntityDef": { "type": "object", - "title": "AtlasEntityDef", + "description": "class that captures details of a entity-type.", "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, "subTypes": { "type": "array", "description": "An array of sub types.", @@ -4416,34 +5314,28 @@ "description": "An array of relationship attributes.", "items": { "$ref": "#/definitions/AtlasRelationshipAttributeDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "class that captures details of a entity-type." - }, - "AtlasEntityExtInfo": { - "type": "object", - "properties": { - "referredEntities": { - "type": "object", - "description": "The referred entities.", - "additionalProperties": { - "$ref": "#/definitions/AtlasEntity" - } + }, + "x-ms-identifiers": [] } - }, - "title": "AtlasEntityExtInfo", - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, "AtlasEntityHeader": { "type": "object", - "title": "AtlasEntityHeader", + "description": "An instance of an entity - like hive_table, hive_database.", "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, "classificationNames": { "type": "array", "description": "An array of classification names.", @@ -4456,7 +5348,8 @@ "description": "An array of classifications.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] }, "displayText": { "type": "string", @@ -4467,14 +5360,12 @@ "description": "The GUID of the record." }, "isIncomplete": { - "readOnly": false, - "description": "Whether it is a shell entity", - "type": "boolean" + "type": "boolean", + "description": "Whether it is a shell entity" }, "labels": { - "readOnly": false, - "description": "labels", "type": "array", + "description": "labels", "items": { "type": "string" } @@ -4491,53 +5382,111 @@ "description": "An array of term assignment headers.", "items": { "$ref": "#/definitions/AtlasTermAssignmentHeader" - } + }, + "x-ms-identifiers": [] }, "status": { - "$ref": "#/definitions/Status" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." } - ], - "description": "An instance of an entity - like hive_table, hive_database." + } }, "AtlasEntityHeaders": { "type": "object", - "title": "AtlasEntityHeaders", + "description": "An instance of an entity header map.", "properties": { "guidHeaderMap": { - "readOnly": false, - "description": "The description of the guid header map,", "type": "object", + "description": "The description of the guid header map,", "additionalProperties": { "$ref": "#/definitions/AtlasEntityHeader" } } - }, - "description": "An instance of an entity header map." + } }, "AtlasEntityWithExtInfo": { "type": "object", - "title": "AtlasEntityWithExtInfo", + "description": "An instance of an entity along with extended info - like hive_table,\nhive_database.", "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + }, "entity": { - "$ref": "#/definitions/AtlasEntity" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasEntityExtInfo" + "$ref": "#/definitions/AtlasEntity", + "description": "An instance of an entity - like hive_table, hive_database." } - ], - "description": "An instance of an entity along with extended info - like hive_table, hive_database." + } }, "AtlasEnumDef": { "type": "object", - "title": "AtlasEnumDef", + "description": "class that captures details of an enum-type.", "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, "defaultValue": { "type": "string", "description": "The default value." @@ -4547,45 +5496,109 @@ "description": "An array of enum element definitions.", "items": { "$ref": "#/definitions/AtlasEnumElementDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" + }, + "x-ms-identifiers": [] } - ], - "description": "class that captures details of an enum-type." + } }, "AtlasEnumElementDef": { "type": "object", + "description": "class that captures details of an enum-element.", "properties": { "description": { "type": "string", "description": "The description of the enum element definition." }, "ordinal": { - "type": "number", + "type": "integer", + "format": "int32", "description": "The ordinal of the enum element definition." }, "value": { "type": "string", "description": "The value of the enum element definition." } - }, - "title": "AtlasEnumElementDef", - "description": "class that captures details of an enum-element." + } + }, + "AtlasErrorResponse": { + "type": "object", + "description": "An error response from the service", + "properties": { + "requestId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The request ID." + }, + "errorCode": { + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } }, "AtlasGlossary": { "type": "object", - "title": "AtlasGlossary", + "description": "The glossary object.", "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, "categories": { "type": "array", "description": "An array of categories.", "items": { "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + }, + "x-ms-identifiers": [] }, "language": { "type": "string", @@ -4596,30 +5609,30 @@ "description": "An array of related term headers.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "usage": { "type": "string", "description": "The usage of the glossary." } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary object." + } }, - "AtlasGlossaryBaseObject": { + "AtlasGlossaryCategory": { "type": "object", - "title": "AtlasGlossaryBaseObject", + "description": "The glossary category.", "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, "classifications": { "type": "array", "description": "An array of classifications.", "items": { "$ref": "#/definitions/AtlasClassification" - } + }, + "x-ms-identifiers": [] }, "longDescription": { "type": "string", @@ -4638,11 +5651,12 @@ "description": "The short version of description." }, "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" + "type": "string", + "description": "ETag for concurrency control." }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4651,57 +5665,117 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { "type": "string", "description": "The user who updated the record." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseModelObject" - } - ], - "description": "The glossary base object." - }, - "AtlasGlossaryCategory": { - "type": "object", - "title": "AtlasGlossaryCategory", - "properties": { + }, "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader" + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." }, "childrenCategories": { "type": "array", "description": "An array of children categories.", "items": { "$ref": "#/definitions/AtlasRelatedCategoryHeader" - } + }, + "x-ms-identifiers": [] }, "parentCategory": { - "$ref": "#/definitions/AtlasRelatedCategoryHeader" + "$ref": "#/definitions/AtlasRelatedCategoryHeader", + "description": "The header of the related category." }, "terms": { "type": "array", "description": "An array of related term headers.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" + }, + "x-ms-identifiers": [] } - ], - "description": "The glossary category." + } }, "AtlasGlossaryExtInfo": { "type": "object", - "title": "AtlasGlossaryExtInfo", + "description": "The extended information of glossary.", "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "x-ms-identifiers": [] + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + }, "categoryInfo": { "type": "object", "description": "The glossary category information.", @@ -4716,16 +5790,11 @@ "$ref": "#/definitions/AtlasGlossaryTerm" } } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossary" - } - ], - "description": "The extended information of glossary." + } }, "AtlasGlossaryHeader": { "type": "object", + "description": "The glossary header with basic information.", "properties": { "displayText": { "type": "string", @@ -4739,36 +5808,86 @@ "type": "string", "description": "The GUID of the relationship." } - }, - "title": "AtlasGlossaryHeader", - "description": "The glossary header with basic information." + } }, "AtlasGlossaryTerm": { "type": "object", - "title": "AtlasGlossaryTerm", + "description": "The glossary term.", "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + }, + "x-ms-identifiers": [] + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, "abbreviation": { "type": "string", "description": "The abbreviation of the term." }, "templateName": { "type": "array", - "items": { - "type": "object" - } + "description": "The name of the template.", + "items": {} }, "anchor": { - "$ref": "#/definitions/AtlasGlossaryHeader" + "$ref": "#/definitions/AtlasGlossaryHeader", + "description": "The glossary header with basic information." }, "antonyms": { "type": "array", "description": "An array of related term headers as antonyms.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "status": { - "$ref": "#/definitions/TermStatus" + "$ref": "#/definitions/TermStatus", + "description": "Status of the AtlasGlossaryTerm" }, "nickName": { "type": "string", @@ -4779,48 +5898,58 @@ "description": "The hierarchy information of the term.", "items": { "$ref": "#/definitions/PurviewObjectId" - } + }, + "x-ms-identifiers": [] }, "resources": { "type": "array", "description": "An array of resource link for term", "items": { "$ref": "#/definitions/ResourceLink" - } + }, + "x-ms-identifiers": [] }, "contacts": { "type": "object", "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", "additionalProperties": { - "type": "array", "items": { - "$ref": "#/definitions/ContactBasic" - } + "$ref": "#/definitions/ContactInfo" + }, + "type": "array" } }, "attributes": { - "$ref": "#/definitions/TermCustomAttributes" + "type": "object", + "description": "The custom attributes of the term, which is map>.\nThe\nkey of the first layer map is term template name.", + "additionalProperties": { + "additionalProperties": {}, + "type": "object" + } }, "assignedEntities": { "type": "array", "description": "An array of related object IDs.", "items": { "$ref": "#/definitions/AtlasRelatedObjectId" - } + }, + "x-ms-identifiers": [] }, "categories": { "type": "array", "description": "An array of term categorization headers.", "items": { "$ref": "#/definitions/AtlasTermCategorizationHeader" - } + }, + "x-ms-identifiers": [] }, "classifies": { "type": "array", "description": "An array of related term headers.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "examples": { "type": "array", @@ -4834,63 +5963,72 @@ "description": "An array of related term headers indicating the is-a relationship.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "preferredTerms": { "type": "array", "description": "An array of preferred related term headers.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "preferredToTerms": { "type": "array", "description": "An array of related term headers that are preferred to.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "replacedBy": { "type": "array", "description": "An array of related term headers that are replaced by.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "replacementTerms": { "type": "array", "description": "An array of related term headers for replacement.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "seeAlso": { "type": "array", "description": "An array of related term headers for see also.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "synonyms": { "type": "array", "description": "An array of related term headers as synonyms.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "translatedTerms": { "type": "array", "description": "An array of translated related term headers.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "translationTerms": { "type": "array", "description": "An array of related term headers for translation.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "usage": { "type": "string", @@ -4901,83 +6039,22 @@ "description": "An array of related term headers as valid values.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } + }, + "x-ms-identifiers": [] }, "validValuesFor": { "type": "array", "description": "An array of related term headers as valid values for other records.", "items": { "$ref": "#/definitions/AtlasRelatedTermHeader" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasGlossaryBaseObject" - } - ], - "description": "The glossary term." - }, - "ResourceLink": { - "title": "ResourceLink", - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Display name for url." - }, - "url": { - "type": "string", - "description": "web url. http or https" - } - } - }, - "ContactBasic": { - "title": "ContactBasic", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Azure Active Directory object Id." - }, - "info": { - "type": "string", - "description": "additional information to describe this contact." + }, + "x-ms-identifiers": [] } } }, - "TermStatus": { - "type": "string", - "title": "Status", - "description": "Status of the AtlasGlossaryTerm", - "enum": [ - "Draft", - "Approved", - "Alert", - "Expired" - ], - "x-ms-enum": { - "name": "TermStatus", - "modelAsString": true - } - }, - "TermCustomAttributes": { - "title": "attributes", - "description": "The custom attributes of the term, which is map>.\nThe key of the first layer map is term template name.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/TermCustomAttributesExtraProperties" - } - }, - "TermCustomAttributesExtraProperties": { - "type": "object", - "description": "The term attribute name and attribute value, which is map", - "additionalProperties": { - "description": "The value of custom term attribute" - } - }, "AtlasLineageInfo": { "type": "object", + "description": "The lineage information.", "properties": { "baseEntityGuid": { "type": "string", @@ -4994,7 +6071,8 @@ "type": "object", "description": "The entity count in specific direction.", "additionalProperties": { - "$ref": "#/definitions/AtlasLineageInfoExtraProperties" + "additionalProperties": {}, + "type": "object" } }, "lineageDepth": { @@ -5013,35 +6091,30 @@ "description": "The number of children node." }, "lineageDirection": { - "$ref": "#/definitions/LineageDirection" + "$ref": "#/definitions/LineageDirection", + "description": "The enum of lineage direction." }, "parentRelations": { "type": "array", "description": "An array of parentRelations relations.", "items": { "$ref": "#/definitions/ParentRelation" - } + }, + "x-ms-identifiers": [] }, "relations": { "type": "array", "description": "An array of lineage relations.", "items": { "$ref": "#/definitions/LineageRelation" - } + }, + "x-ms-identifiers": [] } - }, - "title": "AtlasLineageInfo", - "description": "The lineage information." - }, - "AtlasLineageInfoExtraProperties": { - "type": "object", - "description": "The lineage direction", - "additionalProperties": { - "description": "The entity guid." } }, "AtlasObjectId": { "type": "object", + "description": "Reference to an object-instance of a type - like entity.", "properties": { "guid": { "type": "string", @@ -5056,39 +6129,11 @@ "description": "The unique attributes of the object.", "additionalProperties": {} } - }, - "title": "AtlasObjectId", - "description": "Reference to an object-instance of a type - like entity." - }, - "PurviewObjectId": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "displayText": { - "type": "string" - }, - "itemPath": { - "type": "string" - }, - "resourceId": { - "type": "string" - }, - "properties": { - "type": "object", - "additionalProperties": {} - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasObjectId" - } - ], - "title": "PurviewObjectId" + } }, "AtlasRelatedCategoryHeader": { "type": "object", + "description": "The header of the related category.", "properties": { "categoryGuid": { "type": "string", @@ -5110,44 +6155,54 @@ "type": "string", "description": "The GUID of the relationship." } - }, - "title": "AtlasRelatedCategoryHeader", - "description": "The header of the related category." + } }, "AtlasRelatedObjectId": { "type": "object", - "title": "AtlasRelatedObjectId", + "description": "Reference to an object-instance of AtlasEntity type used in relationship\nattribute values", "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, "displayText": { "type": "string", "description": "The display text." }, "entityStatus": { - "$ref": "#/definitions/Status" + "$ref": "#/definitions/EntityStatus", + "description": "Status of the entity - can be active or deleted. Deleted entities are not\nremoved." }, "relationshipType": { - "type": "string" + "type": "string", + "description": "Relationship type" }, "relationshipAttributes": { - "$ref": "#/definitions/AtlasStruct" + "$ref": "#/definitions/AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification." }, "relationshipGuid": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "The GUID of the relationship." }, "relationshipStatus": { - "$ref": "#/definitions/Status_AtlasRelationship" - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasObjectId" + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." } - ], - "description": "Reference to an object-instance of AtlasEntity type used in relationship attribute values" + } }, "AtlasRelatedTermHeader": { "type": "object", + "description": "The header of the related term.", "properties": { "description": { "type": "string", @@ -5166,7 +6221,8 @@ "description": "The GUID of the relationship." }, "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus" + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." }, "steward": { "type": "string", @@ -5176,17 +6232,28 @@ "type": "string", "description": "The GUID of the term." } - }, - "title": "AtlasRelatedTermHeader", - "description": "The header of the related term." + } }, "AtlasRelationship": { "type": "object", - "title": "AtlasRelationship", + "description": "Atlas relationship instance.", "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5194,10 +6261,12 @@ "description": "The user who created the record." }, "end1": { - "$ref": "#/definitions/AtlasObjectId" + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." }, "end2": { - "$ref": "#/definitions/AtlasObjectId" + "$ref": "#/definitions/AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." }, "guid": { "type": "string", @@ -5212,16 +6281,17 @@ "description": "The label of the relationship." }, "provenanceType": { - "readOnly": false, - "description": "Used to record the provenance of an instance of an entity or relationship", - "type": "number" + "type": "integer", + "format": "int32", + "description": "Used to record the provenance of an instance of an entity or relationship" }, "status": { - "$ref": "#/definitions/Status_AtlasRelationship" + "$ref": "#/definitions/StatusAtlasRelationship", + "description": "The enum of relationship status." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5229,94 +6299,212 @@ "description": "The user who updated the record." }, "version": { - "type": "number", + "type": "integer", + "format": "int64", "description": "The version of the relationship." } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStruct" - } - ], - "description": "Atlas relationship instance." + } }, - "AtlasRelationshipDef": { + "AtlasRelationshipAttributeDef": { "type": "object", - "title": "AtlasRelationshipDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { - "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef" - }, - "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." }, - "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory" + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + }, + "x-ms-identifiers": [] }, - "relationshipLabel": { + "defaultValue": { "type": "string", - "description": "The label of the relationship." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasStructDef" - } - ], - "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

\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": "The default value of the attribute." }, "description": { "type": "string", - "description": "The description of the relationship end definition." + "description": "The description of the attribute." }, - "isContainer": { + "includeInNotification": { "type": "boolean", - "description": "Determines if it is container." + "description": "Determines if it is included in notification." }, - "isLegacyAttribute": { + "isIndexable": { "type": "boolean", - "description": "Determines if it is a legacy attribute." + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." }, "name": { "type": "string", - "description": "The name of the relationship end definition." + "description": "The name of the attribute." }, - "type": { + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { "type": "string", - "description": "The type of the relationship end." + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." } - }, - "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": { + "AtlasRelationshipDef": { + "type": "object", + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\nAs with other typeDefs the AtlasRelationshipDef has a name. Once created the\nRelationshipDef has a guid.\nThe name and the guid are the 2 ways that the\nRelationshipDef is identified.\nRelationshipDefs have 2 ends, each of which\nspecify cardinality, an EntityDef type name and name and optionally\nwhether the\nend is a container.\nRelationshipDefs can have AttributeDefs - though only\nprimitive types are allowed. \nRelationshipDefs have a relationshipCategory\nspecifying the UML type of relationship required \nThe way EntityDefs and\nRelationshipDefs are intended to be used is that EntityDefs will define\nAttributeDefs these AttributeDefs\nwill not specify an EntityDef type name as\ntheir types.\nRelationshipDefs introduce new attributes to the entity\ninstances. For example\nEntityDef A might have attributes attr1,attr2,attr3\n\nEntityDef B might have attributes attr4,attr5,attr6 \nRelationshipDef\nAtoB might define 2 ends \n\nend1: type A, name attr7\nend2: type B, name attr8 \n\nWhen an instance of EntityDef A is created, it\nwill have attributes attr1,attr2,attr3,attr7 \nWhen an instance of EntityDef\nB is created, it will have attributes attr4,attr5,attr6,attr8\n\nIn this way\nrelationshipDefs can be authored separately from entityDefs and can inject\nrelationship attributes into\nthe entity instances", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\nASSOCIATION is a relationship with no containment. \nCOMPOSITION and AGGREGATION are containment relationships.\nThe difference being in the lifecycles of the container and its children. \nIn the COMPOSITION case, the children cannot exist without the container.\nFor AGGREGATION, the life cycles of the container and children are totally independent." + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + } + } + }, + "AtlasRelationshipEndDef": { "type": "object", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship.", "properties": { + "cardinality": { + "$ref": "#/definitions/CardinalityValue", + "description": "single-valued attribute or multi-valued attribute." + }, + "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." }, - "relationshipTypeName": { + "name": { "type": "string", - "description": "The name of the relationship type." - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasAttributeDef" + "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." + } }, "AtlasRelationshipWithExtInfo": { "type": "object", + "description": "The relationship with extended information.", "properties": { "referredEntities": { "type": "object", @@ -5326,14 +6514,14 @@ } }, "relationship": { - "$ref": "#/definitions/AtlasRelationship" + "$ref": "#/definitions/AtlasRelationship", + "description": "Atlas relationship instance." } - }, - "title": "AtlasRelationshipWithExtInfo", - "description": "The relationship with extended information." + } }, "AtlasStruct": { "type": "object", + "description": "Captures details of struct contents. Not instantiated directly, used only via\nAtlasEntity, AtlasClassification.", "properties": { "attributes": { "type": "object", @@ -5345,33 +6533,90 @@ "description": "The name of the type." }, "lastModifiedTS": { - "$ref": "#/definitions/LastModifiedTS" + "type": "string", + "description": "ETag for concurrency control." } - }, - "title": "AtlasStruct", - "description": "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + } }, "AtlasStructDef": { "type": "object", - "title": "AtlasStructDef", + "description": "class that captures details of a struct-type.", "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, "attributeDefs": { "type": "array", "description": "An array of attribute definitions.", "items": { "$ref": "#/definitions/AtlasAttributeDef" - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" + }, + "x-ms-identifiers": [] } - ], - "description": "class that captures details of a struct-type." + } }, "AtlasTermAssignmentHeader": { "type": "object", + "description": "The header for term assignment.", "properties": { "confidence": { "type": "integer", @@ -5395,28 +6640,26 @@ "description": "The expression of the term assignment." }, "relationGuid": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "The GUID of the relationship." }, "status": { - "$ref": "#/definitions/AtlasTermAssignmentStatus" + "$ref": "#/definitions/AtlasTermAssignmentStatus", + "description": "The status of terms assignment." }, "steward": { "type": "string", "description": "The steward of the term." }, "termGuid": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "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.", + "description": "Status for term assignment", "enum": [ "DISCOVERED", "PROPOSED", @@ -5428,14 +6671,52 @@ ], "x-ms-enum": { "name": "AtlasTermAssignmentStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Discovered", + "value": "DISCOVERED", + "description": "The status is discovered." + }, + { + "name": "Proposed", + "value": "PROPOSED", + "description": "The status is proposed." + }, + { + "name": "Imported", + "value": "IMPORTED", + "description": "The status is imported." + }, + { + "name": "Validated", + "value": "VALIDATED", + "description": "The status is validated." + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "The status is deprecated." + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "The status is obsolete." + }, + { + "name": "Other", + "value": "OTHER", + "description": "Other status." + } + ] } }, "AtlasTermCategorizationHeader": { "type": "object", + "description": "The basic information for term categorization.", "properties": { "categoryGuid": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "The GUID of the category." }, "description": { @@ -5447,20 +6728,18 @@ "description": "The display text." }, "relationGuid": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "The GUID of the relationship." }, "status": { - "$ref": "#/definitions/AtlasTermRelationshipStatus" + "$ref": "#/definitions/AtlasTermRelationshipStatus", + "description": "The status of term relationship." } - }, - "title": "AtlasTermCategorizationHeader", - "description": "The basic information for term categorization." + } }, "AtlasTermRelationshipStatus": { "type": "string", - "title": "AtlasTermRelationshipStatus", - "description": "The status of term relationship.", + "description": "Status for atlas term relationship", "enum": [ "DRAFT", "ACTIVE", @@ -5470,14 +6749,60 @@ ], "x-ms-enum": { "name": "AtlasTermRelationshipStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "DRAFT", + "description": "draft" + }, + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deprecated", + "value": "DEPRECATED", + "description": "deprecated" + }, + { + "name": "Obsolete", + "value": "OBSOLETE", + "description": "obsolete" + }, + { + "name": "Other", + "value": "OTHER", + "description": "other" + } + ] } }, - "AtlasTypeDefHeader": { + "AtlasTypeDef": { "type": "object", + "description": "The definitions of type.", "properties": { "category": { - "$ref": "#/definitions/TypeCategory" + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { + "type": "string", + "description": "The description of the type definition." }, "guid": { "type": "string", @@ -5486,74 +6811,43 @@ "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" + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" } }, - "entityDefs": { - "type": "array", - "description": "An array of entity definitions.", - "items": { - "$ref": "#/definitions/AtlasEntityDef" - } + "serviceType": { + "type": "string", + "description": "The service type." }, - "enumDefs": { - "type": "array", - "description": "An array of enum definitions.", - "items": { - "$ref": "#/definitions/AtlasEnumDef" - } + "typeVersion": { + "type": "string", + "description": "The version of the type." }, - "relationshipDefs": { - "type": "array", - "description": "An array of relationship definitions.", - "items": { - "$ref": "#/definitions/AtlasRelationshipDef" - } + "updateTime": { + "type": "integer", + "format": "unixtime", + "description": "The update time of the record." }, - "structDefs": { - "type": "array", - "description": "An array of struct definitions.", - "items": { - "$ref": "#/definitions/AtlasStructDef" - } + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." }, - "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

    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", + "description": "Specifying a list of entityType names in the classificationDef, ensures that\nclassifications can\nonly be applied to those entityTypes.\n\nAny subtypes of the entity types inherit the restriction.\n\nAny classificationDef subtypes inherit the parents entityTypes restrictions.\n\nAny classificationDef subtypes can further restrict the parents entityTypes\nrestrictions by specifying a subset of the entityTypes.\n\nAn empty entityTypes list when there are no parent restrictions means there are no\nrestrictions.\n\nAn empty entityTypes list when there are parent\nrestrictions means that the subtype picks up the parents\nrestrictions.\n\nIf a list of entityTypes are supplied, where one inherits\nfrom another, this will be rejected. This should encourage cleaner\nclassificationsDefs.\n", "items": { "type": "string" } @@ -5577,7 +6871,8 @@ "description": "An array of relationship attributes.", "items": { "$ref": "#/definitions/AtlasRelationshipAttributeDef" - } + }, + "x-ms-identifiers": [] }, "defaultValue": { "type": "string", @@ -5588,16 +6883,20 @@ "description": "An array of enum element definitions.", "items": { "$ref": "#/definitions/AtlasEnumElementDef" - } + }, + "x-ms-identifiers": [] }, "endDef1": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." }, "endDef2": { - "$ref": "#/definitions/AtlasRelationshipEndDef" + "$ref": "#/definitions/AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the\nrelationship is defined by a type, an\nattribute name, cardinality and whether\nit is the container end of the relationship." }, "relationshipCategory": { - "$ref": "#/definitions/RelationshipCategory" + "$ref": "#/definitions/RelationshipCategory", + "description": "The Relationship category determines the style of relationship around\ncontainment and lifecycle.\nUML terminology is used for the values.\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. \nIn the COMPOSITION case, the children cannot exist without the container. \nFor AGGREGATION, the life cycles of the container and children are totally independent." }, "relationshipLabel": { "type": "string", @@ -5608,143 +6907,201 @@ "description": "An array of attribute definitions.", "items": { "$ref": "#/definitions/AtlasAttributeDef" - } + }, + "x-ms-identifiers": [] } - }, - "title": "AtlasExtraTypeDef", - "description": "Extra properties for a type." + } }, - "AtlasTypeDef": { + "AtlasTypeDefHeader": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseTypeDef" + "description": "The basic information of the type definition.", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." }, - { - "$ref": "#/definitions/AtlasExtraTypeDef" + "name": { + "type": "string", + "description": "The name of the type definition." } - ], - "title": "AtlasTypeDef", - "description": "The definitions of type." + } }, - "ImportInfo": { + "AtlasTypesDef": { "type": "object", - "title": "ImportInfo", + "description": "The definitions of types.", "properties": { - "childObjectName": { - "readOnly": false, - "description": "childObjectName", - "type": "string" + "businessMetadataDefs": { + "type": "array", + "description": "businessMetadataDefs", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + }, + "x-ms-identifiers": [] }, - "importStatus": { - "readOnly": false, - "$ref": "#/definitions/ImportStatus", - "description": "importStatus" + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + }, + "x-ms-identifiers": [] }, - "parentObjectName": { - "readOnly": false, - "description": "parentObjectName", - "type": "string" + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + }, + "x-ms-identifiers": [] }, - "remarks": { - "readOnly": false, - "description": "remarks", - "type": "string" + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + }, + "x-ms-identifiers": [] + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + }, + "x-ms-identifiers": [] + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + }, + "x-ms-identifiers": [] + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + }, + "x-ms-identifiers": [] } - }, - "example": { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - }, - "description": "ImportInfo" + } }, - "ImportStatus": { - "type": "string", - "title": "ImportStatus", - "enum": [ - "SUCCESS", - "FAILED" - ], - "description": "ImportStatus", - "x-ms-enum": { - "name": "importStatus", - "modelAsString": true + "AutoCompleteOptions": { + "type": "object", + "description": "The query of autocomplete request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must\nbe 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.\nThe value must be a number between 1 and 100." + }, + "filter": { + "description": "The filter for the autocomplete request." + } + } + }, + "AutoCompleteResult": { + "type": "object", + "description": "The result of the autocomplete request.", + "properties": { + "value": { + "type": "array", + "description": "The result value", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + }, + "x-ms-identifiers": [] + } + } + }, + "AutoCompleteResultValue": { + "type": "object", + "description": "The value item of the autocomplete suggest.", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } } }, - "BulkImportResponse": { + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BulkImportResult": { "type": "object", - "title": "BulkImportResponse", + "description": "Bulk import result", "properties": { "failedImportInfoList": { - "readOnly": false, - "description": "failed importInfoList", "type": "array", + "description": "failed importInfoList", "items": { "$ref": "#/definitions/ImportInfo" - } + }, + "x-ms-identifiers": [] }, "successImportInfoList": { - "readOnly": false, - "description": "successful importInfoList", "type": "array", + "description": "successful importInfoList", "items": { "$ref": "#/definitions/ImportInfo" - } - } - }, - "example": { - "failedImportInfoList": [ - { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - }, - { - "childObjectName": "...", - "importStatus": "SUCCESS", - "parentObjectName": "...", - "remarks": "..." - } - ], - "successImportInfoList": [ - { - "childObjectName": "...", - "importStatus": "FAILED", - "parentObjectName": "...", - "remarks": "..." }, - { - "childObjectName": "...", - "importStatus": "FAILED", - "parentObjectName": "...", - "remarks": "..." - } - ] - }, - "description": "example" + "x-ms-identifiers": [] + } + } }, - "Cardinality": { + "CardinalityValue": { "type": "string", - "title": "Cardinality", - "description": "single-valued attribute or multi-valued attribute.", + "description": "Cardinality", "enum": [ "SINGLE", "LIST", "SET" ], "x-ms-enum": { - "name": "Cardinality", - "modelAsString": true + "name": "CardinalityValue", + "modelAsString": true, + "values": [ + { + "name": "Single", + "value": "SINGLE", + "description": "single" + }, + { + "name": "List", + "value": "LIST", + "description": "list" + }, + { + "name": "Set", + "value": "SET", + "description": "set" + } + ] } }, - "ClassificationAssociateRequest": { + "ClassificationAssociateOptions": { "type": "object", + "description": "The request content for classification association.", "properties": { "classification": { - "$ref": "#/definitions/AtlasClassification" + "$ref": "#/definitions/AtlasClassification", + "description": "An instance of a classification; it doesn't have an identity, this object\nexists only when associated with an entity." }, "entityGuids": { "type": "array", @@ -5753,25 +7110,43 @@ "type": "string" } } - }, - "title": "ClassificationAssociateRequest", - "description": "The request for classification association." + } }, - "MoveEntitiesRequest": { + "ContactInfo": { "type": "object", + "description": "ContactInfo", "properties": { - "entityGuids": { - "type": "array", - "description": "An array of entity guids to be moved to target collection.", - "items": { - "type": "string" - } + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, + "ContactSearchResultValue": { + "type": "object", + "description": "The contact in the search and suggest result.", + "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\nExpert or Steward for a glossary term." } } }, "DateFormat": { "type": "object", - "title": "DateFormat", + "description": "The date format.", "properties": { "availableLocales": { "type": "array", @@ -5781,35 +7156,43 @@ } }, "calendar": { - "type": "number" + "type": "number", + "format": "float", + "description": "Calendar" }, "dateInstance": { - "$ref": "#/definitions/DateFormat" + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "dateTimeInstance": { - "$ref": "#/definitions/DateFormat" + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "instance": { - "$ref": "#/definitions/DateFormat" + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "lenient": { "type": "boolean", "description": "Determines the leniency of the date format." }, "numberFormat": { - "$ref": "#/definitions/NumberFormat" + "$ref": "#/definitions/NumberFormat", + "description": "The number format." }, "timeInstance": { - "$ref": "#/definitions/DateFormat" + "$ref": "#/definitions/DateFormat", + "description": "The date format." }, "timeZone": { - "$ref": "#/definitions/TimeZone" + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." } - }, - "description": "The date format." + } }, - "EntityMutationResponse": { + "EntityMutationResult": { "type": "object", + "description": "The mutation response result of entity.", "properties": { "guidAssignments": { "type": "object", @@ -5822,10 +7205,11 @@ "type": "object", "description": "The entity headers of mutated entities.", "additionalProperties": { - "type": "array", "items": { "$ref": "#/definitions/AtlasEntityHeader" - } + }, + "type": "array", + "x-ms-identifiers": [] } }, "partialUpdatedEntities": { @@ -5833,16 +7217,84 @@ "description": "An array of entity headers that partially updated.", "items": { "$ref": "#/definitions/AtlasEntityHeader" + }, + "x-ms-identifiers": [] + } + } + }, + "EntityStatus": { + "type": "string", + "description": "Status - can be active or deleted", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "The status is active." + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "The status is deleted." } + ] + } + }, + "ImportInfo": { + "type": "object", + "description": "ImportInfo", + "properties": { + "childObjectName": { + "type": "string", + "description": "childObjectName" + }, + "importStatus": { + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "type": "string", + "description": "parentObjectName" + }, + "remarks": { + "type": "string", + "description": "remarks" } - }, - "title": "EntityMutationResponse", - "description": "The mutation response of entity." + } + }, + "ImportStatus": { + "type": "string", + "description": "Status for import", + "enum": [ + "SUCCESS", + "FAILED" + ], + "x-ms-enum": { + "name": "ImportStatus", + "modelAsString": true, + "values": [ + { + "name": "Success", + "value": "SUCCESS", + "description": "Success" + }, + { + "name": "Failed", + "value": "FAILED", + "description": "Failed" + } + ] + } }, "LineageDirection": { "type": "string", - "title": "LineageDirection", - "description": "The enum of lineage direction.", + "description": "Lineage direction", "enum": [ "INPUT", "OUTPUT", @@ -5850,11 +7302,29 @@ ], "x-ms-enum": { "name": "LineageDirection", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Input", + "value": "INPUT", + "description": "input" + }, + { + "name": "Output", + "value": "OUTPUT", + "description": "output" + }, + { + "name": "Both", + "value": "BOTH", + "description": "both" + } + ] } }, "LineageRelation": { "type": "object", + "description": "The lineage relation with GUID of the from and to entity.", "properties": { "fromEntityId": { "type": "string", @@ -5868,32 +7338,24 @@ "type": "string", "description": "The GUID of to-entity." } - }, - "title": "LineageRelation", - "description": "The lineage relation with GUID of the from and to entity." + } }, - "ParentRelation": { + "MoveEntitiesOptions": { "type": "object", + "description": "MoveEntitiesContent", "properties": { - "childEntityId": { - "type": "string", - "description": "The GUID of child entity." - }, - "relationshipId": { - "type": "string", - "description": "The GUID of relationship." - }, - "parentEntityId": { - "type": "string", - "description": "The GUID of parent entity." + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } } - }, - "title": "ParentRelation", - "description": "The lineage parents relation with GUID of the parent entity and to child entity." + } }, "NumberFormat": { "type": "object", - "title": "NumberFormat", + "description": "The number format.", "properties": { "availableLocales": { "type": "array", @@ -5907,17 +7369,20 @@ "description": "The currency." }, "currencyInstance": { - "$ref": "#/definitions/NumberFormat" + "$ref": "#/definitions/NumberFormat", + "description": "The number format." }, "groupingUsed": { "type": "boolean", "description": "Determines if grouping is used." }, "instance": { - "$ref": "#/definitions/NumberFormat" + "$ref": "#/definitions/NumberFormat", + "description": "The number format." }, "integerInstance": { - "$ref": "#/definitions/NumberFormat" + "$ref": "#/definitions/NumberFormat", + "description": "The number format." }, "maximumFractionDigits": { "type": "integer", @@ -5940,62 +7405,156 @@ "description": "The minimum of integer digits." }, "numberInstance": { - "$ref": "#/definitions/NumberFormat" + "$ref": "#/definitions/NumberFormat", + "description": "The number format." }, "parseIntegerOnly": { "type": "boolean", "description": "Determines if only integer is parsed." }, "percentInstance": { - "$ref": "#/definitions/NumberFormat" + "$ref": "#/definitions/NumberFormat", + "description": "The number format." }, "roundingMode": { - "$ref": "#/definitions/RoundingMode" + "$ref": "#/definitions/RoundingMode", + "description": "The enum of rounding mode." } - }, - "description": "The number format." + } }, - "PList": { + "ParentRelation": { "type": "object", + "description": "The lineage parents relation with GUID of the parent entity and to child entity.", "properties": { - "list": { - "type": "array", - "description": "An array of objects.", - "items": { - "type": "object", - "properties": {} - } + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." }, - "pageSize": { + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + } + }, + "PurviewObjectId": { + "type": "object", + "description": "PurviewObjectId", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + }, + "name": { + "type": "string", + "description": "Name" + }, + "displayText": { + "type": "string", + "description": "Display text" + }, + "itemPath": { + "type": "string", + "description": "Item path" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "type": "object", + "description": "Dictionary of ", + "additionalProperties": {} + } + } + }, + "QueryOptions": { + "type": "object", + "description": "The search query of advanced search request.", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all searchable fields." + }, + "limit": { "type": "integer", "format": "int32", - "description": "The size of the page." + "description": "The limit of the number of the search result. default value is 50; maximum\nvalue is 1000." }, - "sortBy": { + "continuationToken": { "type": "string", - "description": "The sorted by field." + "description": "The token used to get next batch of data. Default 'Null' to get the first\nbatch, and will return new token in each response unless there's no more data." }, - "sortType": { - "$ref": "#/definitions/SortType" + "orderby": { + "type": "array", + "description": "The sort order of search results, can specify multiple fields.", + "items": {} }, - "startIndex": { - "type": "integer", - "format": "int64", - "description": "The start index of the page." + "filter": { + "description": "The filter for the search. See examples for the usage of supported filters." }, - "totalCount": { + "facets": { + "type": "array", + "description": "The facets for search. See examples for the usage of supported facets.", + "items": { + "$ref": "#/definitions/SearchFacetItem" + }, + "x-ms-identifiers": [] + }, + "taxonomySetting": { + "$ref": "#/definitions/SearchTaxonomySetting", + "description": "The taxonomy setting for search." + } + } + }, + "QueryResult": { + "type": "object", + "description": "The result of the search result.", + "properties": { + "@search.count": { "type": "integer", - "format": "int64", - "description": "The total count of items." + "format": "int32", + "description": "The total number of search results (not the number of documents in a single\npage).", + "x-ms-client-name": "searchCount" + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa.", + "x-ms-client-name": "searchCountApproximate" + }, + "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", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "x-ms-client-name": "searchFacets" + }, + "value": { + "type": "array", + "description": "Search result value", + "items": { + "$ref": "#/definitions/SearchResultValue" + } } - }, - "title": "PList", - "description": "Paginated-list, for returning search results." + } }, "RelationshipCategory": { "type": "string", - "title": "RelationshipCategory", - "description": "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\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.", + "description": "Relationship Category", "enum": [ "ASSOCIATION", "AGGREGATION", @@ -6003,13 +7562,43 @@ ], "x-ms-enum": { "name": "RelationshipCategory", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Association", + "value": "ASSOCIATION", + "description": "association" + }, + { + "name": "Aggregation", + "value": "AGGREGATION", + "description": "aggregation" + }, + { + "name": "Composition", + "value": "COMPOSITION", + "description": "composition" + } + ] + } + }, + "ResourceLink": { + "type": "object", + "description": "ResourceLink", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } } }, "RoundingMode": { "type": "string", - "title": "RoundingMode", - "description": "The enum of rounding mode.", + "description": "Rounding Mode", "enum": [ "UP", "DOWN", @@ -6022,161 +7611,253 @@ ], "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 + "modelAsString": true, + "values": [ + { + "name": "Up", + "value": "UP", + "description": "up" + }, + { + "name": "Down", + "value": "DOWN", + "description": "down" + }, + { + "name": "Ceiling", + "value": "CEILING", + "description": "ceiling" + }, + { + "name": "Floor", + "value": "FLOOR", + "description": "floor" + }, + { + "name": "HalfUp", + "value": "HALF_UP", + "description": "half up" + }, + { + "name": "HalfDown", + "value": "HALF_DOWN", + "description": "half down" + }, + { + "name": "HalfEven", + "value": "HALF_EVEN", + "description": "half even" + }, + { + "name": "Unnecessary", + "value": "UNNECESSARY", + "description": "unnecessary" + } + ] } }, - "TimeBoundary": { + "SearchFacetItem": { "type": "object", + "description": "The content of a search facet result item.", "properties": { - "endTime": { - "type": "string", - "description": "The end of the time boundary." + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." }, - "startTime": { + "facet": { "type": "string", - "description": "The start of the time boundary." + "description": "The name of the facet item." }, - "timeZone": { - "type": "string", - "description": "The timezone of the time boundary." + "sort": { + "$ref": "#/definitions/SearchFacetSort", + "description": "Define the sorting criteria for items" } - }, - "title": "TimeBoundary", - "description": "Captures time-boundary details" + } }, - "TimeZone": { + "SearchFacetItemValue": { "type": "object", + "description": "The content of a search facet result item.", "properties": { - "dstSavings": { + "count": { "type": "integer", "format": "int32", - "description": "The value of the daylight saving time." + "description": "The count of the facet item." }, - "id": { + "value": { "type": "string", - "description": "The ID of the timezone." + "description": "The name of the facet item." + } + } + }, + "SearchFacetResultValue": { + "type": "object", + "description": "A facet list that consists of index fields assetType ,classification,\ncontactId, and label. When the facet is specified in the request, the value of\nthe facet is returned as an element of @search.facets.", + "properties": { + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] }, - "availableIds": { + "assetType": { "type": "array", - "description": "An array of available IDs.", + "description": "Asset type", "items": { - "type": "string" - } + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] }, - "default": { - "$ref": "#/definitions/TimeZone" + "classification": { + "type": "array", + "description": "Classification", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] }, - "displayName": { - "type": "string", - "description": "The display name of the timezone." + "term": { + "type": "array", + "description": "Term", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] }, - "rawOffset": { - "type": "integer", - "format": "int32", - "description": "The raw offset of the timezone." + "contactId": { + "type": "array", + "description": "Contact id", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "contactType": { + "type": "array", + "description": "Contact type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "label": { + "type": "array", + "description": "Label", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "glossaryType": { + "type": "array", + "description": "Glossary type", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termStatus": { + "type": "array", + "description": "Term status", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] + }, + "termTemplate": { + "type": "array", + "description": "Term template", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + }, + "x-ms-identifiers": [] } - }, - "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": { + "SearchFacetSort": { "type": "object", + "description": "The sorting criteria", "properties": { + "count": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by count" + }, "value": { + "$ref": "#/definitions/SearchSortOrder", + "description": "Order by value" + } + } + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "properties": { + "id": { "type": "array", + "description": "Id", "items": { - "$ref": "#/definitions/SuggestResultValue" + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "description": "Qualified name", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "description": "Name", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "description": "Description", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "description": "Entity type", + "items": { + "type": "string" } } - }, - "title": "SuggestResult", - "description": "The result item of the search suggest." + } }, - "SuggestResultValue": { + "SearchResultValue": { "type": "object", + "description": "The value item of the search result.", "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." + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" }, - "@search.text": { - "type": "string", - "description": "The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark." + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights", + "description": "A highlight list that consists of index fields id ,qualifiedName, name,\ndescription, entityType. When the keyword appears in those fields, the value of\nthe field, attached with emphasis mark, is returned as an element of\n@search.highlights.", + "x-ms-client-name": "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." + "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -6226,7 +7907,8 @@ "description": "The terms assigned to the asset.", "items": { "$ref": "#/definitions/TermSearchResultValue" - } + }, + "x-ms-identifiers": [] }, "contact": { "type": "array", @@ -6244,7 +7926,7 @@ }, "glossaryType": { "type": "string", - "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or\nAtlasGlossaryCategory." }, "glossary": { "type": "string", @@ -6265,168 +7947,161 @@ "type": "string", "description": "The definition of the term." } - }, - "title": "SuggestResultValue", - "description": "The value item of the search suggest." + } + }, + "SearchSortOrder": { + "type": "string", + "description": "Search sort order", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "SearchSortOrder", + "modelAsString": true, + "values": [ + { + "name": "Ascend", + "value": "asc", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "desc", + "description": "Use descending order for sorting" + } + ] + } }, - "SearchResult": { + "SearchTaxonomySetting": { "type": "object", + "description": "Taxonomy setting for search request", "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." + "assetTypes": { + "type": "array", + "description": "Asset types", + "items": { + "type": "string" + } }, - "continuationToken": { + "facet": { + "$ref": "#/definitions/SearchFacetItem", + "description": "The content of a search facet result item." + } + } + }, + "SortType": { + "type": "string", + "description": "Type for sorting", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "NONE", + "description": "No sorting order" + }, + { + "name": "Ascend", + "value": "ASC", + "description": "Use ascending order for sorting" + }, + { + "name": "Descend", + "value": "DESC", + "description": "Use descending order for sorting" + } + ] + } + }, + "StatusAtlasRelationship": { + "type": "string", + "description": "Status for atlas relationship", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "StatusAtlasRelationship", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "ACTIVE", + "description": "active" + }, + { + "name": "Deleted", + "value": "DELETED", + "description": "deleted" + } + ] + } + }, + "SuggestOptions": { + "type": "object", + "description": "The query of suggest request.", + "properties": { + "keywords": { "type": "string", - "description": "The token used to get next batch of data. Absent if there's no more data." + "description": "The keywords applied to all fields that support suggest operation. It must be\nat least 1 character, and no more than 100 characters. In the index schema we\ndefined a default suggester which lists all the supported fields and specifies\na search mode." }, - "@search.facets": { - "$ref": "#/definitions/SearchFacetResultValue" + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value\nmust be a number between 1 and 100." }, + "filter": { + "description": "The filter for the search." + } + } + }, + "SuggestResult": { + "type": "object", + "description": "The result item of the search suggest.", + "properties": { "value": { "type": "array", + "description": "The result value", "items": { - "$ref": "#/definitions/SearchResultValue" + "$ref": "#/definitions/SuggestResultValue" } } - }, - "title": "SearchResult", - "description": "The result of the search result." + } }, - "SearchFacetResultValue": { + "SuggestResultValue": { "type": "object", + "description": "The value item of the search suggest.", "properties": { - "entityType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } - }, - "assetType": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItemValue" - } + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by\nsearch score by default.", + "x-ms-client-name": "searchScore" }, - "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": { + "@search.text": { "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" + "description": "The target text that contains the keyword as prefix. The keyword is wrapped\nwith emphasis mark.", + "x-ms-client-name": "searchText" }, "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." + "description": "The object type of the record. Object type is the top-level property to\ndistinguish whether a record is an asset or a term." }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -6476,7 +8151,8 @@ "description": "The terms assigned to the asset.", "items": { "$ref": "#/definitions/TermSearchResultValue" - } + }, + "x-ms-identifiers": [] }, "contact": { "type": "array", @@ -6494,7 +8170,7 @@ }, "glossaryType": { "type": "string", - "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or\nAtlasGlossaryCategory." }, "glossary": { "type": "string", @@ -6515,49 +8191,11 @@ "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", + "description": "The context.", "properties": { "name": { "type": "string", @@ -6571,680 +8209,256 @@ "type": "string", "description": "The GUID of the term." } - }, - "title": "Context", - "description": "The context." + } }, - "ContactSearchResultValue": { + "TermStatus": { + "type": "string", + "description": "Status for term", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true, + "values": [ + { + "name": "Draft", + "value": "Draft", + "description": "draft" + }, + { + "name": "Approved", + "value": "Approved", + "description": "approved" + }, + { + "name": "Alert", + "value": "Alert", + "description": "alert" + }, + { + "name": "Expired", + "value": "Expired", + "description": "expired" + } + ] + } + }, + "TermTemplateDef": { "type": "object", + "description": "Term template definition for glossary term.", "properties": { - "id": { + "category": { + "$ref": "#/definitions/TypeCategory", + "description": "The enum of type category." + }, + "createTime": { + "type": "integer", + "format": "unixtime", + "description": "The created time of the record." + }, + "createdBy": { "type": "string", - "description": "The GUID of the contact." + "description": "The user who created the record." }, - "info": { + "dateFormatter": { + "$ref": "#/definitions/DateFormat", + "description": "The date format." + }, + "description": { "type": "string", - "description": "The description of the contact." + "description": "The description of the type definition." }, - "contactType": { + "guid": { "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": { + "description": "The GUID of the type definition." + }, + "name": { "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." + "description": "The name of the type definition." }, - "limit": { + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "type": "string", + "description": "The service type." + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { "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." + "format": "unixtime", + "description": "The update time of the record." }, - "filter": { - "type": "object", - "description": "The filter for the autocomplete request." - } - }, - "title": "AutoCompleteRequest", - "description": "The query of autocomplete request." - }, - "AutoCompleteResult": { - "type": "object", - "properties": { - "value": { + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "The version of the record." + }, + "lastModifiedTS": { + "type": "string", + "description": "ETag for concurrency control." + }, + "attributeDefs": { "type": "array", + "description": "An array of attribute definitions.", "items": { - "$ref": "#/definitions/AutoCompleteResultValue" - } + "$ref": "#/definitions/AtlasAttributeDef" + }, + "x-ms-identifiers": [] } - }, - "title": "AutoCompleteResult", - "description": "The result of the autocomplete request." + } }, - "AutoCompleteResultValue": { + "TimeBoundary": { "type": "object", + "description": "Captures time-boundary details", "properties": { - "text": { + "endTime": { "type": "string", - "description": "The completed term or phrase." + "description": "The end of the time boundary." }, - "queryPlusText": { + "startTime": { "type": "string", - "description": "The completed search query text." + "description": "The start of the time boundary." + }, + "timeZone": { + "type": "string", + "description": "The timezone of the time boundary." } - }, - "title": "AutoCompleteResultValue", - "description": "The value item of the autocomplete suggest." + } }, - "SearchRequest": { + "TimeZone": { "type": "object", + "description": "The timezone information.", "properties": { - "keywords": { - "type": "string", - "description": "The keywords applied to all searchable fields." - }, - "limit": { + "dstSavings": { "type": "integer", "format": "int32", - "description": "The limit of the number of the search result. default value is 50; maximum value is 1000." + "description": "The value of the daylight saving time." }, - "continuationToken": { + "id": { "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." + "description": "The ID of the timezone." }, - "orderby": { + "availableIds": { "type": "array", - "description": "The sort order of search results, can specify multiple fields.", + "description": "An array of available IDs.", "items": { - "$ref": "#/definitions/SearchOrderItem" + "type": "string" } }, - "filter": { - "type": "object", - "description": "The filter for the search. See examples for the usage of supported filters." - }, - "facets": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchFacetItem" - } + "default": { + "$ref": "#/definitions/TimeZone", + "description": "The timezone information." }, - "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": { + "displayName": { "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." + "description": "The display name of the timezone." }, - "limit": { + "rawOffset": { "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" + "description": "The raw offset of the timezone." } } }, - "BusinessMetadata": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "BusinessMetadata" - }, - "BusinessMetadataAttributes": { - "type": "object", - "additionalProperties": {}, - "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" - }, - "categoryId": { - "name": "categoryId", - "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" - }, - "termId": { - "name": "termId", - "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" - }, - "glossaryId": { - "name": "glossaryId", - "in": "path", - "description": "The globally unique identifier for glossary.", - "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, + "TypeCategory": { "type": "string", + "description": "Type Category", "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", "ENUM", - "ENTITY", + "STRUCT", "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", "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.", + "name": "TypeCategory", + "modelAsString": true, + "values": [ + { + "name": "Primitive", + "value": "PRIMITIVE", + "description": "primitive" + }, + { + "name": "ObjectIdType", + "value": "OBJECT_ID_TYPE", + "description": "object id type" + }, + { + "name": "Enum", + "value": "ENUM", + "description": "enum" + }, + { + "name": "Struct", + "value": "STRUCT", + "description": "struct" + }, + { + "name": "Classification", + "value": "CLASSIFICATION", + "description": "classification" + }, + { + "name": "Entity", + "value": "ENTITY", + "description": "entity" + }, + { + "name": "Array", + "value": "ARRAY", + "description": "array" + }, + { + "name": "Map", + "value": "MAP", + "description": "map" + }, + { + "name": "Relationship", + "value": "RELATIONSHIP", + "description": "relationship" + }, + { + "name": "TermTemplate", + "value": "TERM_TEMPLATE", + "description": "term template" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", "in": "query", + "description": "The API version to use for this operation.", "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" + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index b43ca1dfa99c..28a56aa861b1 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -46,14 +46,7 @@ These settings apply only when `--tag=package-2023-09` is specified on the comma input-file: - Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json ``` -### Tag: package-2023-09-datamap -These settings apply only when `--tag=package-2023-09-datamap` is specified on the command line. - -```yaml $(tag) == 'package-2023-09-datamap' -input-file: - - Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json -``` ### Tag: package-preview-2023-02 These settings apply only when `--tag=package-preview-2023-02` is specified on the command line. From 3bc04aff4c6b4e87b86ca5c2efba1b3165521c23 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 10:26:53 +0800 Subject: [PATCH 107/132] update csharp naming --- .../Azure.Analytics.Purview.DataMap/client.tsp | 6 ++++++ .../Azure.Analytics.Purview.DataMap/models.tsp | 13 +++++++++---- .../stable/2023-09-01/purviewdatamap.json | 8 ++++---- 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index bfaf0c69db90..6458e06e6677 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -13,6 +13,7 @@ namespace Customizations; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup +@projectedName("csharp", "EntityOperations") interface Entity { createOrUpdate is PurviewDataMap.Entity.createOrUpdate; getByIds is PurviewDataMap.Entity.listByGuids; @@ -54,6 +55,7 @@ interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup +@projectedName("csharp", "GlossaryOperations") interface Glossary { batchGet is PurviewDataMap.Glossary.list; create is PurviewDataMap.Glossary.create; @@ -88,6 +90,7 @@ interface Glossary { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup +@projectedName("csharp", "DiscoveryOperations") interface Discovery { query is PurviewDataMap.Discovery.query; suggest is PurviewDataMap.Discovery.suggest; @@ -96,6 +99,7 @@ interface Discovery { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup +@projectedName("csharp", "LineageOperations") interface Lineage { get is PurviewDataMap.Lineage.get; getNextPage is PurviewDataMap.Lineage.getNextPage; @@ -104,6 +108,7 @@ interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup +@projectedName("csharp", "RelationshipOperations") interface Relationship { create is PurviewDataMap.Relationship.create; update is PurviewDataMap.Relationship.update; @@ -113,6 +118,7 @@ interface Relationship { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup +@projectedName("csharp", "TypeOperations") interface TypeDefinition { getBusinessMetadataById is PurviewDataMap.Type.getBusinessMetadataDefByGuid; getBusinessMetadataByName is PurviewDataMap.Type.getBusinessMetadataDefByName; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 6192effb4142..dab3506c2d81 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -499,7 +499,8 @@ model AtlasEntitiesWithExtInfo { entities?: AtlasEntity[]; } -@doc("The request content for classification association.") +@doc("The request payload for classification association.") +@projectedName("csharp", "ClassificationAssociateConfig") model ClassificationAssociateOptions { @doc(""" An instance of a classification; it doesn't have an identity, this object @@ -570,7 +571,8 @@ model ImportInfo { remarks?: string; } -@doc("MoveEntitiesContent") +@doc("MoveEntitiesOptions") +@projectedName("csharp", "MoveEntitiesConfig") model MoveEntitiesOptions { @doc("An array of entity guids to be moved to target collection.") entityGuids?: string[]; @@ -902,6 +904,7 @@ model AtlasGlossaryExtInfo { } @doc("The search query of advanced search request.") +@projectedName("csharp", "QueryConfig") model QueryOptions { @doc("The keywords applied to all searchable fields.") keywords?: string; @@ -1183,7 +1186,8 @@ Expert or Steward for a glossary term. contactType?: string; } -@doc("The query of suggest request.") +@doc("The payload of suggest request.") +@projectedName("csharp", "SuggestConfig") model SuggestOptions { @doc(""" The keywords applied to all fields that support suggest operation. It must be @@ -1295,7 +1299,8 @@ AtlasGlossaryCategory. longDescription?: string; } -@doc("The query of autocomplete request.") +@doc("The payload of autocomplete request.") +@projectedName("csharp", "AutoCompleteConfig") model AutoCompleteOptions { @doc(""" The keywords applied to all fields that support autocomplete operation. It must diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 2cde7be06e2e..cc3da88c6097 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -6994,7 +6994,7 @@ }, "AutoCompleteOptions": { "type": "object", - "description": "The query of autocomplete request.", + "description": "The payload of autocomplete request.", "properties": { "keywords": { "type": "string", @@ -7097,7 +7097,7 @@ }, "ClassificationAssociateOptions": { "type": "object", - "description": "The request content for classification association.", + "description": "The request payload for classification association.", "properties": { "classification": { "$ref": "#/definitions/AtlasClassification", @@ -7342,7 +7342,7 @@ }, "MoveEntitiesOptions": { "type": "object", - "description": "MoveEntitiesContent", + "description": "MoveEntitiesOptions", "properties": { "entityGuids": { "type": "array", @@ -8046,7 +8046,7 @@ }, "SuggestOptions": { "type": "object", - "description": "The query of suggest request.", + "description": "The payload of suggest request.", "properties": { "keywords": { "type": "string", From 536e2ad964687e9131c2fc178e09b34bd806affe Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 10:45:48 +0800 Subject: [PATCH 108/132] update --- .../purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml | 2 +- .../stable/2023-09-01/{purviewdatamap.json => openapi.json} | 0 specification/purview/data-plane/readme.md | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/{purviewdatamap.json => openapi.json} (100%) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 16d1cc8f38c8..b634cf430ddd 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -11,7 +11,7 @@ options: azure-resource-provider-folder: "data-plane" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" - output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/purviewdatamap.json" + output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/openapi.json" omit-unreachable-types: true "@azure-tools/typespec-python": package-dir: "azure-purview-datamap" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json similarity index 100% rename from specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json rename to specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 28a56aa861b1..78ff4fdf5a6a 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -44,7 +44,7 @@ These settings apply only when `--tag=package-2023-09` is specified on the comma ```yaml $(tag) == 'package-2023-09' input-file: - - Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json + - Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json ``` ### Tag: package-preview-2023-02 From 2a24220cbc28425dff5ea7ff0102b941aa4022a5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 11:10:06 +0800 Subject: [PATCH 109/132] Update client.tsp --- .../Azure.Analytics.Purview.DataMap/client.tsp | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 6458e06e6677..74bb2acb497e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -13,8 +13,7 @@ namespace Customizations; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -@projectedName("csharp", "EntityOperations") -interface Entity { +interface EntityOperations { createOrUpdate is PurviewDataMap.Entity.createOrUpdate; getByIds is PurviewDataMap.Entity.listByGuids; batchCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate; @@ -55,8 +54,7 @@ interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -@projectedName("csharp", "GlossaryOperations") -interface Glossary { +interface GlossaryOperations { batchGet is PurviewDataMap.Glossary.list; create is PurviewDataMap.Glossary.create; createCategories is PurviewDataMap.Glossary.createCategories; @@ -90,8 +88,7 @@ interface Glossary { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -@projectedName("csharp", "DiscoveryOperations") -interface Discovery { +interface DiscoveryOperations { query is PurviewDataMap.Discovery.query; suggest is PurviewDataMap.Discovery.suggest; autoComplete is PurviewDataMap.Discovery.autoComplete; @@ -99,8 +96,7 @@ interface Discovery { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -@projectedName("csharp", "LineageOperations") -interface Lineage { +interface LineageOperations { get is PurviewDataMap.Lineage.get; getNextPage is PurviewDataMap.Lineage.getNextPage; getByUniqueAttribute is PurviewDataMap.Lineage.getByUniqueAttribute; @@ -108,8 +104,7 @@ interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -@projectedName("csharp", "RelationshipOperations") -interface Relationship { +interface RelationshipOperations { create is PurviewDataMap.Relationship.create; update is PurviewDataMap.Relationship.update; get is PurviewDataMap.Relationship.get; @@ -118,8 +113,7 @@ interface Relationship { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -@projectedName("csharp", "TypeOperations") -interface TypeDefinition { +interface TypeDefinitionOperations { getBusinessMetadataById is PurviewDataMap.Type.getBusinessMetadataDefByGuid; getBusinessMetadataByName is PurviewDataMap.Type.getBusinessMetadataDefByName; getClassificationById is PurviewDataMap.Type.getClassificationDefByGuid; From 1113bc31d3da9ad6f3d54e5efbafbc599da09260 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 11:22:56 +0800 Subject: [PATCH 110/132] keep purviewdatamap.json --- .../Azure.Analytics.Purview.DataMap/client.tsp | 12 ++++++------ .../Azure.Analytics.Purview.DataMap/tspconfig.yaml | 2 +- .../2023-09-01/{openapi.json => purviewdatamap.json} | 0 specification/purview/data-plane/readme.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) rename specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/{openapi.json => purviewdatamap.json} (100%) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 74bb2acb497e..bfaf0c69db90 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -13,7 +13,7 @@ namespace Customizations; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -interface EntityOperations { +interface Entity { createOrUpdate is PurviewDataMap.Entity.createOrUpdate; getByIds is PurviewDataMap.Entity.listByGuids; batchCreateOrUpdate is PurviewDataMap.Entity.bulkCreateOrUpdate; @@ -54,7 +54,7 @@ interface EntityOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -interface GlossaryOperations { +interface Glossary { batchGet is PurviewDataMap.Glossary.list; create is PurviewDataMap.Glossary.create; createCategories is PurviewDataMap.Glossary.createCategories; @@ -88,7 +88,7 @@ interface GlossaryOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -interface DiscoveryOperations { +interface Discovery { query is PurviewDataMap.Discovery.query; suggest is PurviewDataMap.Discovery.suggest; autoComplete is PurviewDataMap.Discovery.autoComplete; @@ -96,7 +96,7 @@ interface DiscoveryOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -interface LineageOperations { +interface Lineage { get is PurviewDataMap.Lineage.get; getNextPage is PurviewDataMap.Lineage.getNextPage; getByUniqueAttribute is PurviewDataMap.Lineage.getByUniqueAttribute; @@ -104,7 +104,7 @@ interface LineageOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -interface RelationshipOperations { +interface Relationship { create is PurviewDataMap.Relationship.create; update is PurviewDataMap.Relationship.update; get is PurviewDataMap.Relationship.get; @@ -113,7 +113,7 @@ interface RelationshipOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup -interface TypeDefinitionOperations { +interface TypeDefinition { getBusinessMetadataById is PurviewDataMap.Type.getBusinessMetadataDefByGuid; getBusinessMetadataByName is PurviewDataMap.Type.getBusinessMetadataDefByName; getClassificationById is PurviewDataMap.Type.getClassificationDefByGuid; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index b634cf430ddd..16d1cc8f38c8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -11,7 +11,7 @@ options: azure-resource-provider-folder: "data-plane" emitter-output-dir: "{project-root}/.." examples-directory: "{project-root}/examples" - output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/openapi.json" + output-file: "{azure-resource-provider-folder}/Azure.Analytics.Purview.DataMap/{version-status}/{version}/purviewdatamap.json" omit-unreachable-types: true "@azure-tools/typespec-python": package-dir: "azure-purview-datamap" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json similarity index 100% rename from specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json rename to specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 78ff4fdf5a6a..28a56aa861b1 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -44,7 +44,7 @@ These settings apply only when `--tag=package-2023-09` is specified on the comma ```yaml $(tag) == 'package-2023-09' input-file: - - Azure.Analytics.Purview.DataMap/stable/2023-09-01/openapi.json + - Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json ``` ### Tag: package-preview-2023-02 From 9ec6c18dd563515ed461f09934a60a66bf12f1d9 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 11:29:04 +0800 Subject: [PATCH 111/132] Update readme.md --- specification/purview/data-plane/readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 28a56aa861b1..2f951e1b0917 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -299,13 +299,13 @@ See configuration in [readme.python.md](./readme.python.md) ``` yaml directive: - suppress: AvoidAnonymousParameter - from: openapi.json + from: purviewdatamap.json reason: This rule is irrelevant for data-plane TypeSpec specs. - suppress: AvoidAnonymousTypes - from: openapi.json + from: purviewdatamap.json reason: This rule is irrelevant for data-plane TypeSpec specs. - suppress: IntegerTypeMustHaveFormat - from: openapi.json + from: purviewdatamap.json reason: This rule is irrelevant for SDKs generated directly by TypeSpec. ``` From 03d0031677bfdb5e33c3b938fbaa64fa81c4895f Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 11:44:03 +0800 Subject: [PATCH 112/132] test for csharp operation group name --- specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index f97257c25052..40e4f85f34cb 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -58,6 +58,7 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr contentType: "multipart/form-data"; }>; +@projectedName("csharp", "EntityOperations") interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" From ec02e53e56f6daf96c70e42e89b58c1fb47a62ab Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Thu, 1 Feb 2024 12:41:03 +0800 Subject: [PATCH 113/132] Update routes.tsp --- specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 40e4f85f34cb..f97257c25052 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -58,7 +58,6 @@ alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTr contentType: "multipart/form-data"; }>; -@projectedName("csharp", "EntityOperations") interface Entity { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc(""" From 127d381a9811c869181b96520e19a72776df1ba7 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 08:23:33 +0800 Subject: [PATCH 114/132] Update routes.tsp --- specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index f97257c25052..eb9667e6d2e3 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -4,7 +4,6 @@ import "@typespec/http"; import "@typespec/versioning"; import "@typespec/rest"; import "./models.tsp"; -import "./main.tsp"; using TypeSpec.Rest; using TypeSpec.Http; From 14754b389334385fb96c79a5e5a5f32347073d6e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 08:27:09 +0800 Subject: [PATCH 115/132] fix comments --- specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index eb9667e6d2e3..a81e5efe6114 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -740,7 +740,6 @@ default is false. AtlasErrorResponse >; - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get From 1a0e31b260ff4cc17d1e431236463f365e0b06b5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 10:23:22 +0800 Subject: [PATCH 116/132] Update routes.tsp --- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index a81e5efe6114..ce7d9760f528 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -47,7 +47,7 @@ op AtlasImportOperation< TraitLocation.Response, TraitContext.Action >, - Traits & NoConditionalRequests & NoRepeatableRequests & NoClientRequestId, + Traits, AtlasErrorResponse >; From 9bb7d7851f4d373ebc628066882ab4401e48d663 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 10:31:49 +0800 Subject: [PATCH 117/132] move to client.tsp --- .../purview/Azure.Analytics.Purview.DataMap/client.tsp | 9 +++++++++ .../purview/Azure.Analytics.Purview.DataMap/models.tsp | 9 --------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index bfaf0c69db90..fa5da1b0b3bf 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -11,6 +11,15 @@ using PurviewDataMap; }) namespace Customizations; +@@projectedName(MoveEntitiesOptions, "csharp", "MoveEntitiesConfig"); +@@projectedName(DateFormat,"csharp", "AtlasDateFormat"); +@@projectedName(NumberFormat, "csharp", "AtlasNumberFormat"); +@@projectedName(TimeZone, "csharp", "AtlasTimeZone"); +@@projectedName(SortType,"csharp", "AtlasSortType"); +@@projectedName(ClassificationAssociateOptions, "csharp", "ClassificationAssociateConfig"); +@@projectedName(QueryOptions, "csharp", "QueryConfig"); +@@projectedName(SuggestOptions"csharp", "SuggestConfig"); +@@projectedName(AutoCompleteOptions, "csharp", "AutoCompleteConfig"); #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup interface Entity { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index dab3506c2d81..ab28755f2efb 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -52,7 +52,6 @@ enum AtlasTermAssignmentStatus { } @doc("Type for sorting") -@projectedName("csharp", "AtlasSortType") enum SortType { @doc("No sorting order") None: "NONE", @@ -500,7 +499,6 @@ model AtlasEntitiesWithExtInfo { } @doc("The request payload for classification association.") -@projectedName("csharp", "ClassificationAssociateConfig") model ClassificationAssociateOptions { @doc(""" An instance of a classification; it doesn't have an identity, this object @@ -572,7 +570,6 @@ model ImportInfo { } @doc("MoveEntitiesOptions") -@projectedName("csharp", "MoveEntitiesConfig") model MoveEntitiesOptions { @doc("An array of entity guids to be moved to target collection.") entityGuids?: string[]; @@ -904,7 +901,6 @@ model AtlasGlossaryExtInfo { } @doc("The search query of advanced search request.") -@projectedName("csharp", "QueryConfig") model QueryOptions { @doc("The keywords applied to all searchable fields.") keywords?: string; @@ -1187,7 +1183,6 @@ Expert or Steward for a glossary term. } @doc("The payload of suggest request.") -@projectedName("csharp", "SuggestConfig") model SuggestOptions { @doc(""" The keywords applied to all fields that support suggest operation. It must be @@ -1300,7 +1295,6 @@ AtlasGlossaryCategory. } @doc("The payload of autocomplete request.") -@projectedName("csharp", "AutoCompleteConfig") model AutoCompleteOptions { @doc(""" The keywords applied to all fields that support autocomplete operation. It must @@ -1555,7 +1549,6 @@ model AtlasBaseTypeDef { } @doc("The date format.") -@projectedName("csharp", "AtlasDateFormat") model DateFormat { @doc("An array of available locales.") availableLocales?: string[]; @@ -1586,7 +1579,6 @@ model DateFormat { } @doc("The number format.") -@projectedName("csharp", "AtlasNumberFormat") model NumberFormat { @doc("The number format.") availableLocales?: string[]; @@ -1632,7 +1624,6 @@ model NumberFormat { } @doc("The timezone information.") -@projectedName("csharp", "AtlasTimeZone") model TimeZone { @doc("The value of the daylight saving time.") dstSavings?: int32; From e50c8883685aff70e3ba97f0d6554833a6e59e8c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 11:34:52 +0800 Subject: [PATCH 118/132] Update client.tsp --- .../Azure.Analytics.Purview.DataMap/client.tsp | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index fa5da1b0b3bf..a3f1184aec5e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -11,15 +11,25 @@ using PurviewDataMap; }) namespace Customizations; +@@access(MoveEntitiesOptions, Access.internal); @@projectedName(MoveEntitiesOptions, "csharp", "MoveEntitiesConfig"); +@@access(DateFormat, Access.internal); @@projectedName(DateFormat,"csharp", "AtlasDateFormat"); +@@access(NumberFormat, Access.internal); @@projectedName(NumberFormat, "csharp", "AtlasNumberFormat"); +@@access(TimeZone, Access.internal); @@projectedName(TimeZone, "csharp", "AtlasTimeZone"); +@@access(SortType, Access.internal); @@projectedName(SortType,"csharp", "AtlasSortType"); +@@access(ClassificationAssociateOptions, Access.internal); @@projectedName(ClassificationAssociateOptions, "csharp", "ClassificationAssociateConfig"); +@@access(QueryOptions, Access.internal); @@projectedName(QueryOptions, "csharp", "QueryConfig"); -@@projectedName(SuggestOptions"csharp", "SuggestConfig"); +@@access(SuggestOptions, Access.internal); +@@projectedName(SuggestOptions, "csharp", "SuggestConfig"); +@@access(AutoCompleteOptions, Access.internal); @@projectedName(AutoCompleteOptions, "csharp", "AutoCompleteConfig"); + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" @operationGroup interface Entity { From 46f90c40d8045a7d5c82c1d37013deeeb8c046ad Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 14:36:40 +0800 Subject: [PATCH 119/132] Update client.tsp --- .../Azure.Analytics.Purview.DataMap/client.tsp | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index a3f1184aec5e..02be7295baf4 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -11,23 +11,23 @@ using PurviewDataMap; }) namespace Customizations; -@@access(MoveEntitiesOptions, Access.internal); +@@access(MoveEntitiesOptions, Access.public); @@projectedName(MoveEntitiesOptions, "csharp", "MoveEntitiesConfig"); -@@access(DateFormat, Access.internal); +@@access(DateFormat, Access.public); @@projectedName(DateFormat,"csharp", "AtlasDateFormat"); -@@access(NumberFormat, Access.internal); +@@access(NumberFormat, Access.public); @@projectedName(NumberFormat, "csharp", "AtlasNumberFormat"); -@@access(TimeZone, Access.internal); +@@access(TimeZone, Access.public); @@projectedName(TimeZone, "csharp", "AtlasTimeZone"); -@@access(SortType, Access.internal); +@@access(SortType, Access.public); @@projectedName(SortType,"csharp", "AtlasSortType"); -@@access(ClassificationAssociateOptions, Access.internal); +@@access(ClassificationAssociateOptions, Access.public); @@projectedName(ClassificationAssociateOptions, "csharp", "ClassificationAssociateConfig"); -@@access(QueryOptions, Access.internal); +@@access(QueryOptions, Access.public); @@projectedName(QueryOptions, "csharp", "QueryConfig"); -@@access(SuggestOptions, Access.internal); +@@access(SuggestOptions, Access.public); @@projectedName(SuggestOptions, "csharp", "SuggestConfig"); -@@access(AutoCompleteOptions, Access.internal); +@@access(AutoCompleteOptions, Access.public); @@projectedName(AutoCompleteOptions, "csharp", "AutoCompleteConfig"); #suppress "@azure-tools/typespec-azure-core/use-standard-operations" From c0c8608050b8265f4a52d52bc957f0dc98f9f817 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 14:52:19 +0800 Subject: [PATCH 120/132] Update client.tsp --- .../purview/Azure.Analytics.Purview.DataMap/client.tsp | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index 02be7295baf4..cddbf9ffb582 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -14,15 +14,18 @@ namespace Customizations; @@access(MoveEntitiesOptions, Access.public); @@projectedName(MoveEntitiesOptions, "csharp", "MoveEntitiesConfig"); @@access(DateFormat, Access.public); -@@projectedName(DateFormat,"csharp", "AtlasDateFormat"); +@@projectedName(DateFormat, "csharp", "AtlasDateFormat"); @@access(NumberFormat, Access.public); @@projectedName(NumberFormat, "csharp", "AtlasNumberFormat"); @@access(TimeZone, Access.public); @@projectedName(TimeZone, "csharp", "AtlasTimeZone"); @@access(SortType, Access.public); -@@projectedName(SortType,"csharp", "AtlasSortType"); +@@projectedName(SortType, "csharp", "AtlasSortType"); @@access(ClassificationAssociateOptions, Access.public); -@@projectedName(ClassificationAssociateOptions, "csharp", "ClassificationAssociateConfig"); +@@projectedName(ClassificationAssociateOptions, + "csharp", + "ClassificationAssociateConfig" +); @@access(QueryOptions, Access.public); @@projectedName(QueryOptions, "csharp", "QueryConfig"); @@access(SuggestOptions, Access.public); From 4558f1042a62e222c294cbfa96895dc13e78573c Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 15:58:16 +0800 Subject: [PATCH 121/132] update api version query parameter --- .../routes.tsp | 194 ++++++++++-------- .../stable/2023-09-01/purviewdatamap.json | 182 ++++++++-------- 2 files changed, 204 insertions(+), 172 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index ce7d9760f528..bb9c4b5bcced 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -15,6 +15,28 @@ using Azure.ClientGenerator.Core; namespace PurviewDataMap; +@doc("The ApiVersion query parameter for Atlas API.") +model AtlasApiVersionParameter { + @query("api-version") + @minLength(1) + @doc("The API version to use for this operation.") + apiVersion?: string; +} + +@doc("The operation defined for Atlas APIs") +op AtlasOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse, + Traits extends TypeSpec.Reflection.Model = {}, + TErrorResponse = Azure.Core.Foundations.ErrorResponse +>( + ...TraitProperties< + Traits & VersionParameterTrait, + TraitLocation.ApiVersionParameter + >, + ...TParams, +): TResponse | TErrorResponse; + model OkResponse { @statusCode status: 200; @@ -28,7 +50,7 @@ op AtlasImportOperation< TResponse extends TypeSpec.Reflection.Model, Traits extends TypeSpec.Reflection.Model = {}, TraitContexts extends TraitContext = TraitContext.Undefined -> is Azure.Core.Foundations.Operation< +> is AtlasOperation< TParams & TraitProperties< Traits & @@ -70,7 +92,7 @@ For each contact type, the maximum number of contacts is 20. """) @route("/atlas/v2/entity") @post - createOrUpdate is Azure.Core.Foundations.Operation< + createOrUpdate is AtlasOperation< { @doc(""" Used to define the update behavior for business attributes when updating @@ -100,7 +122,7 @@ need to move an entity to another collection. @doc("List entities in bulk identified by its GUIDs.") @route("/atlas/v2/entity/bulk") @get - listByGuids is Azure.Core.Foundations.Operation< + listByGuids is AtlasOperation< { @doc("An array of GUIDs of entities to list.") @query({ @@ -134,7 +156,7 @@ is 20. """) @route("/atlas/v2/entity/bulk") @post - bulkCreateOrUpdate is Azure.Core.Foundations.Operation< + bulkCreateOrUpdate is AtlasOperation< { @doc(""" The collection where entities will be moved to. Only specify a value if you @@ -167,7 +189,7 @@ attributes. """) @route("/atlas/v2/entity/bulk") @delete - bulkDelete is Azure.Core.Foundations.Operation< + bulkDelete is AtlasOperation< { @doc("An array of GUIDs of entities to delete.") @query({ @@ -184,7 +206,7 @@ attributes. @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is Azure.Core.Foundations.Operation< + addClassification is AtlasOperation< { @doc("The request to associate a classification to multiple entities.") @body @@ -199,7 +221,7 @@ attributes. @doc("Get complete definition of an entity given its GUID.") @route("/atlas/v2/entity/guid/{guid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -228,7 +250,7 @@ Null updates are not possible. """) @route("/atlas/v2/entity/guid/{guid}") @put - partialUpdateAttributeByGuid is Azure.Core.Foundations.Operation< + partialUpdateAttributeByGuid is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -252,7 +274,7 @@ Null updates are not possible. @doc("Delete an entity identified by its GUID.") @route("/atlas/v2/entity/guid/{guid}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -267,7 +289,7 @@ Null updates are not possible. @doc("Get classification for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @get - getClassification is Azure.Core.Foundations.Operation< + getClassification is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -286,7 +308,7 @@ Null updates are not possible. @doc("Delete a given classification from an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @delete - removeClassification is Azure.Core.Foundations.Operation< + removeClassification is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -305,7 +327,7 @@ Null updates are not possible. @doc("List classifications for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @get - getClassifications is Azure.Core.Foundations.Operation< + getClassifications is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -321,7 +343,7 @@ Null updates are not possible. @doc("Add classifications to an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @post - addClassifications is Azure.Core.Foundations.Operation< + addClassifications is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -341,7 +363,7 @@ Null updates are not possible. @doc("Update classifications to an existing entity represented by a guid.") @route("/atlas/v2/entity/guid/{guid}/classifications") @put - updateClassifications is Azure.Core.Foundations.Operation< + updateClassifications is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -375,7 +397,7 @@ GET """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @get - getByUniqueAttributes is Azure.Core.Foundations.Operation< + getByUniqueAttributes is AtlasOperation< { @doc("The name of the type.") @path @@ -422,7 +444,7 @@ PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @put - partialUpdateByUniqueAttributes is Azure.Core.Foundations.Operation< + partialUpdateByUniqueAttributes is AtlasOperation< { @doc("The name of the type.") @path @@ -461,7 +483,7 @@ DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}") @delete - deleteByUniqueAttribute is Azure.Core.Foundations.Operation< + deleteByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -486,7 +508,7 @@ attributes. """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}") @delete - removeClassificationByUniqueAttribute is Azure.Core.Foundations.Operation< + removeClassificationByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -513,7 +535,7 @@ be changed to other unique attributes) @doc("Add classification to the entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @post - addClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + addClassificationsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -540,7 +562,7 @@ be changed to other unique attributes) @doc("Update classification on an entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @put - updateClassificationsByUniqueAttribute is Azure.Core.Foundations.Operation< + updateClassificationsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -566,7 +588,7 @@ be changed to other unique attributes) @doc("Set classifications on entities in bulk.") @route("/atlas/v2/entity/bulk/setClassifications") @post - bulkSetClassifications is Azure.Core.Foundations.Operation< + bulkSetClassifications is AtlasOperation< { @doc("Atlas entity headers.") @body @@ -601,7 +623,7 @@ at least one unique attribute must be provided. """) @route("/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}") @get - listByUniqueAttributes is Azure.Core.Foundations.Operation< + listByUniqueAttributes is AtlasOperation< { @doc("The name of the type.") @path @@ -632,7 +654,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Get entity header given its GUID.") @route("/atlas/v2/entity/guid/{guid}/header") @get - getHeader is Azure.Core.Foundations.Operation< + getHeader is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -647,7 +669,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Remove business metadata from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @delete - removeBusinessMetadata is Azure.Core.Foundations.Operation< + removeBusinessMetadata is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -667,7 +689,7 @@ example. qualifiedName can be changed to other unique attributes) @doc("Add business metadata to an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @post - addOrUpdateBusinessMetadata is Azure.Core.Foundations.Operation< + addOrUpdateBusinessMetadata is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -695,7 +717,7 @@ default is false. @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") @delete - removeBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + removeBusinessMetadataAttributes is AtlasOperation< { @doc("BusinessMetadata name") @path @@ -720,7 +742,7 @@ default is false. @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") @post - addOrUpdateBusinessMetadataAttributes is Azure.Core.Foundations.Operation< + addOrUpdateBusinessMetadataAttributes is AtlasOperation< { @doc("BusinessMetadata name") @path @@ -772,7 +794,7 @@ default is false. @doc("Delete given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @delete - removeLabels is Azure.Core.Foundations.Operation< + removeLabels is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -792,7 +814,7 @@ default is false. @doc("Set labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @post - setLabels is Azure.Core.Foundations.Operation< + setLabels is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -812,7 +834,7 @@ default is false. @doc("Add given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @put - addLabel is Azure.Core.Foundations.Operation< + addLabel is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -846,7 +868,7 @@ this: DELETE """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @delete - removeLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + removeLabelsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -889,7 +911,7 @@ request would look something like this: POST """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @post - setLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + setLabelsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -932,7 +954,7 @@ request would look something like this: PUT """) @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels") @put - addLabelsByUniqueAttribute is Azure.Core.Foundations.Operation< + addLabelsByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -988,7 +1010,7 @@ and """) @route("/atlas/v2/glossary") @get - list is Azure.Core.Foundations.Operation< + list is AtlasOperation< { @doc("The page size - by default there is no paging.") @query @@ -1016,7 +1038,7 @@ and @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is Azure.Core.Foundations.Operation< + create is AtlasOperation< { @doc(""" Glossary definition, terms & categories can be anchored to a glossary. @@ -1036,7 +1058,7 @@ the anchor attribute when creating the Term/Category. @doc("Create glossary category in bulk.") @route("/atlas/v2/glossary/categories") @post - createCategories is Azure.Core.Foundations.Operation< + createCategories is AtlasOperation< { @doc("An array of glossary category definitions to be created.") @body @@ -1051,7 +1073,7 @@ the anchor attribute when creating the Term/Category. @doc("Create a glossary category.") @route("/atlas/v2/glossary/category") @post - createCategory is Azure.Core.Foundations.Operation< + createCategory is AtlasOperation< { @doc(""" The glossary category definition. A category must be anchored to a Glossary @@ -1071,7 +1093,7 @@ can also be defined during creation. @doc("Get specific glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryId}") @get - getCategory is Azure.Core.Foundations.Operation< + getCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -1086,7 +1108,7 @@ can also be defined during creation. @doc("Update the given glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryId}") @put - updateCategory is Azure.Core.Foundations.Operation< + updateCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -1105,7 +1127,7 @@ can also be defined during creation. @doc("Delete a glossary category.") @route("/atlas/v2/glossary/category/{categoryId}") @delete - deleteCategory is Azure.Core.Foundations.Operation< + deleteCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -1124,7 +1146,7 @@ updating shortDescription and longDescription for category. """) @route("/atlas/v2/glossary/category/{categoryId}/partial") @put - partialUpdateCategory is Azure.Core.Foundations.Operation< + partialUpdateCategory is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -1149,7 +1171,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/category/{categoryId}/related") @get - listRelatedCategories is Azure.Core.Foundations.Operation< + listRelatedCategories is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -1176,7 +1198,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Get all terms associated with the specific category.") @route("/atlas/v2/glossary/category/{categoryId}/terms") @get - listCategoryTerms is Azure.Core.Foundations.Operation< + listCategoryTerms is AtlasOperation< { @doc("The globally unique identifier of the category.") @path @@ -1203,7 +1225,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Create a glossary term.") @route("/atlas/v2/glossary/term") @post - createTerm is Azure.Core.Foundations.Operation< + createTerm is AtlasOperation< { @doc("Whether include term hierarchy") @query @@ -1226,7 +1248,7 @@ Optionally it can be categorized as well. @doc("Get a specific glossary term by its GUID. ") @route("/atlas/v2/glossary/term/{termId}") @get - getTerm is Azure.Core.Foundations.Operation< + getTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1241,7 +1263,7 @@ Optionally it can be categorized as well. @doc("Update the given glossary term by its GUID.") @route("/atlas/v2/glossary/term/{termId}") @put - updateTerm is Azure.Core.Foundations.Operation< + updateTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1264,7 +1286,7 @@ Optionally it can be categorized as well. @doc("Delete a glossary term.") @route("/atlas/v2/glossary/term/{termId}") @delete - deleteTerm is Azure.Core.Foundations.Operation< + deleteTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1283,7 +1305,7 @@ shortDescription, longDescription, abbreviation, usage and status for term. """) @route("/atlas/v2/glossary/term/{termId}/partial") @put - partialUpdateTerm is Azure.Core.Foundations.Operation< + partialUpdateTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1310,7 +1332,7 @@ values to be updated. @doc("Create glossary terms in bulk.") @route("/atlas/v2/glossary/terms") @post - createTerms is Azure.Core.Foundations.Operation< + createTerms is AtlasOperation< { @doc("Whether include term hierarchy") @query @@ -1332,7 +1354,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @get - listEntitiesAssignedWithTerm is Azure.Core.Foundations.Operation< + listEntitiesAssignedWithTerm is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1367,7 +1389,7 @@ is an alternative to assign a term to multiple entities. """) @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @post - assignTermToEntities is Azure.Core.Foundations.Operation< + assignTermToEntities is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1387,7 +1409,7 @@ is an alternative to assign a term to multiple entities. @doc("Delete the term assignment for the given list of related objects.") @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @delete - deleteTermAssignmentFromEntities is Azure.Core.Foundations.Operation< + deleteTermAssignmentFromEntities is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1409,7 +1431,7 @@ parameters are currently not being enabled and won't work even they are passed. """) @route("/atlas/v2/glossary/terms/{termId}/related") @get - listRelatedTerms is Azure.Core.Foundations.Operation< + listRelatedTerms is AtlasOperation< { @doc("The globally unique identifier for glossary term.") @path @@ -1436,7 +1458,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Get a specific Glossary by its GUID.") @route("/atlas/v2/glossary/{glossaryId}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1451,7 +1473,7 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Update the given glossary.") @route("/atlas/v2/glossary/{glossaryId}") @put - update is Azure.Core.Foundations.Operation< + update is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1477,7 +1499,7 @@ separate delete terms and categories. """) @route("/atlas/v2/glossary/{glossaryId}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1495,7 +1517,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryId}/categories") @get - listCategories is Azure.Core.Foundations.Operation< + listCategories is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1525,7 +1547,7 @@ limit/offset to get pagination result. """) @route("/atlas/v2/glossary/{glossaryId}/categories/headers") @get - listCategoriesHeaders is Azure.Core.Foundations.Operation< + listCategoriesHeaders is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1561,7 +1583,7 @@ GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. """) @route("/atlas/v2/glossary/{glossaryId}/detailed") @get - getDetailed is Azure.Core.Foundations.Operation< + getDetailed is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1586,7 +1608,7 @@ using 'ignoreTermsAndCategories=true' to reduce response body size. """) @route("/atlas/v2/glossary/{glossaryId}/partial") @put - partialUpdate is Azure.Core.Foundations.Operation< + partialUpdate is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1615,7 +1637,7 @@ pagination result. """) @route("/atlas/v2/glossary/{glossaryId}/terms") @get - listTerms is Azure.Core.Foundations.Operation< + listTerms is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1645,7 +1667,7 @@ to get pagination result. """) @route("/atlas/v2/glossary/{glossaryId}/terms/headers") @get - listTermHeaders is Azure.Core.Foundations.Operation< + listTermHeaders is AtlasOperation< { @doc("The globally unique identifier for glossary.") @path @@ -1721,7 +1743,7 @@ interface Lineage { @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1788,7 +1810,7 @@ GET """) @route("/atlas/v2/lineage/uniqueAttribute/type/{typeName}") @get - getByUniqueAttribute is Azure.Core.Foundations.Operation< + getByUniqueAttribute is AtlasOperation< { @doc("The name of the type.") @path @@ -1820,7 +1842,7 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is Azure.Core.Foundations.Operation< + create is AtlasOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1838,7 +1860,7 @@ be created. @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is Azure.Core.Foundations.Operation< + update is AtlasOperation< { @doc(""" The AtlasRelationship object containing the information for the relationship to @@ -1856,7 +1878,7 @@ be created. @doc("Get relationship information between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @get - get is Azure.Core.Foundations.Operation< + get is AtlasOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1875,7 +1897,7 @@ be created. @doc("Delete a relationship between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -1892,7 +1914,7 @@ interface Type { @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get - getBusinessMetadataDefByGuid is Azure.Core.Foundations.Operation< + getBusinessMetadataDefByGuid is AtlasOperation< { @doc("businessMetadata guid") @path @@ -1907,7 +1929,7 @@ interface Type { @doc("Get the businessMetadata definition by it's name (unique).") @route("/atlas/v2/types/businessmetadatadef/name/{name}") @get - getBusinessMetadataDefByName is Azure.Core.Foundations.Operation< + getBusinessMetadataDefByName is AtlasOperation< { @doc("businessMetadata name") @path @@ -1922,7 +1944,7 @@ interface Type { @doc("Get the classification definition for the given GUID.") @route("/atlas/v2/types/classificationdef/guid/{guid}") @get - getClassificationDefByGuid is Azure.Core.Foundations.Operation< + getClassificationDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the classification.") @path @@ -1937,7 +1959,7 @@ interface Type { @doc("Get the classification definition by its name (unique).") @route("/atlas/v2/types/classificationdef/name/{name}") @get - getClassificationDefByName is Azure.Core.Foundations.Operation< + getClassificationDefByName is AtlasOperation< { @doc("The name of the classification.") @path @@ -1952,7 +1974,7 @@ interface Type { @doc("Get the Entity definition for the given GUID.") @route("/atlas/v2/types/entitydef/guid/{guid}") @get - getEntityDefByGuid is Azure.Core.Foundations.Operation< + getEntityDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the entity.") @path @@ -1967,7 +1989,7 @@ interface Type { @doc("Get the entity definition by its name (unique).") @route("/atlas/v2/types/entitydef/name/{name}") @get - getEntityDefByName is Azure.Core.Foundations.Operation< + getEntityDefByName is AtlasOperation< { @doc("The name of the entity.") @path @@ -1982,7 +2004,7 @@ interface Type { @doc("Get the enum definition for the given GUID.") @route("/atlas/v2/types/enumdef/guid/{guid}") @get - getEnumDefByGuid is Azure.Core.Foundations.Operation< + getEnumDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the enum.") @path @@ -1997,7 +2019,7 @@ interface Type { @doc("Get the enum definition by its name (unique).") @route("/atlas/v2/types/enumdef/name/{name}") @get - getEnumDefByName is Azure.Core.Foundations.Operation< + getEnumDefByName is AtlasOperation< { @doc("The name of the enum.") @path @@ -2012,7 +2034,7 @@ interface Type { @doc("Get the relationship definition for the given GUID.") @route("/atlas/v2/types/relationshipdef/guid/{guid}") @get - getRelationshipDefByGuid is Azure.Core.Foundations.Operation< + getRelationshipDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the relationship.") @path @@ -2027,7 +2049,7 @@ interface Type { @doc("Get the relationship definition by its name (unique).") @route("/atlas/v2/types/relationshipdef/name/{name}") @get - getRelationshipDefByName is Azure.Core.Foundations.Operation< + getRelationshipDefByName is AtlasOperation< { @doc("The name of the relationship.") @path @@ -2042,7 +2064,7 @@ interface Type { @doc("Get the struct definition for the given GUID.") @route("/atlas/v2/types/structdef/guid/{guid}") @get - getStructDefByGuid is Azure.Core.Foundations.Operation< + getStructDefByGuid is AtlasOperation< { @doc("The globally unique identifier of the struct.") @path @@ -2057,7 +2079,7 @@ interface Type { @doc("Get the struct definition by its name (unique).") @route("/atlas/v2/types/structdef/name/{name}") @get - getStructDefByName is Azure.Core.Foundations.Operation< + getStructDefByName is AtlasOperation< { @doc("The name of the struct.") @path @@ -2072,7 +2094,7 @@ interface Type { @doc("Get the type definition for the given GUID.") @route("/atlas/v2/types/typedef/guid/{guid}") @get - getByGuid is Azure.Core.Foundations.Operation< + getByGuid is AtlasOperation< { @doc("The globally unique identifier of the type.") @path @@ -2087,7 +2109,7 @@ interface Type { @doc("Get the type definition by its name (unique).") @route("/atlas/v2/types/typedef/name/{name}") @get - getByName is Azure.Core.Foundations.Operation< + getByName is AtlasOperation< { @doc("The name of the type.") @path @@ -2102,7 +2124,7 @@ interface Type { @doc("Delete API for type identified by its name.") @route("/atlas/v2/types/typedef/name/{name}") @delete - delete is Azure.Core.Foundations.Operation< + delete is AtlasOperation< { @doc("The name of the type.") @path @@ -2144,7 +2166,7 @@ Any changes to the existing definitions will be discarded. """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is Azure.Core.Foundations.Operation< + bulkCreate is AtlasOperation< { @doc("A composite wrapper object with corresponding lists of the type definition.") @body @@ -2162,7 +2184,7 @@ persisted. """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is Azure.Core.Foundations.Operation< + bulkUpdate is AtlasOperation< { @doc("A composite object that captures all type definition changes.") @body @@ -2177,7 +2199,7 @@ persisted. @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is Azure.Core.Foundations.Operation< + bulkDelete is AtlasOperation< { @doc("A composite object that captures all types to be deleted") @body diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index cc3da88c6097..3de49e1f7e2f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -57,7 +57,7 @@ "description": "Create or update an entity.\nExisting entity is matched using its unique guid if\nsupplied or by its unique attributes eg: qualifiedName.\nMap and array of\ncollections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "businessAttributeUpdateBehavior", @@ -142,7 +142,7 @@ "description": "List entities in bulk identified by its GUIDs.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -195,7 +195,7 @@ "description": "Create or update entities in bulk.\nExisting entity is matched using its unique\nguid if supplied or by its unique attributes eg: qualifiedName.\nMap and array\nof collections are not well supported. E.g., array>,\narray>.\nFor each contact type, the maximum number of contacts\nis 20.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "collectionId", @@ -272,7 +272,7 @@ "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -313,7 +313,7 @@ "description": "Associate a classification to multiple entities in bulk.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -349,7 +349,7 @@ "description": "Set classifications on entities in bulk.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -391,7 +391,7 @@ "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -452,7 +452,7 @@ ], "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "file", @@ -523,7 +523,7 @@ "description": "Get complete definition of an entity given its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -572,7 +572,7 @@ "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -621,7 +621,7 @@ "description": "Delete an entity identified by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -658,7 +658,7 @@ "description": "Add business metadata to an entity.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -711,7 +711,7 @@ "description": "Remove business metadata from an entity.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -758,7 +758,7 @@ "description": "Add or update business metadata attributes.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "businessMetadataName", @@ -807,7 +807,7 @@ "description": "Delete business metadata attributes from an entity.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "businessMetadataName", @@ -858,7 +858,7 @@ "description": "Get classification for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -900,7 +900,7 @@ "description": "Delete a given classification from an existing entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -941,7 +941,7 @@ "description": "List classifications for a given entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -976,7 +976,7 @@ "description": "Update classifications to an existing entity represented by a guid.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -1021,7 +1021,7 @@ "description": "Add classifications to an existing entity represented by a GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -1068,7 +1068,7 @@ "description": "Get entity header given its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -1105,7 +1105,7 @@ "description": "Add given labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -1149,7 +1149,7 @@ "description": "Set labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -1193,7 +1193,7 @@ "description": "Delete given labels to a given entity.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -1239,7 +1239,7 @@ "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1296,7 +1296,7 @@ "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1348,7 +1348,7 @@ "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1393,7 +1393,7 @@ "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1442,7 +1442,7 @@ "description": "Update classification on an entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1495,7 +1495,7 @@ "description": "Add classification to the entity identified by its type and unique attributes.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1550,7 +1550,7 @@ "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1602,7 +1602,7 @@ "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1654,7 +1654,7 @@ "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -1708,7 +1708,7 @@ "description": "Get all glossaries. Recommend using limit/offset to get pagination result.\nRecommend using 'ignoreTermsAndCategories=true' and fetch terms/categories\nseparately using \n\n 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms'\nand \n\n 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "limit", @@ -1770,7 +1770,7 @@ "description": "Create a glossary.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -1809,7 +1809,7 @@ "description": "Get a specific Glossary by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -1844,7 +1844,7 @@ "description": "Update the given glossary.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -1895,7 +1895,7 @@ "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -1929,7 +1929,7 @@ "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -1993,7 +1993,7 @@ "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -2057,7 +2057,7 @@ "description": "Get a specific glossary with detailed information. This API is not\nrecommend.\n\nRecommend to fetch terms/categories details separately using \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and \n\nGET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -2094,7 +2094,7 @@ "description": "Update the glossary partially. Some properties such as qualifiedName are not\nallowed to be updated.\n\nSo far we only supports partial updating\nshortDescription, longDescription, language and usage for glossary. \n\nRecommend\nusing 'ignoreTermsAndCategories=true' to reduce response body size.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -2150,7 +2150,7 @@ "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get\npagination result.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -2214,7 +2214,7 @@ "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "glossaryId", @@ -2278,7 +2278,7 @@ "description": "Create glossary category in bulk.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -2325,7 +2325,7 @@ "description": "Create a glossary category.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -2364,7 +2364,7 @@ "description": "Get specific glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "categoryId", @@ -2399,7 +2399,7 @@ "description": "Update the given glossary category by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "categoryId", @@ -2443,7 +2443,7 @@ "description": "Delete a glossary category.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "categoryId", @@ -2477,7 +2477,7 @@ "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "categoryId", @@ -2526,7 +2526,7 @@ "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "categoryId", @@ -2593,7 +2593,7 @@ "description": "Get all terms associated with the specific category.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "categoryId", @@ -2657,7 +2657,7 @@ "description": "Create a glossary term.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "includeTermHierarchy", @@ -2706,7 +2706,7 @@ "description": "Get a specific glossary term by its GUID. ", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -2744,7 +2744,7 @@ "description": "Update the given glossary term by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -2795,7 +2795,7 @@ "description": "Delete a glossary term.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -2829,7 +2829,7 @@ "description": "Update the glossary term partially. So far we only supports partial updating\nshortDescription, longDescription, abbreviation, usage and status for term.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -2885,7 +2885,7 @@ "description": "Create glossary terms in bulk.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "includeTermHierarchy", @@ -2939,7 +2939,7 @@ "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -3001,7 +3001,7 @@ "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -3046,7 +3046,7 @@ "description": "Delete the term assignment for the given list of related objects.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -3093,7 +3093,7 @@ "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "termId", @@ -3160,7 +3160,7 @@ "description": "Get lineage info of the entity specified by GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3238,7 +3238,7 @@ "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "typeName", @@ -3324,7 +3324,7 @@ "description": "Update an existing relationship between entities.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -3361,7 +3361,7 @@ "description": "Create a new relationship between entities.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -3400,7 +3400,7 @@ "description": "Get relationship information between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3442,7 +3442,7 @@ "description": "Delete a relationship between entities by its GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3476,7 +3476,7 @@ "description": "Get the businessMetadata definition for the given guid.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3513,7 +3513,7 @@ "description": "Get the businessMetadata definition by it's name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3550,7 +3550,7 @@ "description": "Get the classification definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3587,7 +3587,7 @@ "description": "Get the classification definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3624,7 +3624,7 @@ "description": "Get the Entity definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3661,7 +3661,7 @@ "description": "Get the entity definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3698,7 +3698,7 @@ "description": "Get the enum definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3735,7 +3735,7 @@ "description": "Get the enum definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3772,7 +3772,7 @@ "description": "Get the relationship definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3809,7 +3809,7 @@ "description": "Get the relationship definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3846,7 +3846,7 @@ "description": "Get the struct definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3883,7 +3883,7 @@ "description": "Get the struct definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3920,7 +3920,7 @@ "description": "Get the type definition for the given GUID.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "guid", @@ -3957,7 +3957,7 @@ "description": "Get the type definition by its name (unique).", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -3992,7 +3992,7 @@ "description": "Delete API for type identified by its name.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "name", @@ -4142,7 +4142,7 @@ "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -4179,7 +4179,7 @@ "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -4219,7 +4219,7 @@ "description": "Delete API for all types in bulk.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "body", @@ -8450,6 +8450,16 @@ } }, "parameters": { + "AtlasApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": false, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", From 5003e33bd6fc4c99f8f826e995de6f1dadade31d Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 16:28:12 +0800 Subject: [PATCH 122/132] update api version query parameter --- .../Azure.Analytics.Purview.DataMap/routes.tsp | 17 ++++++++++++++++- .../stable/2023-09-01/purviewdatamap.json | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index bb9c4b5bcced..cbef1ff649ee 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -37,6 +37,20 @@ op AtlasOperation< ...TParams, ): TResponse | TErrorResponse; +op AtlasRpcOperation< + TParams extends TypeSpec.Reflection.Model, + TResponse extends TypeSpec.Reflection.Model, + Traits extends TypeSpec.Reflection.Model = {}, + TErrorResponse = Azure.Core.Foundations.ErrorResponse, + TraitContexts extends TraitContext = TraitContext.Undefined +> is AtlasOperation< + TParams & TraitProperties, + TResponse & TraitProperties, + Traits, + TErrorResponse +>; + + model OkResponse { @statusCode status: 200; @@ -762,10 +776,11 @@ default is false. AtlasErrorResponse >; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get - getSampleBusinessMetadataTemplate is Azure.Core.RpcOperation< + getSampleBusinessMetadataTemplate is AtlasRpcOperation< {}, { @header contentType: "application/octet-stream"; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 3de49e1f7e2f..3756528cdf66 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -493,7 +493,7 @@ ], "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" } ], "responses": { From e4b01b4549f7b651fcc4dfe2db8dbf05d307d1ef Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 16:42:26 +0800 Subject: [PATCH 123/132] update --- .../examples/2023-09-01/Type_List.json | 3 ++- .../examples/2023-09-01/Type_ListEnumDefs.json | 3 ++- .../examples/2023-09-01/Type_ListTermTemplateDefs.json | 3 ++- .../purview/Azure.Analytics.Purview.DataMap/routes.tsp | 1 - .../stable/2023-09-01/examples/Type_List.json | 3 ++- .../stable/2023-09-01/examples/Type_ListEnumDefs.json | 3 ++- .../stable/2023-09-01/examples/Type_ListTermTemplateDefs.json | 3 ++- 7 files changed, 12 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json index 4f9be7fe0434..1dd18ffe0898 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_List.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "includeTermTemplate": true + "includeTermTemplate": true, + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json index 17e836217556..99b6f55910b0 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListEnumDefs.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "ENUM" + "type": "ENUM", + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json index ef6cd055807e..c5336e63031c 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json +++ b/specification/purview/Azure.Analytics.Purview.DataMap/examples/2023-09-01/Type_ListTermTemplateDefs.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "TERM_TEMPLATE" + "type": "TERM_TEMPLATE", + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index cbef1ff649ee..921c13f0418e 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -50,7 +50,6 @@ op AtlasRpcOperation< TErrorResponse >; - model OkResponse { @statusCode status: 200; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json index 4f9be7fe0434..1dd18ffe0898 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_List.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "includeTermTemplate": true + "includeTermTemplate": true, + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json index 17e836217556..99b6f55910b0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListEnumDefs.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "ENUM" + "type": "ENUM", + "api-version": "2023-09-01" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json index ef6cd055807e..c5336e63031c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/examples/Type_ListTermTemplateDefs.json @@ -1,7 +1,8 @@ { "parameters": { "Endpoint": "{Endpoint}", - "type": "TERM_TEMPLATE" + "type": "TERM_TEMPLATE", + "api-version": "2023-09-01" }, "responses": { "200": { From e29e78113c0b55c7a6d02ec1be032fb231c878f5 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 16:53:10 +0800 Subject: [PATCH 124/132] set the body for label API to align with the GA swagger doc --- .../Azure.Analytics.Purview.DataMap/routes.tsp | 12 ++++++------ .../stable/2023-09-01/purviewdatamap.json | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 921c13f0418e..abeece0f4cde 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -816,7 +816,7 @@ default is false. @doc("set of labels to be deleted") @body - body: string[]; + body?: string[]; }, void, {}, @@ -836,7 +836,7 @@ default is false. @doc("set of labels to be set to the entity") @body - body: string[]; + body?: string[]; }, void, {}, @@ -856,7 +856,7 @@ default is false. @doc("set of labels to be added") @body - body: string[]; + body?: string[]; }, void, {}, @@ -897,7 +897,7 @@ be changed to other unique attributes) @doc("set of labels to be deleted") @body - body: string[]; + body?: string[]; }, void, {}, @@ -940,7 +940,7 @@ be changed to other unique attributes) @doc("set of labels to be set") @body - body: string[]; + body?: string[]; }, void, {}, @@ -983,7 +983,7 @@ be changed to other unique attributes) @doc("set of labels to be added") @body - body: string[]; + body?: string[]; }, void, {}, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 3756528cdf66..846f4e3424f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1118,7 +1118,7 @@ "name": "body", "in": "body", "description": "set of labels to be added", - "required": true, + "required": false, "schema": { "type": "array", "items": { @@ -1162,7 +1162,7 @@ "name": "body", "in": "body", "description": "set of labels to be set to the entity", - "required": true, + "required": false, "schema": { "type": "array", "items": { @@ -1206,7 +1206,7 @@ "name": "body", "in": "body", "description": "set of labels to be deleted", - "required": true, + "required": false, "schema": { "type": "array", "items": { @@ -1571,7 +1571,7 @@ "name": "body", "in": "body", "description": "set of labels to be added", - "required": true, + "required": false, "schema": { "type": "array", "items": { @@ -1623,7 +1623,7 @@ "name": "body", "in": "body", "description": "set of labels to be set", - "required": true, + "required": false, "schema": { "type": "array", "items": { @@ -1675,7 +1675,7 @@ "name": "body", "in": "body", "description": "set of labels to be deleted", - "required": true, + "required": false, "schema": { "type": "array", "items": { From 2fbe2cdba7ee95f7e4fd29ad1086aff4ab92b22e Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Fri, 2 Feb 2024 20:10:41 +0800 Subject: [PATCH 125/132] Update api version query parameter --- .../routes.tsp | 120 +++++++-- .../stable/2023-09-01/purviewdatamap.json | 229 +----------------- 2 files changed, 101 insertions(+), 248 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index abeece0f4cde..9395e93b7ee2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -17,12 +17,15 @@ namespace PurviewDataMap; @doc("The ApiVersion query parameter for Atlas API.") model AtlasApiVersionParameter { + @doc("The API version to use for this operation.") @query("api-version") @minLength(1) - @doc("The API version to use for this operation.") apiVersion?: string; } +alias AtlasApiVersionParameterTraits = Azure.Core.Traits.VersionParameterTrait; + +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("The operation defined for Atlas APIs") op AtlasOperation< TParams extends TypeSpec.Reflection.Model, @@ -30,13 +33,11 @@ op AtlasOperation< Traits extends TypeSpec.Reflection.Model = {}, TErrorResponse = Azure.Core.Foundations.ErrorResponse >( - ...TraitProperties< - Traits & VersionParameterTrait, - TraitLocation.ApiVersionParameter - >, + ...TraitProperties, ...TParams, ): TResponse | TErrorResponse; +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" op AtlasRpcOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, @@ -58,6 +59,7 @@ model OkResponse { data: T; } +#suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" op AtlasImportOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, @@ -126,7 +128,7 @@ need to move an entity to another collection. body: AtlasEntityWithExtInfo; }, EntityMutationResult, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; @@ -152,7 +154,7 @@ need to move an entity to another collection. ignoreRelationships?: boolean; }, AtlasEntitiesWithExtInfo, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; @@ -190,12 +192,13 @@ entities. body: AtlasEntitiesWithExtInfo; }, EntityMutationResult, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Delete a list of entities in bulk identified by their GUIDs or unique attributes. @@ -216,6 +219,7 @@ attributes. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post @@ -231,6 +235,7 @@ attributes. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get complete definition of an entity given its GUID.") @route("/atlas/v2/entity/guid/{guid}") @get @@ -254,6 +259,7 @@ attributes. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Update entity partially - create or update entity attribute identified by its GUID. @@ -284,6 +290,7 @@ Null updates are not possible. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete an entity identified by its GUID.") @route("/atlas/v2/entity/guid/{guid}") @delete @@ -299,6 +306,7 @@ Null updates are not possible. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get classification for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @get @@ -318,6 +326,7 @@ Null updates are not possible. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete a given classification from an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classification/{classificationName}") @delete @@ -337,6 +346,7 @@ Null updates are not possible. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("List classifications for a given entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @get @@ -353,6 +363,7 @@ Null updates are not possible. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Add classifications to an existing entity represented by a GUID.") @route("/atlas/v2/entity/guid/{guid}/classifications") @post @@ -373,6 +384,7 @@ Null updates are not possible. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update classifications to an existing entity represented by a guid.") @route("/atlas/v2/entity/guid/{guid}/classifications") @put @@ -392,6 +404,7 @@ Null updates are not possible. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Get complete definition of an entity given its type and unique attribute. @@ -437,6 +450,7 @@ be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: @@ -480,6 +494,7 @@ be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Delete an entity identified by its type and unique attributes. In addition to @@ -515,6 +530,7 @@ be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Delete a given classification from an entity identified by its type and unique attributes. @@ -545,6 +561,7 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Add classification to the entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @post @@ -572,6 +589,7 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update classification on an entity identified by its type and unique attributes.") @route("/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications") @put @@ -598,6 +616,7 @@ be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Set classifications on entities in bulk.") @route("/atlas/v2/entity/bulk/setClassifications") @post @@ -614,6 +633,7 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/casing-style" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Bulk API to retrieve list of entities identified by its unique attributes. In @@ -664,6 +684,7 @@ example. qualifiedName can be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get entity header given its GUID.") @route("/atlas/v2/entity/guid/{guid}/header") @get @@ -679,6 +700,7 @@ example. qualifiedName can be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Remove business metadata from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @delete @@ -699,6 +721,7 @@ example. qualifiedName can be changed to other unique attributes) >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Add business metadata to an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata") @post @@ -727,6 +750,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete business metadata attributes from an entity.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") @delete @@ -752,6 +776,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Add or update business metadata attributes.") @route("/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}") @post @@ -776,6 +801,7 @@ default is false. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the sample Template for uploading/creating bulk BusinessMetaData") @route("/atlas/v2/entity/businessmetadata/import/template") @get @@ -790,6 +816,7 @@ default is false. >; #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Upload the file for creating Business Metadata in BULK") @route("/atlas/v2/entity/businessmetadata/import") @@ -804,6 +831,7 @@ default is false. >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("Delete given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @@ -825,6 +853,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Set labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @post @@ -845,6 +874,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Add given labels to a given entity.") @route("/atlas/v2/entity/guid/{guid}/labels") @put @@ -865,6 +895,7 @@ default is false. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Delete given labels to a given entity identified by its type and unique attribute. @@ -906,6 +937,7 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Set labels to a given entity identified by its type and unique attributes. @@ -949,6 +981,7 @@ be changed to other unique attributes) #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Add given labels to a given entity identified by its type and unique attributes. @@ -1043,12 +1076,13 @@ and ignoreTermsAndCategories?: boolean; }, OkResponse, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Create a glossary.") @route("/atlas/v2/glossary") @post @@ -1069,6 +1103,7 @@ the anchor attribute when creating the Term/Category. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Create glossary category in bulk.") @route("/atlas/v2/glossary/categories") @post @@ -1084,6 +1119,7 @@ the anchor attribute when creating the Term/Category. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Create a glossary category.") @route("/atlas/v2/glossary/category") @post @@ -1104,6 +1140,7 @@ can also be defined during creation. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get specific glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryId}") @get @@ -1119,6 +1156,7 @@ can also be defined during creation. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update the given glossary category by its GUID.") @route("/atlas/v2/glossary/category/{categoryId}") @put @@ -1138,6 +1176,7 @@ can also be defined during creation. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete a glossary category.") @route("/atlas/v2/glossary/category/{categoryId}") @delete @@ -1153,6 +1192,7 @@ can also be defined during creation. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" #suppress "@azure-tools/typespec-azure-core/no-unknown" "Should use unknown to model Object" @doc(""" Update the glossary category partially. So far we only supports partial @@ -1179,6 +1219,7 @@ values for partial update. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. @@ -1209,6 +1250,7 @@ parameters are currently not being enabled and won't work even they are passed. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get all terms associated with the specific category.") @route("/atlas/v2/glossary/category/{categoryId}/terms") @get @@ -1236,6 +1278,7 @@ parameters are currently not being enabled and won't work even they are passed. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Create a glossary term.") @route("/atlas/v2/glossary/term") @post @@ -1269,7 +1312,7 @@ Optionally it can be categorized as well. termId: string; }, AtlasGlossaryTerm, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; @@ -1292,11 +1335,12 @@ Optionally it can be categorized as well. body: AtlasGlossaryTerm; }, AtlasGlossaryTerm, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete a glossary term.") @route("/atlas/v2/glossary/term/{termId}") @delete @@ -1337,7 +1381,7 @@ values to be updated. body: Record; }, AtlasGlossaryTerm, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; @@ -1357,11 +1401,12 @@ values to be updated. body: AtlasGlossaryTerm[]; }, OkResponse, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result. @@ -1393,6 +1438,7 @@ limit/offset to get pagination result. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. @@ -1420,6 +1466,7 @@ is an alternative to assign a term to multiple entities. #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete the term assignment for the given list of related objects.") @route("/atlas/v2/glossary/terms/{termId}/assignedEntities") @delete @@ -1464,11 +1511,12 @@ parameters are currently not being enabled and won't work even they are passed. sort?: string; }, OkResponse>, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get a specific Glossary by its GUID.") @route("/atlas/v2/glossary/{glossaryId}") @get @@ -1502,11 +1550,12 @@ parameters are currently not being enabled and won't work even they are passed. body: AtlasGlossary; }, AtlasGlossary, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories. @@ -1525,6 +1574,7 @@ separate delete terms and categories. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result. @@ -1555,6 +1605,7 @@ limit/offset to get pagination result. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. @@ -1604,7 +1655,7 @@ GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. glossaryId: string; }, AtlasGlossaryExtInfo, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; @@ -1640,7 +1691,7 @@ values. body: Record; }, AtlasGlossary, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; @@ -1670,11 +1721,12 @@ pagination result. sort?: string; }, OkResponse, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. @@ -1754,6 +1806,7 @@ interface Discovery { interface Lineage { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get lineage info of the entity specified by GUID.") @route("/atlas/v2/lineage/{guid}") @get @@ -1804,6 +1857,7 @@ interface Lineage { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Return lineage info about entity. @@ -1853,6 +1907,7 @@ be changed to other unique attributes) interface Relationship { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post @@ -1871,6 +1926,7 @@ be created. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put @@ -1889,6 +1945,7 @@ be created. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get relationship information between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @get @@ -1908,6 +1965,7 @@ be created. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete a relationship between entities by its GUID.") @route("/atlas/v2/relationship/guid/{guid}") @delete @@ -1925,6 +1983,7 @@ be created. interface Type { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the businessMetadata definition for the given guid.") @route("/atlas/v2/types/businessmetadatadef/guid/{guid}") @get @@ -1940,6 +1999,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the businessMetadata definition by it's name (unique).") @route("/atlas/v2/types/businessmetadatadef/name/{name}") @get @@ -1955,6 +2015,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the classification definition for the given GUID.") @route("/atlas/v2/types/classificationdef/guid/{guid}") @get @@ -1970,6 +2031,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the classification definition by its name (unique).") @route("/atlas/v2/types/classificationdef/name/{name}") @get @@ -1985,6 +2047,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the Entity definition for the given GUID.") @route("/atlas/v2/types/entitydef/guid/{guid}") @get @@ -2000,6 +2063,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the entity definition by its name (unique).") @route("/atlas/v2/types/entitydef/name/{name}") @get @@ -2015,6 +2079,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the enum definition for the given GUID.") @route("/atlas/v2/types/enumdef/guid/{guid}") @get @@ -2030,6 +2095,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the enum definition by its name (unique).") @route("/atlas/v2/types/enumdef/name/{name}") @get @@ -2045,6 +2111,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the relationship definition for the given GUID.") @route("/atlas/v2/types/relationshipdef/guid/{guid}") @get @@ -2060,6 +2127,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the relationship definition by its name (unique).") @route("/atlas/v2/types/relationshipdef/name/{name}") @get @@ -2075,6 +2143,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the struct definition for the given GUID.") @route("/atlas/v2/types/structdef/guid/{guid}") @get @@ -2090,6 +2159,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the struct definition by its name (unique).") @route("/atlas/v2/types/structdef/name/{name}") @get @@ -2105,6 +2175,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the type definition for the given GUID.") @route("/atlas/v2/types/typedef/guid/{guid}") @get @@ -2120,6 +2191,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Get the type definition by its name (unique).") @route("/atlas/v2/types/typedef/name/{name}") @get @@ -2135,6 +2207,7 @@ interface Type { >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete API for type identified by its name.") @route("/atlas/v2/types/typedef/name/{name}") @delete @@ -2153,7 +2226,7 @@ interface Type { @doc("List all type definitions in bulk.") @route("/atlas/v2/types/typedefs") @get - list is Azure.Core.Foundations.Operation< + list is AtlasOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -2168,11 +2241,12 @@ when search filter type=term_template type?: TypeCategory; }, AtlasTypesDef, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Create all atlas type definitions in bulk, only new definitions will be created. @@ -2192,6 +2266,7 @@ Any changes to the existing definitions will be discarded. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc(""" Update all types in bulk, changes detected in the type definitions would be persisted. @@ -2210,6 +2285,7 @@ persisted. >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" + #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete @@ -2228,7 +2304,7 @@ persisted. @doc("List all type definitions returned as a list of minimal information header.") @route("/atlas/v2/types/typedefs/headers") @get - listHeaders is Azure.Core.Foundations.Operation< + listHeaders is AtlasOperation< { @doc(""" Whether include termtemplatedef when return all typedefs. @@ -2243,7 +2319,7 @@ when search filter type=term_template type?: TypeCategory; }, OkResponse, - {}, + AtlasApiVersionParameterTraits, AtlasErrorResponse >; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 846f4e3424f3..a18fdc765144 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -271,9 +271,6 @@ "operationId": "Entity_BulkDelete", "description": "Delete a list of entities in bulk identified by their GUIDs or unique\nattributes.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "query", @@ -312,9 +309,6 @@ "operationId": "Entity_AddClassification", "description": "Associate a classification to multiple entities in bulk.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -348,9 +342,6 @@ "operationId": "Entity_BulkSetClassifications", "description": "Set classifications on entities in bulk.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -390,9 +381,6 @@ "operationId": "Entity_ListByUniqueAttributes", "description": "Bulk API to retrieve list of entities identified by its unique attributes.\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following\nformat\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE:\nThe attrName should be an unique attribute for the given entity-type.\nThe REST\nrequest would look something like this\n\nGET\n/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\n\nNote:\nat least one unique attribute must be provided.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -451,9 +439,6 @@ "multipart/form-data" ], "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "file", "in": "formData", @@ -491,11 +476,7 @@ "application/octet-stream", "application/json" ], - "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - } - ], + "parameters": [], "responses": { "200": { "description": "The request has succeeded.", @@ -522,9 +503,6 @@ "operationId": "Entity_Get", "description": "Get complete definition of an entity given its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -571,9 +549,6 @@ "operationId": "Entity_PartialUpdateAttributeByGuid", "description": "Update entity partially - create or update entity attribute identified by its\nGUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -620,9 +595,6 @@ "operationId": "Entity_Delete", "description": "Delete an entity identified by its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -657,9 +629,6 @@ "operationId": "Entity_AddOrUpdateBusinessMetadata", "description": "Add business metadata to an entity.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -710,9 +679,6 @@ "operationId": "Entity_RemoveBusinessMetadata", "description": "Remove business metadata from an entity.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -757,9 +723,6 @@ "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", "description": "Add or update business metadata attributes.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "businessMetadataName", "in": "path", @@ -806,9 +769,6 @@ "operationId": "Entity_RemoveBusinessMetadataAttributes", "description": "Delete business metadata attributes from an entity.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "businessMetadataName", "in": "path", @@ -857,9 +817,6 @@ "operationId": "Entity_GetClassification", "description": "Get classification for a given entity represented by a GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -899,9 +856,6 @@ "operationId": "Entity_RemoveClassification", "description": "Delete a given classification from an existing entity represented by a GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -940,9 +894,6 @@ "operationId": "Entity_GetClassifications", "description": "List classifications for a given entity represented by a GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -975,9 +926,6 @@ "operationId": "Entity_UpdateClassifications", "description": "Update classifications to an existing entity represented by a guid.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -1020,9 +968,6 @@ "operationId": "Entity_AddClassifications", "description": "Add classifications to an existing entity represented by a GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -1067,9 +1012,6 @@ "operationId": "Entity_GetHeader", "description": "Get entity header given its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -1104,9 +1046,6 @@ "operationId": "Entity_AddLabel", "description": "Add given labels to a given entity.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -1148,9 +1087,6 @@ "operationId": "Entity_SetLabels", "description": "Set labels to a given entity.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -1192,9 +1128,6 @@ "operationId": "Entity_RemoveLabels", "description": "Delete given labels to a given entity.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -1238,9 +1171,6 @@ "operationId": "Entity_GetByUniqueAttributes", "description": "Get complete definition of an entity given its type and unique attribute.\n\nIn\naddition to the typeName path parameter, attribute key-value pair(s) can be\nprovided in the following format:\nattr:\\=.\n\nNOTE: The\nattrName and attrValue should be unique across entities, eg.\nqualifiedName.\n\nThe REST request would look something like this:\nGET\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1295,9 +1225,6 @@ "operationId": "Entity_PartialUpdateByUniqueAttributes", "description": "Update entity partially - Allow a subset of attributes to be updated on an\nentity which is identified by its type and unique attribute eg:\nReferenceable.qualifiedName. Null updates are not possible.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\n\nattr:=.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nPUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1347,9 +1274,6 @@ "operationId": "Entity_DeleteByUniqueAttribute", "description": "Delete an entity identified by its type and unique attributes.\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format:\nattr:\\=\\.\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this:\nDELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1392,9 +1316,6 @@ "operationId": "Entity_RemoveClassificationByUniqueAttribute", "description": "Delete a given classification from an entity identified by its type and unique\nattributes.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1441,9 +1362,6 @@ "operationId": "Entity_UpdateClassificationsByUniqueAttribute", "description": "Update classification on an entity identified by its type and unique attributes.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1494,9 +1412,6 @@ "operationId": "Entity_AddClassificationsByUniqueAttribute", "description": "Add classification to the entity identified by its type and unique attributes.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1549,9 +1464,6 @@ "operationId": "Entity_AddLabelsByUniqueAttribute", "description": "Add given labels to a given entity identified by its type and unique\nattributes.\n\nIf labels is null/empty, no labels will be added.\n\nIn addition to\nthe typeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: PUT\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1601,9 +1513,6 @@ "operationId": "Entity_SetLabelsByUniqueAttribute", "description": "Set labels to a given entity identified by its type and unique attributes.\n\nIf\nlabels is null/empty, existing labels will all be removed.\n\nIn addition to the\ntypeName path parameter, attribute key-value pair(s) can be provided in the\nfollowing format: attr:=.\n\nNOTE: The attrName and\nattrValue should be unique across entities, eg. qualifiedName.\n\nThe REST\nrequest would look something like this: POST\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1653,9 +1562,6 @@ "operationId": "Entity_RemoveLabelsByUniqueAttribute", "description": "Delete given labels to a given entity identified by its type and unique\nattribute.\n\nIf labels is null/empty, no labels will be removed.\n\nIf any labels\nin labels set are non-existing labels, they will be ignored, only existing\nlabels will be removed. In addition to the typeName path parameter, attribute\nkey-value pair(s) can be provided in the following format:\nattr:=. NOTE: The attrName and attrValue should be unique\nacross entities, eg. qualifiedName. The REST request would look something like\nthis: DELETE\n/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -1769,9 +1675,6 @@ "operationId": "Glossary_Create", "description": "Create a glossary.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -1808,9 +1711,6 @@ "operationId": "Glossary_Get", "description": "Get a specific Glossary by its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "glossaryId", "in": "path", @@ -1894,9 +1794,6 @@ "operationId": "Glossary_Delete", "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend\nseparate delete terms and categories.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "glossaryId", "in": "path", @@ -1928,9 +1825,6 @@ "operationId": "Glossary_ListCategories", "description": "Get the categories belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "glossaryId", "in": "path", @@ -1992,9 +1886,6 @@ "operationId": "Glossary_ListCategoriesHeaders", "description": "Get the category headers belonging to a specific glossary. Recommend using\nlimit/offset to get pagination result.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "glossaryId", "in": "path", @@ -2213,9 +2104,6 @@ "operationId": "Glossary_ListTermHeaders", "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset\nto get pagination result.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "glossaryId", "in": "path", @@ -2277,9 +2165,6 @@ "operationId": "Glossary_CreateCategories", "description": "Create glossary category in bulk.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -2324,9 +2209,6 @@ "operationId": "Glossary_CreateCategory", "description": "Create a glossary category.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -2363,9 +2245,6 @@ "operationId": "Glossary_GetCategory", "description": "Get specific glossary category by its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "categoryId", "in": "path", @@ -2398,9 +2277,6 @@ "operationId": "Glossary_UpdateCategory", "description": "Update the given glossary category by its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "categoryId", "in": "path", @@ -2442,9 +2318,6 @@ "operationId": "Glossary_DeleteCategory", "description": "Delete a glossary category.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "categoryId", "in": "path", @@ -2476,9 +2349,6 @@ "operationId": "Glossary_PartialUpdateCategory", "description": "Update the glossary category partially. So far we only supports partial\nupdating shortDescription and longDescription for category.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "categoryId", "in": "path", @@ -2525,9 +2395,6 @@ "operationId": "Glossary_ListRelatedCategories", "description": "Get all related categories (parent and children). Limit, offset, and sort\nparameters are currently not being enabled and won't work even they are passed.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "categoryId", "in": "path", @@ -2592,9 +2459,6 @@ "operationId": "Glossary_ListCategoryTerms", "description": "Get all terms associated with the specific category.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "categoryId", "in": "path", @@ -2656,9 +2520,6 @@ "operationId": "Glossary_CreateTerm", "description": "Create a glossary term.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "includeTermHierarchy", "in": "query", @@ -2794,9 +2655,6 @@ "operationId": "Glossary_DeleteTerm", "description": "Delete a glossary term.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "termId", "in": "path", @@ -2938,9 +2796,6 @@ "operationId": "Glossary_ListEntitiesAssignedWithTerm", "description": "List all related objects assigned with the specified term. Recommend using\nlimit/offset to get pagination result.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "termId", "in": "path", @@ -3000,9 +2855,6 @@ "operationId": "Glossary_AssignTermToEntities", "description": "Assign the given term to the provided list of related objects. Recommend using\nsmall batches with multiple API calls.\n\n[Entities Create Or Update\noperation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP)\nis an alternative to assign a term to multiple entities.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "termId", "in": "path", @@ -3045,9 +2897,6 @@ "operationId": "Glossary_DeleteTermAssignmentFromEntities", "description": "Delete the term assignment for the given list of related objects.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "termId", "in": "path", @@ -3159,9 +3008,6 @@ "operationId": "Lineage_Get", "description": "Get lineage info of the entity specified by GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3237,9 +3083,6 @@ "operationId": "Lineage_GetByUniqueAttribute", "description": "Return lineage info about entity.\n\nIn addition to the typeName path parameter,\nattribute key-value pair(s) can be provided in the following\nformat\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be\nunique across entities, eg. qualifiedName.\n\nThe REST request would look\nsomething like this:\n\nGET\n/v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "typeName", "in": "path", @@ -3323,9 +3166,6 @@ "operationId": "Relationship_Update", "description": "Update an existing relationship between entities.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -3360,9 +3200,6 @@ "operationId": "Relationship_Create", "description": "Create a new relationship between entities.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -3399,9 +3236,6 @@ "operationId": "Relationship_Get", "description": "Get relationship information between entities by its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3441,9 +3275,6 @@ "operationId": "Relationship_Delete", "description": "Delete a relationship between entities by its GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3475,9 +3306,6 @@ "operationId": "Type_GetBusinessMetadataDefByGuid", "description": "Get the businessMetadata definition for the given guid.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3512,9 +3340,6 @@ "operationId": "Type_GetBusinessMetadataDefByName", "description": "Get the businessMetadata definition by it's name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3549,9 +3374,6 @@ "operationId": "Type_GetClassificationDefByGuid", "description": "Get the classification definition for the given GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3586,9 +3408,6 @@ "operationId": "Type_GetClassificationDefByName", "description": "Get the classification definition by its name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3623,9 +3442,6 @@ "operationId": "Type_GetEntityDefByGuid", "description": "Get the Entity definition for the given GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3660,9 +3476,6 @@ "operationId": "Type_GetEntityDefByName", "description": "Get the entity definition by its name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3697,9 +3510,6 @@ "operationId": "Type_GetEnumDefByGuid", "description": "Get the enum definition for the given GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3734,9 +3544,6 @@ "operationId": "Type_GetEnumDefByName", "description": "Get the enum definition by its name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3771,9 +3578,6 @@ "operationId": "Type_GetRelationshipDefByGuid", "description": "Get the relationship definition for the given GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3808,9 +3612,6 @@ "operationId": "Type_GetRelationshipDefByName", "description": "Get the relationship definition by its name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3845,9 +3646,6 @@ "operationId": "Type_GetStructDefByGuid", "description": "Get the struct definition for the given GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3882,9 +3680,6 @@ "operationId": "Type_GetStructDefByName", "description": "Get the struct definition by its name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3919,9 +3714,6 @@ "operationId": "Type_GetByGuid", "description": "Get the type definition for the given GUID.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "guid", "in": "path", @@ -3956,9 +3748,6 @@ "operationId": "Type_GetByName", "description": "Get the type definition by its name (unique).", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -3991,9 +3780,6 @@ "operationId": "Type_Delete", "description": "Delete API for type identified by its name.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "name", "in": "path", @@ -4026,7 +3812,7 @@ "description": "List all type definitions in bulk.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "includeTermTemplate", @@ -4141,9 +3927,6 @@ "operationId": "Type_BulkUpdate", "description": "Update all types in bulk, changes detected in the type definitions would be\npersisted.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -4178,9 +3961,6 @@ "operationId": "Type_BulkCreate", "description": "Create all atlas type definitions in bulk, only new definitions will be\ncreated.\nAny changes to the existing definitions will be discarded.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -4218,9 +3998,6 @@ "operationId": "Type_BulkDelete", "description": "Delete API for all types in bulk.", "parameters": [ - { - "$ref": "#/parameters/AtlasApiVersionParameter" - }, { "name": "body", "in": "body", @@ -4255,7 +4032,7 @@ "description": "List all type definitions returned as a list of minimal information header.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + "$ref": "#/parameters/AtlasApiVersionParameter" }, { "name": "includeTermTemplate", From 18652fe783c395ad45d3acd4cab156a9e1ee6066 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Sun, 4 Feb 2024 10:34:33 +0800 Subject: [PATCH 126/132] update for comments --- .../client.tsp | 9 - .../Azure.Analytics.Purview.DataMap/main.tsp | 16 +- .../models.tsp | 10 +- .../routes.tsp | 422 +++++------------- .../stable/2023-09-01/purviewdatamap.json | 24 +- 5 files changed, 126 insertions(+), 355 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp index cddbf9ffb582..15a65848cd57 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/client.tsp @@ -11,26 +11,17 @@ using PurviewDataMap; }) namespace Customizations; -@@access(MoveEntitiesOptions, Access.public); @@projectedName(MoveEntitiesOptions, "csharp", "MoveEntitiesConfig"); -@@access(DateFormat, Access.public); @@projectedName(DateFormat, "csharp", "AtlasDateFormat"); -@@access(NumberFormat, Access.public); @@projectedName(NumberFormat, "csharp", "AtlasNumberFormat"); -@@access(TimeZone, Access.public); @@projectedName(TimeZone, "csharp", "AtlasTimeZone"); -@@access(SortType, Access.public); @@projectedName(SortType, "csharp", "AtlasSortType"); -@@access(ClassificationAssociateOptions, Access.public); @@projectedName(ClassificationAssociateOptions, "csharp", "ClassificationAssociateConfig" ); -@@access(QueryOptions, Access.public); @@projectedName(QueryOptions, "csharp", "QueryConfig"); -@@access(SuggestOptions, Access.public); @@projectedName(SuggestOptions, "csharp", "SuggestConfig"); -@@access(AutoCompleteOptions, Access.public); @@projectedName(AutoCompleteOptions, "csharp", "AutoCompleteConfig"); #suppress "@azure-tools/typespec-azure-core/use-standard-operations" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index 46cd30d5611a..67657574ea86 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -33,12 +33,10 @@ enum ApiVersions { v2023_09_01: "2023-09-01", } -@doc("The Azure Active Directory OAuth2 Flow") -model AuthToken - is OAuth2Auth<[ - { - type: OAuth2FlowType.implicit; - authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; - scopes: ["https://purview.azure.net/.default"]; - } - ]>; +alias AuthToken = OAuth2Auth<[ + { + type: OAuth2FlowType.implicit; + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; + scopes: ["https://purview.azure.net/.default"]; + } +]>; diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index ab28755f2efb..cd5e6c21a703 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -672,11 +672,10 @@ model AtlasGlossaryBaseObject { updatedBy?: string; } -@doc("The base model object.") -model AtlasBaseModelObject { +alias AtlasBaseModelObject = { @doc("The GUID of the object.") guid?: string; -} +}; @doc("The glossary category.") model AtlasGlossaryCategory { @@ -1500,8 +1499,7 @@ model AtlasConstraintDef { type?: string; } -@doc("Base class that captures common-attributes for all types.") -model AtlasBaseTypeDef { +alias AtlasBaseTypeDef = { @doc("The enum of type category.") category?: TypeCategory; @@ -1546,7 +1544,7 @@ model AtlasBaseTypeDef { #suppress "@azure-tools/typespec-azure-core/casing-style" "It is an Atlas model" @doc("ETag for concurrency control.") lastModifiedTS?: string; -} +}; @doc("The date format.") model DateFormat { diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index 9395e93b7ee2..ac11f2db22a2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -1,5 +1,4 @@ import "@azure-tools/typespec-azure-core"; -import "@azure-tools/typespec-client-generator-core"; import "@typespec/http"; import "@typespec/versioning"; import "@typespec/rest"; @@ -11,7 +10,6 @@ using TypeSpec.Versioning; using Azure.Core; using Azure.Core.Traits; using Azure.Core.Traits.Private; -using Azure.ClientGenerator.Core; namespace PurviewDataMap; @@ -30,34 +28,31 @@ alias AtlasApiVersionParameterTraits = Azure.Core.Traits.VersionParameterTrait( ...TraitProperties, ...TParams, -): TResponse | TErrorResponse; +): TResponse | AtlasErrorResponse; #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" op AtlasRpcOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, Traits extends TypeSpec.Reflection.Model = {}, - TErrorResponse = Azure.Core.Foundations.ErrorResponse, TraitContexts extends TraitContext = TraitContext.Undefined > is AtlasOperation< TParams & TraitProperties, TResponse & TraitProperties, - Traits, - TErrorResponse + Traits >; -model OkResponse { +alias OkResponse = { @statusCode status: 200; @body data: T; -} +}; #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" op AtlasImportOperation< @@ -84,8 +79,7 @@ op AtlasImportOperation< TraitLocation.Response, TraitContext.Action >, - Traits, - AtlasErrorResponse + Traits >; alias MultipartFormDataRequestHeadersTraits = Azure.Core.Traits.RequestHeadersTrait<{ @@ -122,14 +116,9 @@ need to move an entity to another collection. """) @query collectionId?: string; - - @doc("Atlas entity with extended information.") - @body - body: AtlasEntityWithExtInfo; - }, + } & AtlasEntityWithExtInfo, EntityMutationResult, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -154,8 +143,7 @@ need to move an entity to another collection. ignoreRelationships?: boolean; }, AtlasEntitiesWithExtInfo, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -186,14 +174,9 @@ entities. """) @query businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; - - @doc("An array of entities to create or update.") - @body - body: AtlasEntitiesWithExtInfo; - }, + } & AtlasEntitiesWithExtInfo, EntityMutationResult, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/prefer-csv-collection-format" "This is an existing Atlas API" @@ -214,8 +197,7 @@ attributes. guid: string[]; }, EntityMutationResult, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -223,16 +205,7 @@ attributes. @doc("Associate a classification to multiple entities in bulk.") @route("/atlas/v2/entity/bulk/classification") @post - addClassification is AtlasOperation< - { - @doc("The request to associate a classification to multiple entities.") - @body - body: ClassificationAssociateOptions; - }, - void, - {}, - AtlasErrorResponse - >; + addClassification is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -254,8 +227,7 @@ attributes. ignoreRelationships?: boolean; }, AtlasEntityWithExtInfo, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -285,8 +257,7 @@ Null updates are not possible. body: unknown; }, EntityMutationResult, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -301,8 +272,7 @@ Null updates are not possible. guid: string; }, EntityMutationResult, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -321,8 +291,7 @@ Null updates are not possible. classificationName: string; }, AtlasClassification, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -341,8 +310,7 @@ Null updates are not possible. classificationName: string; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -357,8 +325,7 @@ Null updates are not possible. guid: string; }, AtlasClassifications, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -378,8 +345,7 @@ Null updates are not possible. body: AtlasClassification[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -399,8 +365,7 @@ Null updates are not possible. body: AtlasClassification[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -445,8 +410,7 @@ be changed to other unique attributes) attribute?: string; }, AtlasEntityWithExtInfo, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -483,14 +447,9 @@ be changed to other unique attributes) """) @query("attr:qualifiedName") attribute?: string; - - @doc("Atlas entity with extended information.") - @body - body: AtlasEntityWithExtInfo; - }, + } & AtlasEntityWithExtInfo, EntityMutationResult, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -525,8 +484,7 @@ be changed to other unique attributes) attribute?: string; }, EntityMutationResult, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -555,8 +513,7 @@ be changed to other unique attributes) attribute?: string; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -583,8 +540,7 @@ be changed to other unique attributes) body: AtlasClassification[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -611,8 +567,7 @@ be changed to other unique attributes) body: AtlasClassification[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -621,14 +576,9 @@ be changed to other unique attributes) @route("/atlas/v2/entity/bulk/setClassifications") @post bulkSetClassifications is AtlasOperation< - { - @doc("Atlas entity headers.") - @body - body: AtlasEntityHeaders; - }, + AtlasEntityHeaders, OkResponse, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -679,8 +629,7 @@ example. qualifiedName can be changed to other unique attributes) `attr_N:qualifiedName`?: string; }, AtlasEntitiesWithExtInfo, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -695,8 +644,7 @@ example. qualifiedName can be changed to other unique attributes) guid: string; }, AtlasEntityHeader, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -716,8 +664,7 @@ example. qualifiedName can be changed to other unique attributes) body: Record>; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -744,8 +691,7 @@ default is false. body: Record>; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/bad-record-type" "Should use unknown to model Object" @@ -770,8 +716,7 @@ default is false. body: Record; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an Atlas existing api" @@ -796,8 +741,7 @@ default is false. body: Record; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -811,8 +755,7 @@ default is false. @header contentType: "application/octet-stream"; @body body: bytes; }, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" @@ -847,8 +790,7 @@ default is false. body?: string[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -868,8 +810,7 @@ default is false. body?: string[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -889,8 +830,7 @@ default is false. body?: string[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -931,8 +871,7 @@ be changed to other unique attributes) body?: string[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -975,8 +914,7 @@ be changed to other unique attributes) body?: string[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1019,8 +957,7 @@ be changed to other unique attributes) body?: string[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -1033,10 +970,7 @@ be changed to other unique attributes) @query collectionId: string; - @doc("Entity guids to be moved to target collection.") - @body - body: MoveEntitiesOptions; - }, + } & MoveEntitiesOptions, EntityMutationResult, {}, AtlasErrorResponse @@ -1076,8 +1010,7 @@ and ignoreTermsAndCategories?: boolean; }, OkResponse, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1087,18 +1020,9 @@ and @route("/atlas/v2/glossary") @post create is AtlasOperation< - { - @doc(""" -Glossary definition, terms & categories can be anchored to a glossary. -Using -the anchor attribute when creating the Term/Category. -""") - @body - body: AtlasGlossary; - }, AtlasGlossary, - {}, - AtlasErrorResponse + AtlasGlossary, + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1114,8 +1038,7 @@ the anchor attribute when creating the Term/Category. body: AtlasGlossaryCategory[]; }, OkResponse, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1124,19 +1047,9 @@ the anchor attribute when creating the Term/Category. @route("/atlas/v2/glossary/category") @post createCategory is AtlasOperation< - { - @doc(""" -The glossary category definition. A category must be anchored to a Glossary -when creating. -Optionally, terms belonging to the category and the hierarchy -can also be defined during creation. -""") - @body - body: AtlasGlossaryCategory; - }, AtlasGlossaryCategory, - {}, - AtlasErrorResponse + AtlasGlossaryCategory, + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1151,8 +1064,7 @@ can also be defined during creation. categoryId: string; }, AtlasGlossaryCategory, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1166,13 +1078,9 @@ can also be defined during creation. @path categoryId: string; - @doc("The glossary category to be updated.") - @body - body: AtlasGlossaryCategory; - }, + } & AtlasGlossaryCategory, AtlasGlossaryCategory, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1187,8 +1095,7 @@ can also be defined during creation. categoryId: string; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1214,8 +1121,7 @@ values for partial update. body: Record; }, AtlasGlossaryCategory, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1245,8 +1151,7 @@ parameters are currently not being enabled and won't work even they are passed. sort?: string; }, OkResponse>, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1273,8 +1178,7 @@ parameters are currently not being enabled and won't work even they are passed. sort?: string; }, OkResponse, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1287,18 +1191,9 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Whether include term hierarchy") @query includeTermHierarchy?: boolean; - - @doc(""" -The glossary term definition. A term must be anchored to a Glossary at the time -of creation. -Optionally it can be categorized as well. -""") - @body - body: AtlasGlossaryTerm; - }, + } & AtlasGlossaryTerm, AtlasGlossaryTerm, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1312,8 +1207,7 @@ Optionally it can be categorized as well. termId: string; }, AtlasGlossaryTerm, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1329,14 +1223,9 @@ Optionally it can be categorized as well. @doc("Whether include term hierarchy") @query includeTermHierarchy?: boolean; - - @doc("The glossary term to be updated.") - @body - body: AtlasGlossaryTerm; - }, + } & AtlasGlossaryTerm, AtlasGlossaryTerm, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1351,8 +1240,7 @@ Optionally it can be categorized as well. termId: string; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1381,8 +1269,7 @@ values to be updated. body: Record; }, AtlasGlossaryTerm, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1401,8 +1288,7 @@ values to be updated. body: AtlasGlossaryTerm[]; }, OkResponse, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1432,8 +1318,7 @@ limit/offset to get pagination result. sort?: string; }, OkResponse, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1460,8 +1345,7 @@ is an alternative to assign a term to multiple entities. body: AtlasRelatedObjectId[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" @@ -1481,8 +1365,7 @@ is an alternative to assign a term to multiple entities. body: AtlasRelatedObjectId[]; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1511,8 +1394,7 @@ parameters are currently not being enabled and won't work even they are passed. sort?: string; }, OkResponse>, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1527,8 +1409,7 @@ parameters are currently not being enabled and won't work even they are passed. glossaryId: string; }, AtlasGlossary, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1544,14 +1425,9 @@ parameters are currently not being enabled and won't work even they are passed. @doc("Whether ignore terms and categories") @query ignoreTermsAndCategories?: boolean; - - @doc("The glossary definition to be updated.") - @body - body: AtlasGlossary; - }, + } & AtlasGlossary, AtlasGlossary, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1569,8 +1445,7 @@ separate delete terms and categories. glossaryId: string; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1600,8 +1475,7 @@ limit/offset to get pagination result. sort?: string; }, OkResponse, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1631,8 +1505,7 @@ limit/offset to get pagination result. sort?: string; }, OkResponse, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1655,8 +1528,7 @@ GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories. glossaryId: string; }, AtlasGlossaryExtInfo, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1691,8 +1563,7 @@ values. body: Record; }, AtlasGlossary, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1721,8 +1592,7 @@ pagination result. sort?: string; }, OkResponse, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1752,8 +1622,7 @@ to get pagination result. sort?: string; }, OkResponse, - {}, - AtlasErrorResponse + {} >; } @@ -1763,11 +1632,7 @@ interface Discovery { @route("/search/query") @post query is Azure.Core.Foundations.Operation< - { - @doc("An object specifying the search criteria.") - @body - body: QueryOptions; - }, + QueryOptions, QueryResult, {}, AtlasErrorResponse @@ -1778,11 +1643,7 @@ interface Discovery { @route("/search/suggest") @post suggest is Azure.Core.Foundations.Operation< - { - @doc("An object specifying the suggest criteria.") - @body - body: SuggestOptions; - }, + SuggestOptions, SuggestResult, {}, AtlasErrorResponse @@ -1793,11 +1654,7 @@ interface Discovery { @route("/search/autocomplete") @post autoComplete is Azure.Core.Foundations.Operation< - { - @doc("An object specifying the autocomplete criteria.") - @body - body: AutoCompleteOptions; - }, + AutoCompleteOptions, AutoCompleteResult, {}, AtlasErrorResponse @@ -1824,9 +1681,7 @@ interface Lineage { @query direction: LineageDirection; }, - AtlasLineageInfo, - {}, - AtlasErrorResponse + AtlasLineageInfo >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" @@ -1900,8 +1755,7 @@ be changed to other unique attributes) attribute?: string; }, AtlasLineageInfo, - {}, - AtlasErrorResponse + {} >; } @@ -1912,17 +1766,9 @@ interface Relationship { @route("/atlas/v2/relationship") @post create is AtlasOperation< - { - @doc(""" -The AtlasRelationship object containing the information for the relationship to -be created. -""") - @body - body: AtlasRelationship; - }, AtlasRelationship, - {}, - AtlasErrorResponse + AtlasRelationship, + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1931,17 +1777,9 @@ be created. @route("/atlas/v2/relationship") @put update is AtlasOperation< - { - @doc(""" -The AtlasRelationship object containing the information for the relationship to -be created. -""") - @body - body: AtlasRelationship; - }, AtlasRelationship, - {}, - AtlasErrorResponse + AtlasRelationship, + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1960,8 +1798,7 @@ be created. extendedInfo?: boolean; }, AtlasRelationshipWithExtInfo, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1976,8 +1813,7 @@ be created. guid: string; }, void, - {}, - AtlasErrorResponse + {} >; } @@ -1994,8 +1830,7 @@ interface Type { guid: string; }, AtlasBusinessMetadataDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2010,8 +1845,7 @@ interface Type { name: string; }, AtlasBusinessMetadataDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2026,8 +1860,7 @@ interface Type { guid: string; }, AtlasClassificationDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2042,8 +1875,7 @@ interface Type { name: string; }, AtlasClassificationDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2058,8 +1890,7 @@ interface Type { guid: string; }, AtlasEntityDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2074,8 +1905,7 @@ interface Type { name: string; }, AtlasEntityDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2090,8 +1920,7 @@ interface Type { guid: string; }, AtlasEnumDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2106,8 +1935,7 @@ interface Type { name: string; }, AtlasEnumDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2122,8 +1950,7 @@ interface Type { guid: string; }, AtlasRelationshipDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2138,8 +1965,7 @@ interface Type { name: string; }, AtlasRelationshipDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2154,8 +1980,7 @@ interface Type { guid: string; }, AtlasStructDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2170,8 +1995,7 @@ interface Type { name: string; }, AtlasStructDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2186,8 +2010,7 @@ interface Type { guid: string; }, AtlasTypeDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2202,8 +2025,7 @@ interface Type { name: string; }, AtlasTypeDef, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2218,8 +2040,7 @@ interface Type { name: string; }, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2241,8 +2062,7 @@ when search filter type=term_template type?: TypeCategory; }, AtlasTypesDef, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2255,14 +2075,9 @@ Any changes to the existing definitions will be discarded. @route("/atlas/v2/types/typedefs") @post bulkCreate is AtlasOperation< - { - @doc("A composite wrapper object with corresponding lists of the type definition.") - @body - body: AtlasTypesDef; - }, AtlasTypesDef, - {}, - AtlasErrorResponse + AtlasTypesDef, + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2274,14 +2089,9 @@ persisted. @route("/atlas/v2/types/typedefs") @put bulkUpdate is AtlasOperation< - { - @doc("A composite object that captures all type definition changes.") - @body - body: AtlasTypesDef; - }, AtlasTypesDef, - {}, - AtlasErrorResponse + AtlasTypesDef, + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2290,14 +2100,9 @@ persisted. @route("/atlas/v2/types/typedefs") @delete bulkDelete is AtlasOperation< - { - @doc("A composite object that captures all types to be deleted") - @body - body: AtlasTypesDef; - }, + AtlasTypesDef, void, - {}, - AtlasErrorResponse + {} >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -2319,8 +2124,7 @@ when search filter type=term_template type?: TypeCategory; }, OkResponse, - AtlasApiVersionParameterTraits, - AtlasErrorResponse + AtlasApiVersionParameterTraits >; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing API" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index a18fdc765144..69a676cfb035 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -33,15 +33,14 @@ ], "security": [ { - "AuthToken": [ + "OAuth2Auth": [ "https://purview.azure.net/.default" ] } ], "securityDefinitions": { - "AuthToken": { + "OAuth2Auth": { "type": "oauth2", - "description": "The Azure Active Directory OAuth2 Flow", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { @@ -102,7 +101,6 @@ { "name": "body", "in": "body", - "description": "Atlas entity with extended information.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" @@ -240,7 +238,6 @@ { "name": "body", "in": "body", - "description": "An array of entities to create or update.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntitiesWithExtInfo" @@ -312,7 +309,6 @@ { "name": "body", "in": "body", - "description": "The request to associate a classification to multiple entities.", "required": true, "schema": { "$ref": "#/definitions/ClassificationAssociateOptions" @@ -345,7 +341,6 @@ { "name": "body", "in": "body", - "description": "Atlas entity headers.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityHeaders" @@ -1243,7 +1238,6 @@ { "name": "body", "in": "body", - "description": "Atlas entity with extended information.", "required": true, "schema": { "$ref": "#/definitions/AtlasEntityWithExtInfo" @@ -1763,7 +1757,6 @@ { "name": "body", "in": "body", - "description": "The glossary definition to be updated.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" @@ -2212,7 +2205,6 @@ { "name": "body", "in": "body", - "description": "The glossary category definition. A category must be anchored to a Glossary\nwhen creating.\nOptionally, terms belonging to the category and the hierarchy\ncan also be defined during creation.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryCategory" @@ -2287,7 +2279,6 @@ { "name": "body", "in": "body", - "description": "The glossary category to be updated.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryCategory" @@ -2530,7 +2521,6 @@ { "name": "body", "in": "body", - "description": "The glossary term definition. A term must be anchored to a Glossary at the time\nof creation.\nOptionally it can be categorized as well.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryTerm" @@ -2624,7 +2614,6 @@ { "name": "body", "in": "body", - "description": "The glossary term to be updated.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossaryTerm" @@ -3169,7 +3158,6 @@ { "name": "body", "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", "required": true, "schema": { "$ref": "#/definitions/AtlasRelationship" @@ -3203,7 +3191,6 @@ { "name": "body", "in": "body", - "description": "The AtlasRelationship object containing the information for the relationship to\nbe created.", "required": true, "schema": { "$ref": "#/definitions/AtlasRelationship" @@ -3930,7 +3917,6 @@ { "name": "body", "in": "body", - "description": "A composite object that captures all type definition changes.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -3964,7 +3950,6 @@ { "name": "body", "in": "body", - "description": "A composite wrapper object with corresponding lists of the type definition.", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -4001,7 +3986,6 @@ { "name": "body", "in": "body", - "description": "A composite object that captures all types to be deleted", "required": true, "schema": { "$ref": "#/definitions/AtlasTypesDef" @@ -4160,7 +4144,6 @@ { "name": "body", "in": "body", - "description": "Entity guids to be moved to target collection.", "required": true, "schema": { "$ref": "#/definitions/MoveEntitiesOptions" @@ -4285,7 +4268,6 @@ { "name": "body", "in": "body", - "description": "An object specifying the autocomplete criteria.", "required": true, "schema": { "$ref": "#/definitions/AutoCompleteOptions" @@ -4324,7 +4306,6 @@ { "name": "body", "in": "body", - "description": "An object specifying the search criteria.", "required": true, "schema": { "$ref": "#/definitions/QueryOptions" @@ -4423,7 +4404,6 @@ { "name": "body", "in": "body", - "description": "An object specifying the suggest criteria.", "required": true, "schema": { "$ref": "#/definitions/SuggestOptions" From 20bbcbc76eec0e6d69032ae351c0d6294030e335 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Sun, 4 Feb 2024 10:39:06 +0800 Subject: [PATCH 127/132] update --- .../stable/2023-09-01/purviewdatamap.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 69a676cfb035..7d309fe8ab9e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -1672,7 +1672,6 @@ { "name": "body", "in": "body", - "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing\nthe anchor attribute when creating the Term/Category.", "required": true, "schema": { "$ref": "#/definitions/AtlasGlossary" From 16126a44beb514a5dce5b1d99d2940dea0288293 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Sun, 4 Feb 2024 10:51:16 +0800 Subject: [PATCH 128/132] Update routes.tsp --- .../routes.tsp | 38 +++---------------- 1 file changed, 6 insertions(+), 32 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp index ac11f2db22a2..bc4f05fe69c8 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/routes.tsp @@ -969,7 +969,6 @@ be changed to other unique attributes) @doc("The collection where entities will be moved to.") @query collectionId: string; - } & MoveEntitiesOptions, EntityMutationResult, {}, @@ -1019,11 +1018,7 @@ and @doc("Create a glossary.") @route("/atlas/v2/glossary") @post - create is AtlasOperation< - AtlasGlossary, - AtlasGlossary, - {} - >; + create is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/request-body-problem" "This is Atlas API behavior" #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @@ -1077,7 +1072,6 @@ and @doc("The globally unique identifier of the category.") @path categoryId: string; - } & AtlasGlossaryCategory, AtlasGlossaryCategory, {} @@ -1765,22 +1759,14 @@ interface Relationship { @doc("Create a new relationship between entities.") @route("/atlas/v2/relationship") @post - create is AtlasOperation< - AtlasRelationship, - AtlasRelationship, - {} - >; + create is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Update an existing relationship between entities.") @route("/atlas/v2/relationship") @put - update is AtlasOperation< - AtlasRelationship, - AtlasRelationship, - {} - >; + update is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -2074,11 +2060,7 @@ Any changes to the existing definitions will be discarded. """) @route("/atlas/v2/types/typedefs") @post - bulkCreate is AtlasOperation< - AtlasTypesDef, - AtlasTypesDef, - {} - >; + bulkCreate is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @@ -2088,22 +2070,14 @@ persisted. """) @route("/atlas/v2/types/typedefs") @put - bulkUpdate is AtlasOperation< - AtlasTypesDef, - AtlasTypesDef, - {} - >; + bulkUpdate is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" #suppress "@azure-tools/typespec-azure-core/operation-missing-api-version" "This is Atlas API, which does not require api version" @doc("Delete API for all types in bulk.") @route("/atlas/v2/types/typedefs") @delete - bulkDelete is AtlasOperation< - AtlasTypesDef, - void, - {} - >; + bulkDelete is AtlasOperation; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is Atlas API" @doc("List all type definitions returned as a list of minimal information header.") From a9e8ec26f7d01788c8b94c582a7de0b82c00ce66 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Sun, 4 Feb 2024 17:08:40 +0800 Subject: [PATCH 129/132] update the createTime/updateTIme for an issue in csharp generator --- .../models.tsp | 36 ++++------- .../stable/2023-09-01/purviewdatamap.json | 64 +++++++++---------- 2 files changed, 44 insertions(+), 56 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index cd5e6c21a703..684b77d52357 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -269,8 +269,7 @@ model AtlasEntity { classifications?: AtlasClassification[]; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @@ -314,8 +313,7 @@ removed. status?: EntityStatus; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @@ -658,15 +656,13 @@ model AtlasGlossaryBaseObject { lastModifiedTS?: string; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @@ -1069,12 +1065,10 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: int64; @doc("The last update time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: int64; @doc("The GUID of the record.") id?: string; @@ -1231,12 +1225,10 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: int64; @doc("The last update time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: int64; @doc("The GUID of the record.") id?: string; @@ -1387,8 +1379,7 @@ model AtlasRelationship { ...AtlasStruct; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @@ -1415,8 +1406,7 @@ model AtlasRelationship { status?: StatusAtlasRelationship; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; @@ -1504,8 +1494,7 @@ alias AtlasBaseTypeDef = { category?: TypeCategory; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: int64; @doc("The user who created the record.") createdBy?: string; @@ -1532,8 +1521,7 @@ alias AtlasBaseTypeDef = { typeVersion?: string; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: int64; @doc("The user who updated the record.") updatedBy?: string; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 7d309fe8ab9e..800ef24b4921 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -4583,7 +4583,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -4623,7 +4623,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -4698,7 +4698,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -4738,7 +4738,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -4887,7 +4887,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -4953,7 +4953,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -4987,7 +4987,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5027,7 +5027,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5187,7 +5187,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5227,7 +5227,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5332,7 +5332,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5341,7 +5341,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5412,7 +5412,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5421,7 +5421,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5492,7 +5492,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5501,7 +5501,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5604,7 +5604,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5613,7 +5613,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6009,7 +6009,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6047,7 +6047,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6146,7 +6146,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6186,7 +6186,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6304,7 +6304,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6344,7 +6344,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6545,7 +6545,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6585,7 +6585,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -7608,12 +7608,12 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -7852,12 +7852,12 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -8013,7 +8013,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -8053,7 +8053,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { From 4b754528db146bfc4556a59dc1cb4f07cf22a941 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 6 Feb 2024 08:23:50 +0800 Subject: [PATCH 130/132] Revert "update the createTime/updateTIme for an issue in csharp generator" This reverts commit a9e8ec26f7d01788c8b94c582a7de0b82c00ce66. --- .../models.tsp | 36 +++++++---- .../stable/2023-09-01/purviewdatamap.json | 64 +++++++++---------- 2 files changed, 56 insertions(+), 44 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 684b77d52357..cd5e6c21a703 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -269,7 +269,8 @@ model AtlasEntity { classifications?: AtlasClassification[]; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @@ -313,7 +314,8 @@ removed. status?: EntityStatus; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; @@ -656,13 +658,15 @@ model AtlasGlossaryBaseObject { lastModifiedTS?: string; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; @@ -1065,10 +1069,12 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The last update time of the record. The Unix epoch format.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The GUID of the record.") id?: string; @@ -1225,10 +1231,12 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The last update time of the record. The Unix epoch format.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The GUID of the record.") id?: string; @@ -1379,7 +1387,8 @@ model AtlasRelationship { ...AtlasStruct; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @@ -1406,7 +1415,8 @@ model AtlasRelationship { status?: StatusAtlasRelationship; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; @@ -1494,7 +1504,8 @@ alias AtlasBaseTypeDef = { category?: TypeCategory; @doc("The created time of the record.") - createTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + createTime?: utcDateTime; @doc("The user who created the record.") createdBy?: string; @@ -1521,7 +1532,8 @@ alias AtlasBaseTypeDef = { typeVersion?: string; @doc("The update time of the record.") - updateTime?: int64; + @encode(DateTimeKnownEncoding.unixTimestamp, int64) + updateTime?: utcDateTime; @doc("The user who updated the record.") updatedBy?: string; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 800ef24b4921..7d309fe8ab9e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -4583,7 +4583,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4623,7 +4623,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4698,7 +4698,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4738,7 +4738,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4887,7 +4887,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -4953,7 +4953,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -4987,7 +4987,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5027,7 +5027,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5187,7 +5187,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5227,7 +5227,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5332,7 +5332,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5341,7 +5341,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5412,7 +5412,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5421,7 +5421,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5492,7 +5492,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5501,7 +5501,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -5604,7 +5604,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -5613,7 +5613,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6009,7 +6009,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6047,7 +6047,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6146,7 +6146,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6186,7 +6186,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6304,7 +6304,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6344,7 +6344,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -6545,7 +6545,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -6585,7 +6585,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { @@ -7608,12 +7608,12 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -7852,12 +7852,12 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -8013,7 +8013,7 @@ }, "createTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The created time of the record." }, "createdBy": { @@ -8053,7 +8053,7 @@ }, "updateTime": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "The update time of the record." }, "updatedBy": { From fa111378b14d9e0169995e15f23ff4e22f987de8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 6 Feb 2024 08:26:31 +0800 Subject: [PATCH 131/132] update with safeint --- .../models.tsp | 36 ++++------- .../stable/2023-09-01/purviewdatamap.json | 64 +++++++++---------- 2 files changed, 44 insertions(+), 56 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index cd5e6c21a703..13ed03508348 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -269,8 +269,7 @@ model AtlasEntity { classifications?: AtlasClassification[]; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: safeint; @doc("The user who created the record.") createdBy?: string; @@ -314,8 +313,7 @@ removed. status?: EntityStatus; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: safeint; @doc("The user who updated the record.") updatedBy?: string; @@ -658,15 +656,13 @@ model AtlasGlossaryBaseObject { lastModifiedTS?: string; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: safeint; @doc("The user who created the record.") createdBy?: string; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: safeint; @doc("The user who updated the record.") updatedBy?: string; @@ -1069,12 +1065,10 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: safeint; @doc("The last update time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: safeint; @doc("The GUID of the record.") id?: string; @@ -1231,12 +1225,10 @@ distinguish whether a record is an asset or a term. objectType?: string; @doc("The create time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: safeint; @doc("The last update time of the record. The Unix epoch format.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: safeint; @doc("The GUID of the record.") id?: string; @@ -1387,8 +1379,7 @@ model AtlasRelationship { ...AtlasStruct; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: safeint; @doc("The user who created the record.") createdBy?: string; @@ -1415,8 +1406,7 @@ model AtlasRelationship { status?: StatusAtlasRelationship; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: safeint; @doc("The user who updated the record.") updatedBy?: string; @@ -1504,8 +1494,7 @@ alias AtlasBaseTypeDef = { category?: TypeCategory; @doc("The created time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - createTime?: utcDateTime; + createTime?: safeint; @doc("The user who created the record.") createdBy?: string; @@ -1532,8 +1521,7 @@ alias AtlasBaseTypeDef = { typeVersion?: string; @doc("The update time of the record.") - @encode(DateTimeKnownEncoding.unixTimestamp, int64) - updateTime?: utcDateTime; + updateTime?: safeint; @doc("The user who updated the record.") updatedBy?: string; diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 7d309fe8ab9e..800ef24b4921 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -4583,7 +4583,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -4623,7 +4623,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -4698,7 +4698,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -4738,7 +4738,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -4887,7 +4887,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -4953,7 +4953,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -4987,7 +4987,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5027,7 +5027,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5187,7 +5187,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5227,7 +5227,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5332,7 +5332,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5341,7 +5341,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5412,7 +5412,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5421,7 +5421,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5492,7 +5492,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5501,7 +5501,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -5604,7 +5604,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -5613,7 +5613,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6009,7 +6009,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6047,7 +6047,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6146,7 +6146,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6186,7 +6186,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6304,7 +6304,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6344,7 +6344,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -6545,7 +6545,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -6585,7 +6585,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { @@ -7608,12 +7608,12 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -7852,12 +7852,12 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The create time of the record. The Unix epoch format." }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The last update time of the record. The Unix epoch format." }, "id": { @@ -8013,7 +8013,7 @@ }, "createTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The created time of the record." }, "createdBy": { @@ -8053,7 +8053,7 @@ }, "updateTime": { "type": "integer", - "format": "unixtime", + "format": "int64", "description": "The update time of the record." }, "updatedBy": { From 6d23227576fbe0a89939411c913a474cc46f05d8 Mon Sep 17 00:00:00 2001 From: yifan-zhou922 Date: Tue, 6 Feb 2024 10:03:15 +0800 Subject: [PATCH 132/132] update to encodeName --- .../Azure.Analytics.Purview.DataMap/models.tsp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp index 13ed03508348..30de3c98afe2 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/models.tsp @@ -972,11 +972,11 @@ model QueryResult { The total number of search results (not the number of documents in a single page). """) - @projectedName("json", "@search.count") + @encodedName("application/json", "@search.count") searchCount?: int32; @doc("'True' if the '@search.count' is an approximate value and vise versa.") - @projectedName("json", "@search.count.approximate") + @encodedName("application/json", "@search.count.approximate") searchCountApproximate?: boolean; @doc("The token used to get next batch of data. Absent if there's no more data.") @@ -987,7 +987,7 @@ 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. """) - @projectedName("json", "@search.facets") + @encodedName("application/json", "@search.facets") searchFacets?: SearchFacetResultValue; @doc("Search result value") @@ -1046,7 +1046,7 @@ model SearchResultValue { The search score calculated by the search engine. The results are ordered by search score by default. """) - @projectedName("json", "@search.score") + @encodedName("application/json", "@search.score") searchScore?: float32; @doc(""" @@ -1055,7 +1055,7 @@ 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. """) - @projectedName("json", "@search.highlights") + @encodedName("application/json", "@search.highlights") searchHighlights?: SearchHighlights; @doc(""" @@ -1208,14 +1208,14 @@ model SuggestResultValue { The search score calculated by the search engine. The results are ordered by search score by default. """) - @projectedName("json", "@search.score") + @encodedName("application/json", "@search.score") searchScore?: float32; @doc(""" The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark. """) - @projectedName("json", "@search.text") + @encodedName("application/json", "@search.text") searchText?: string; @doc("""