From 9a8067260718f755a13768277d636fc531f34018 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Fri, 20 Dec 2024 08:24:47 +0800 Subject: [PATCH] [data-plane] refresh purview-datamap-rest sdk (#31356) https://github.com/Azure/azure-sdk-for-js/issues/30680 --- sdk/purview/purview-datamap-rest/CHANGELOG.md | 9 +- sdk/purview/purview-datamap-rest/assets.json | 2 +- .../review/purview-datamap.api.md | 515 ++++++++++++------ .../src/clientDefinitions.ts | 78 ++- .../purview-datamap-rest/src/isUnexpected.ts | 56 +- .../purview-datamap-rest/src/models.ts | 89 +-- .../purview-datamap-rest/src/outputModels.ts | 106 ++-- .../purview-datamap-rest/src/parameters.ts | 227 ++++++-- .../src/purviewDataMapClient.ts | 22 +- .../purview-datamap-rest/src/responses.ts | 24 +- .../test/public/entityTest.spec.ts | 11 +- .../purview-datamap-rest/tsp-location.yaml | 5 +- 12 files changed, 753 insertions(+), 391 deletions(-) diff --git a/sdk/purview/purview-datamap-rest/CHANGELOG.md b/sdk/purview/purview-datamap-rest/CHANGELOG.md index c7acf3da97fa..192f3a417ade 100644 --- a/sdk/purview/purview-datamap-rest/CHANGELOG.md +++ b/sdk/purview/purview-datamap-rest/CHANGELOG.md @@ -1,14 +1,9 @@ ## Release History -### 1.0.0-beta.2 (Unreleased) +### 1.0.0-beta.2 (2024-12-16) #### Features Added - -#### Breaking Changes - -#### Bugs Fixed - -#### Other Changes +- refresh @azure-rest/purview-datamap sdk ### 1.0.0-beta.1 (2024-03-04) - Initial Release diff --git a/sdk/purview/purview-datamap-rest/assets.json b/sdk/purview/purview-datamap-rest/assets.json index af63526b0a75..8073e79aa4f6 100644 --- a/sdk/purview/purview-datamap-rest/assets.json +++ b/sdk/purview/purview-datamap-rest/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "js", "TagPrefix": "js/purview/purview-datamap-rest", - "Tag": "js/purview/purview-datamap-rest_5cd5118b52" + "Tag": "js/purview/purview-datamap-rest_47b9910f06" } diff --git a/sdk/purview/purview-datamap-rest/review/purview-datamap.api.md b/sdk/purview/purview-datamap-rest/review/purview-datamap.api.md index ef6ac0e217c0..8f8d0194d6c1 100644 --- a/sdk/purview/purview-datamap-rest/review/purview-datamap.api.md +++ b/sdk/purview/purview-datamap-rest/review/purview-datamap.api.md @@ -11,13 +11,14 @@ import { createFileFromStream } from '@azure/core-rest-pipeline'; import { CreateFileFromStreamOptions } from '@azure/core-rest-pipeline'; import { CreateFileOptions } from '@azure/core-rest-pipeline'; import type { HttpResponse } from '@azure-rest/core-client'; +import type { RawHttpHeaders } from '@azure/core-rest-pipeline'; import type { RequestParameters } from '@azure-rest/core-client'; import type { StreamableMethod } from '@azure-rest/core-client'; import type { TokenCredential } from '@azure/core-auth'; // @public export interface AtlasAttributeDef { - cardinality?: string; + cardinality?: CardinalityValue; constraints?: Array; defaultValue?: string; description?: string; @@ -34,7 +35,7 @@ export interface AtlasAttributeDef { // @public export interface AtlasAttributeDefOutput { - cardinality?: string; + cardinality?: CardinalityValueOutput; constraints?: Array; defaultValue?: string; description?: string; @@ -52,7 +53,7 @@ export interface AtlasAttributeDefOutput { // @public export interface AtlasBusinessMetadataDef { attributeDefs?: Array; - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -71,7 +72,7 @@ export interface AtlasBusinessMetadataDef { // @public export interface AtlasBusinessMetadataDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -91,7 +92,7 @@ export interface AtlasBusinessMetadataDefOutput { export interface AtlasClassification { attributes?: Record; entityGuid?: string; - entityStatus?: string; + entityStatus?: EntityStatus; lastModifiedTS?: string; removePropagationsOnEntityDelete?: boolean; typeName?: string; @@ -101,7 +102,7 @@ export interface AtlasClassification { // @public export interface AtlasClassificationDef { attributeDefs?: Array; - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -123,7 +124,7 @@ export interface AtlasClassificationDef { // @public export interface AtlasClassificationDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -146,7 +147,7 @@ export interface AtlasClassificationDefOutput { export interface AtlasClassificationOutput { attributes?: Record; entityGuid?: string; - entityStatus?: string; + entityStatus?: EntityStatusOutput; lastModifiedTS?: string; removePropagationsOnEntityDelete?: boolean; typeName?: string; @@ -158,7 +159,7 @@ export interface AtlasClassificationsOutput { list?: any[]; pageSize?: number; sortBy?: string; - sortType?: string; + sortType?: SortTypeOutput; startIndex?: number; totalCount?: number; } @@ -205,7 +206,7 @@ export interface AtlasEntity { provenanceType?: number; proxy?: boolean; relationshipAttributes?: Record; - status?: string; + status?: EntityStatus; typeName?: string; updatedBy?: string; updateTime?: number; @@ -215,7 +216,7 @@ export interface AtlasEntity { // @public export interface AtlasEntityDef { attributeDefs?: Array; - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -237,7 +238,7 @@ export interface AtlasEntityDef { // @public export interface AtlasEntityDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -268,7 +269,7 @@ export interface AtlasEntityHeader { lastModifiedTS?: string; meaningNames?: string[]; meanings?: Array; - status?: string; + status?: EntityStatus; typeName?: string; } @@ -284,7 +285,7 @@ export interface AtlasEntityHeaderOutput { lastModifiedTS?: string; meaningNames?: string[]; meanings?: Array; - status?: string; + status?: EntityStatusOutput; typeName?: string; } @@ -312,7 +313,7 @@ export interface AtlasEntityOutput { provenanceType?: number; proxy?: boolean; relationshipAttributes?: Record; - status?: string; + status?: EntityStatusOutput; typeName?: string; updatedBy?: string; updateTime?: number; @@ -333,7 +334,7 @@ export interface AtlasEntityWithExtInfoOutput { // @public export interface AtlasEnumDef { - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -353,7 +354,7 @@ export interface AtlasEnumDef { // @public export interface AtlasEnumDefOutput { - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -532,7 +533,7 @@ export interface AtlasGlossaryTerm { resources?: Array; seeAlso?: Array; shortDescription?: string; - status?: string; + status?: TermStatus; synonyms?: Array; templateName?: unknown[]; translatedTerms?: Array; @@ -573,7 +574,7 @@ export interface AtlasGlossaryTermOutput { resources?: Array; seeAlso?: Array; shortDescription?: string; - status?: string; + status?: TermStatusOutput; synonyms?: Array; templateName?: any[]; translatedTerms?: Array; @@ -591,7 +592,7 @@ export interface AtlasLineageInfoOutput { childrenCount?: number; guidEntityMap?: Record; lineageDepth?: number; - lineageDirection?: string; + lineageDirection?: LineageDirectionOutput; lineageWidth?: number; parentRelations?: Array; relations?: Array; @@ -633,11 +634,11 @@ export interface AtlasRelatedCategoryHeaderOutput { // @public export interface AtlasRelatedObjectId { displayText?: string; - entityStatus?: string; + entityStatus?: EntityStatus; guid?: string; relationshipAttributes?: AtlasStruct; relationshipGuid?: string; - relationshipStatus?: string; + relationshipStatus?: StatusAtlasRelationship; relationshipType?: string; typeName?: string; uniqueAttributes?: Record; @@ -646,11 +647,11 @@ export interface AtlasRelatedObjectId { // @public export interface AtlasRelatedObjectIdOutput { displayText?: string; - entityStatus?: string; + entityStatus?: EntityStatusOutput; guid?: string; relationshipAttributes?: AtlasStructOutput; relationshipGuid?: string; - relationshipStatus?: string; + relationshipStatus?: StatusAtlasRelationshipOutput; relationshipType?: string; typeName?: string; uniqueAttributes?: Record; @@ -662,7 +663,7 @@ export interface AtlasRelatedTermHeader { displayText?: string; expression?: string; relationGuid?: string; - status?: string; + status?: AtlasTermRelationshipStatus; steward?: string; termGuid?: string; } @@ -673,7 +674,7 @@ export interface AtlasRelatedTermHeaderOutput { displayText?: string; expression?: string; relationGuid?: string; - status?: string; + status?: AtlasTermRelationshipStatusOutput; steward?: string; termGuid?: string; } @@ -690,7 +691,7 @@ export interface AtlasRelationship { label?: string; lastModifiedTS?: string; provenanceType?: number; - status?: string; + status?: StatusAtlasRelationship; typeName?: string; updatedBy?: string; updateTime?: number; @@ -699,7 +700,7 @@ export interface AtlasRelationship { // @public export interface AtlasRelationshipAttributeDef { - cardinality?: string; + cardinality?: CardinalityValue; constraints?: Array; defaultValue?: string; description?: string; @@ -718,7 +719,7 @@ export interface AtlasRelationshipAttributeDef { // @public export interface AtlasRelationshipAttributeDefOutput { - cardinality?: string; + cardinality?: CardinalityValueOutput; constraints?: Array; defaultValue?: string; description?: string; @@ -738,7 +739,7 @@ export interface AtlasRelationshipAttributeDefOutput { // @public export interface AtlasRelationshipDef { attributeDefs?: Array; - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -749,7 +750,7 @@ export interface AtlasRelationshipDef { lastModifiedTS?: string; name?: string; options?: Record; - relationshipCategory?: string; + relationshipCategory?: RelationshipCategory; relationshipLabel?: string; serviceType?: string; typeVersion?: string; @@ -761,7 +762,7 @@ export interface AtlasRelationshipDef { // @public export interface AtlasRelationshipDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -772,7 +773,7 @@ export interface AtlasRelationshipDefOutput { lastModifiedTS?: string; name?: string; options?: Record; - relationshipCategory?: string; + relationshipCategory?: RelationshipCategoryOutput; relationshipLabel?: string; serviceType?: string; typeVersion?: string; @@ -783,7 +784,7 @@ export interface AtlasRelationshipDefOutput { // @public export interface AtlasRelationshipEndDef { - cardinality?: string; + cardinality?: CardinalityValue; description?: string; isContainer?: boolean; isLegacyAttribute?: boolean; @@ -793,7 +794,7 @@ export interface AtlasRelationshipEndDef { // @public export interface AtlasRelationshipEndDefOutput { - cardinality?: string; + cardinality?: CardinalityValueOutput; description?: string; isContainer?: boolean; isLegacyAttribute?: boolean; @@ -813,7 +814,7 @@ export interface AtlasRelationshipOutput { label?: string; lastModifiedTS?: string; provenanceType?: number; - status?: string; + status?: StatusAtlasRelationshipOutput; typeName?: string; updatedBy?: string; updateTime?: number; @@ -836,7 +837,7 @@ export interface AtlasStruct { // @public export interface AtlasStructDef { attributeDefs?: Array; - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -855,7 +856,7 @@ export interface AtlasStructDef { // @public export interface AtlasStructDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -886,7 +887,7 @@ export interface AtlasTermAssignmentHeader { displayText?: string; expression?: string; relationGuid?: string; - status?: string; + status?: AtlasTermAssignmentStatus; steward?: string; termGuid?: string; } @@ -899,18 +900,24 @@ export interface AtlasTermAssignmentHeaderOutput { displayText?: string; expression?: string; relationGuid?: string; - status?: string; + status?: AtlasTermAssignmentStatusOutput; steward?: string; termGuid?: string; } +// @public +export type AtlasTermAssignmentStatus = string; + +// @public +export type AtlasTermAssignmentStatusOutput = string; + // @public export interface AtlasTermCategorizationHeader { categoryGuid?: string; description?: string; displayText?: string; relationGuid?: string; - status?: string; + status?: AtlasTermRelationshipStatus; } // @public @@ -919,12 +926,18 @@ export interface AtlasTermCategorizationHeaderOutput { description?: string; displayText?: string; relationGuid?: string; - status?: string; + status?: AtlasTermRelationshipStatusOutput; } +// @public +export type AtlasTermRelationshipStatus = string; + +// @public +export type AtlasTermRelationshipStatusOutput = string; + // @public export interface AtlasTypeDefHeaderOutput { - category?: string; + category?: TypeCategoryOutput; guid?: string; name?: string; } @@ -932,7 +945,7 @@ export interface AtlasTypeDefHeaderOutput { // @public export interface AtlasTypeDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -947,7 +960,7 @@ export interface AtlasTypeDefOutput { name?: string; options?: Record; relationshipAttributeDefs?: Array; - relationshipCategory?: string; + relationshipCategory?: RelationshipCategoryOutput; relationshipLabel?: string; serviceType?: string; subTypes?: string[]; @@ -1008,15 +1021,29 @@ export interface BulkImportResultOutput { } // @public -export interface BusinessMetadataOptions { - file: string | Uint8Array | ReadableStream | NodeJS.ReadableStream | File; -} +export type BusinessAttributeUpdateBehavior = string; // @public -export interface BusinessMetadataOptionsOutput { - file: Uint8Array; +export type BusinessMetadataOptions = FormData | Array; + +// @public (undocumented) +export interface BusinessMetadataOptionsFilePartDescriptor { + // (undocumented) + body: string | Uint8Array | ReadableStream | NodeJS.ReadableStream | File; + // (undocumented) + contentType?: string; + // (undocumented) + filename?: string; + // (undocumented) + name: "file"; } +// @public +export type CardinalityValue = string; + +// @public +export type CardinalityValueOutput = string; + // @public export interface ClassificationAssociateOptions { classification?: AtlasClassification; @@ -1043,7 +1070,7 @@ export interface ContactSearchResultValueOutput { } // @public -function createClient(endpoint: string, credentials: TokenCredential, options?: ClientOptions): PurviewDataMapClient; +function createClient(endpointParam: string, credentials: TokenCredential, options?: PurviewDataMapClientOptions): PurviewDataMapClient; export default createClient; export { createFile } @@ -1082,7 +1109,7 @@ export interface DateFormatOutput { // @public (undocumented) export interface DiscoveryAutoComplete { - post(options?: DiscoveryAutoCompleteParameters): StreamableMethod; + post(options: DiscoveryAutoCompleteParameters): StreamableMethod; } // @public @@ -1095,8 +1122,7 @@ export interface DiscoveryAutoComplete200Response extends HttpResponse { // @public (undocumented) export interface DiscoveryAutoCompleteBodyParam { - // (undocumented) - body?: AutoCompleteOptions; + body: AutoCompleteOptions; } // @public (undocumented) @@ -1108,11 +1134,22 @@ export interface DiscoveryAutoCompleteDefaultResponse extends HttpResponse { } // @public (undocumented) -export type DiscoveryAutoCompleteParameters = DiscoveryAutoCompleteBodyParam & RequestParameters; +export type DiscoveryAutoCompleteParameters = DiscoveryAutoCompleteQueryParam & DiscoveryAutoCompleteBodyParam & RequestParameters; + +// @public (undocumented) +export interface DiscoveryAutoCompleteQueryParam { + // (undocumented) + queryParameters: DiscoveryAutoCompleteQueryParamProperties; +} + +// @public (undocumented) +export interface DiscoveryAutoCompleteQueryParamProperties { + "api-version": string; +} // @public (undocumented) export interface DiscoveryQuery { - post(options?: DiscoveryQueryParameters): StreamableMethod; + post(options: DiscoveryQueryParameters): StreamableMethod; } // @public @@ -1125,8 +1162,7 @@ export interface DiscoveryQuery200Response extends HttpResponse { // @public (undocumented) export interface DiscoveryQueryBodyParam { - // (undocumented) - body?: QueryOptions; + body: QueryOptions; } // @public (undocumented) @@ -1138,11 +1174,22 @@ export interface DiscoveryQueryDefaultResponse extends HttpResponse { } // @public (undocumented) -export type DiscoveryQueryParameters = DiscoveryQueryBodyParam & RequestParameters; +export type DiscoveryQueryParameters = DiscoveryQueryQueryParam & DiscoveryQueryBodyParam & RequestParameters; + +// @public (undocumented) +export interface DiscoveryQueryQueryParam { + // (undocumented) + queryParameters: DiscoveryQueryQueryParamProperties; +} + +// @public (undocumented) +export interface DiscoveryQueryQueryParamProperties { + "api-version": string; +} // @public (undocumented) export interface DiscoverySuggest { - post(options?: DiscoverySuggestParameters): StreamableMethod; + post(options: DiscoverySuggestParameters): StreamableMethod; } // @public @@ -1155,8 +1202,7 @@ export interface DiscoverySuggest200Response extends HttpResponse { // @public (undocumented) export interface DiscoverySuggestBodyParam { - // (undocumented) - body?: SuggestOptions; + body: SuggestOptions; } // @public (undocumented) @@ -1168,11 +1214,22 @@ export interface DiscoverySuggestDefaultResponse extends HttpResponse { } // @public (undocumented) -export type DiscoverySuggestParameters = DiscoverySuggestBodyParam & RequestParameters; +export type DiscoverySuggestParameters = DiscoverySuggestQueryParam & DiscoverySuggestBodyParam & RequestParameters; + +// @public (undocumented) +export interface DiscoverySuggestQueryParam { + // (undocumented) + queryParameters: DiscoverySuggestQueryParamProperties; +} + +// @public (undocumented) +export interface DiscoverySuggestQueryParamProperties { + "api-version": string; +} // @public (undocumented) export interface EntityAddClassification { - post(options?: EntityAddClassificationParameters): StreamableMethod; + post(options: EntityAddClassificationParameters): StreamableMethod; } // @public @@ -1183,8 +1240,7 @@ export interface EntityAddClassification204Response extends HttpResponse { // @public (undocumented) export interface EntityAddClassificationBodyParam { - // (undocumented) - body?: ClassificationAssociateOptions; + body: ClassificationAssociateOptions; } // @public (undocumented) @@ -1379,8 +1435,7 @@ export interface EntityBulkCreateOrUpdate200Response extends HttpResponse { // @public (undocumented) export interface EntityBulkCreateOrUpdateBodyParam { - // (undocumented) - body?: AtlasEntitiesWithExtInfo; + body: AtlasEntitiesWithExtInfo; } // @public (undocumented) @@ -1402,7 +1457,8 @@ export interface EntityBulkCreateOrUpdateQueryParam { // @public (undocumented) export interface EntityBulkCreateOrUpdateQueryParamProperties { - businessAttributeUpdateBehavior?: string; + "api-version"?: string; + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; collectionId?: string; } @@ -1422,6 +1478,13 @@ export interface EntityBulkDeleteDefaultResponse extends HttpResponse { status: string; } +// @public +export interface EntityBulkDeleteGuidQueryParam { + explode: true; + style: "form"; + value: string[]; +} + // @public (undocumented) export type EntityBulkDeleteParameters = EntityBulkDeleteQueryParam & RequestParameters; @@ -1433,12 +1496,12 @@ export interface EntityBulkDeleteQueryParam { // @public (undocumented) export interface EntityBulkDeleteQueryParamProperties { - guid: string; + guid: EntityBulkDeleteGuidQueryParam; } // @public (undocumented) export interface EntityBulkSetClassifications { - post(options?: EntityBulkSetClassificationsParameters): StreamableMethod; + post(options: EntityBulkSetClassificationsParameters): StreamableMethod; } // @public @@ -1451,8 +1514,7 @@ export interface EntityBulkSetClassifications200Response extends HttpResponse { // @public (undocumented) export interface EntityBulkSetClassificationsBodyParam { - // (undocumented) - body?: AtlasEntityHeaders; + body: AtlasEntityHeaders; } // @public (undocumented) @@ -1468,7 +1530,7 @@ export type EntityBulkSetClassificationsParameters = EntityBulkSetClassification // @public (undocumented) export interface EntityCreateOrUpdate { - post(options?: EntityCreateOrUpdateParameters): StreamableMethod; + post(options: EntityCreateOrUpdateParameters): StreamableMethod; } // @public @@ -1481,8 +1543,7 @@ export interface EntityCreateOrUpdate200Response extends HttpResponse { // @public (undocumented) export interface EntityCreateOrUpdateBodyParam { - // (undocumented) - body?: AtlasEntityWithExtInfo; + body: AtlasEntityWithExtInfo; } // @public (undocumented) @@ -1504,10 +1565,19 @@ export interface EntityCreateOrUpdateQueryParam { // @public (undocumented) export interface EntityCreateOrUpdateQueryParamProperties { - businessAttributeUpdateBehavior?: string; + "api-version"?: string; + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; collectionId?: string; } +// @public +export interface EntityDelete200Response extends HttpResponse { + // (undocumented) + body: EntityMutationResultOutput; + // (undocumented) + status: "200"; +} + // @public export interface EntityDeleteByUniqueAttribute200Response extends HttpResponse { // (undocumented) @@ -1538,16 +1608,8 @@ export interface EntityDeleteByUniqueAttributeQueryParamProperties { "attr:qualifiedName"?: string; } -// @public -export interface EntityDeleteOperation200Response extends HttpResponse { - // (undocumented) - body: EntityMutationResultOutput; - // (undocumented) - status: "200"; -} - // @public (undocumented) -export interface EntityDeleteOperationDefaultResponse extends HttpResponse { +export interface EntityDeleteDefaultResponse extends HttpResponse { // (undocumented) body: AtlasErrorResponseOutput; // (undocumented) @@ -1559,7 +1621,7 @@ export type EntityDeleteParameters = RequestParameters; // @public (undocumented) export interface EntityGet { - delete(options?: EntityDeleteParameters): StreamableMethod; + delete(options?: EntityDeleteParameters): StreamableMethod; get(options?: EntityGetParameters): StreamableMethod; put(options: EntityPartialUpdateAttributeByGuidParameters): StreamableMethod; } @@ -1576,7 +1638,7 @@ export interface EntityGet200Response extends HttpResponse { export interface EntityGetByUniqueAttributes { delete(options?: EntityDeleteByUniqueAttributeParameters): StreamableMethod; get(options?: EntityGetByUniqueAttributesParameters): StreamableMethod; - put(options?: EntityPartialUpdateByUniqueAttributesParameters): StreamableMethod; + put(options: EntityPartialUpdateByUniqueAttributesParameters): StreamableMethod; } // @public @@ -1714,10 +1776,18 @@ export interface EntityGetSampleBusinessMetadataTemplate { get(options?: EntityGetSampleBusinessMetadataTemplateParameters): StreamableMethod; } +// @public (undocumented) +export interface EntityGetSampleBusinessMetadataTemplate200Headers { + // (undocumented) + "content-type": "application/octet-stream"; +} + // @public export interface EntityGetSampleBusinessMetadataTemplate200Response extends HttpResponse { body: Uint8Array; // (undocumented) + headers: RawHttpHeaders & EntityGetSampleBusinessMetadataTemplate200Headers; + // (undocumented) status: "200"; } @@ -1747,8 +1817,7 @@ export interface EntityImportBusinessMetadata200Response extends HttpResponse { // @public (undocumented) export interface EntityImportBusinessMetadataBodyParam { - // (undocumented) - body?: BusinessMetadataOptions; + body: BusinessMetadataOptions; } // @public (undocumented) @@ -1771,7 +1840,7 @@ export type EntityImportBusinessMetadataParameters = EntityImportBusinessMetadat export interface EntityListByGuids { delete(options: EntityBulkDeleteParameters): StreamableMethod; get(options: EntityListByGuidsParameters): StreamableMethod; - post(options?: EntityBulkCreateOrUpdateParameters): StreamableMethod; + post(options: EntityBulkCreateOrUpdateParameters): StreamableMethod; } // @public @@ -1790,6 +1859,13 @@ export interface EntityListByGuidsDefaultResponse extends HttpResponse { status: string; } +// @public +export interface EntityListByGuidsGuidQueryParam { + explode: true; + style: "form"; + value: string[]; +} + // @public (undocumented) export type EntityListByGuidsParameters = EntityListByGuidsQueryParam & RequestParameters; @@ -1801,7 +1877,8 @@ export interface EntityListByGuidsQueryParam { // @public (undocumented) export interface EntityListByGuidsQueryParamProperties { - guid: string; + "api-version"?: string; + guid: EntityListByGuidsGuidQueryParam; ignoreRelationships?: boolean; minExtInfo?: boolean; } @@ -1858,8 +1935,7 @@ export interface EntityMoveEntitiesToCollection200Response extends HttpResponse // @public (undocumented) export interface EntityMoveEntitiesToCollectionBodyParam { - // (undocumented) - body?: MoveEntitiesOptions; + body: MoveEntitiesOptions; } // @public (undocumented) @@ -1881,6 +1957,7 @@ export interface EntityMoveEntitiesToCollectionQueryParam { // @public (undocumented) export interface EntityMoveEntitiesToCollectionQueryParamProperties { + "api-version": string; collectionId: string; } @@ -1936,8 +2013,7 @@ export interface EntityPartialUpdateByUniqueAttributes200Response extends HttpRe // @public (undocumented) export interface EntityPartialUpdateByUniqueAttributesBodyParam { - // (undocumented) - body?: AtlasEntityWithExtInfo; + body: AtlasEntityWithExtInfo; } // @public (undocumented) @@ -2192,6 +2268,12 @@ export interface EntitySetLabelsDefaultResponse extends HttpResponse { // @public (undocumented) export type EntitySetLabelsParameters = EntitySetLabelsBodyParam & RequestParameters; +// @public +export type EntityStatus = string; + +// @public +export type EntityStatusOutput = string; + // @public export interface EntityUpdateClassifications204Response extends HttpResponse { // (undocumented) @@ -2279,8 +2361,7 @@ export interface GlossaryCreate200Response extends HttpResponse { // @public (undocumented) export interface GlossaryCreateBodyParam { - // (undocumented) - body?: AtlasGlossary; + body: AtlasGlossary; } // @public (undocumented) @@ -2314,7 +2395,7 @@ export type GlossaryCreateCategoriesParameters = GlossaryCreateCategoriesBodyPar // @public (undocumented) export interface GlossaryCreateCategory { - post(options?: GlossaryCreateCategoryParameters): StreamableMethod; + post(options: GlossaryCreateCategoryParameters): StreamableMethod; } // @public @@ -2327,8 +2408,7 @@ export interface GlossaryCreateCategory200Response extends HttpResponse { // @public (undocumented) export interface GlossaryCreateCategoryBodyParam { - // (undocumented) - body?: AtlasGlossaryCategory; + body: AtlasGlossaryCategory; } // @public (undocumented) @@ -2355,7 +2435,7 @@ export type GlossaryCreateParameters = GlossaryCreateBodyParam & RequestParamete // @public (undocumented) export interface GlossaryCreateTerm { - post(options?: GlossaryCreateTermParameters): StreamableMethod; + post(options: GlossaryCreateTermParameters): StreamableMethod; } // @public @@ -2368,8 +2448,7 @@ export interface GlossaryCreateTerm200Response extends HttpResponse { // @public (undocumented) export interface GlossaryCreateTermBodyParam { - // (undocumented) - body?: AtlasGlossaryTerm; + body: AtlasGlossaryTerm; } // @public (undocumented) @@ -2431,9 +2510,16 @@ export interface GlossaryCreateTermsQueryParam { // @public (undocumented) export interface GlossaryCreateTermsQueryParamProperties { + "api-version"?: string; includeTermHierarchy?: boolean; } +// @public +export interface GlossaryDelete204Response extends HttpResponse { + // (undocumented) + status: "204"; +} + // @public export interface GlossaryDeleteCategory204Response extends HttpResponse { // (undocumented) @@ -2451,14 +2537,8 @@ export interface GlossaryDeleteCategoryDefaultResponse extends HttpResponse { // @public (undocumented) export type GlossaryDeleteCategoryParameters = RequestParameters; -// @public -export interface GlossaryDeleteOperation204Response extends HttpResponse { - // (undocumented) - status: "204"; -} - // @public (undocumented) -export interface GlossaryDeleteOperationDefaultResponse extends HttpResponse { +export interface GlossaryDeleteDefaultResponse extends HttpResponse { // (undocumented) body: AtlasErrorResponseOutput; // (undocumented) @@ -2509,9 +2589,9 @@ export type GlossaryDeleteTermParameters = RequestParameters; // @public (undocumented) export interface GlossaryGet { - delete(options?: GlossaryDeleteParameters): StreamableMethod; + delete(options?: GlossaryDeleteParameters): StreamableMethod; get(options?: GlossaryGetParameters): StreamableMethod; - put(options?: GlossaryUpdateParameters): StreamableMethod; + put(options: GlossaryUpdateParameters): StreamableMethod; } // @public @@ -2526,7 +2606,7 @@ export interface GlossaryGet200Response extends HttpResponse { export interface GlossaryGetCategory { delete(options?: GlossaryDeleteCategoryParameters): StreamableMethod; get(options?: GlossaryGetCategoryParameters): StreamableMethod; - put(options?: GlossaryUpdateCategoryParameters): StreamableMethod; + put(options: GlossaryUpdateCategoryParameters): StreamableMethod; } // @public @@ -2578,7 +2658,18 @@ export interface GlossaryGetDetailedDefaultResponse extends HttpResponse { } // @public (undocumented) -export type GlossaryGetDetailedParameters = RequestParameters; +export type GlossaryGetDetailedParameters = GlossaryGetDetailedQueryParam & RequestParameters; + +// @public (undocumented) +export interface GlossaryGetDetailedQueryParam { + // (undocumented) + queryParameters?: GlossaryGetDetailedQueryParamProperties; +} + +// @public (undocumented) +export interface GlossaryGetDetailedQueryParamProperties { + "api-version"?: string; +} // @public (undocumented) export type GlossaryGetParameters = RequestParameters; @@ -2587,7 +2678,7 @@ export type GlossaryGetParameters = RequestParameters; export interface GlossaryGetTerm { delete(options?: GlossaryDeleteTermParameters): StreamableMethod; get(options?: GlossaryGetTermParameters): StreamableMethod; - put(options?: GlossaryUpdateTermParameters): StreamableMethod; + put(options: GlossaryUpdateTermParameters): StreamableMethod; } // @public @@ -2607,12 +2698,23 @@ export interface GlossaryGetTermDefaultResponse extends HttpResponse { } // @public (undocumented) -export type GlossaryGetTermParameters = RequestParameters; +export type GlossaryGetTermParameters = GlossaryGetTermQueryParam & RequestParameters; + +// @public (undocumented) +export interface GlossaryGetTermQueryParam { + // (undocumented) + queryParameters?: GlossaryGetTermQueryParamProperties; +} + +// @public (undocumented) +export interface GlossaryGetTermQueryParamProperties { + "api-version"?: string; +} // @public (undocumented) export interface GlossaryList { get(options?: GlossaryListParameters): StreamableMethod; - post(options?: GlossaryCreateParameters): StreamableMethod; + post(options: GlossaryCreateParameters): StreamableMethod; } // @public @@ -2792,6 +2894,7 @@ export interface GlossaryListQueryParam { // @public (undocumented) export interface GlossaryListQueryParamProperties { + "api-version"?: string; ignoreTermsAndCategories?: boolean; limit?: number; offset?: number; @@ -2867,6 +2970,7 @@ export interface GlossaryListRelatedTermsQueryParam { // @public (undocumented) export interface GlossaryListRelatedTermsQueryParamProperties { + "api-version"?: string; limit?: number; offset?: number; sort?: string; @@ -2941,6 +3045,7 @@ export interface GlossaryListTermsQueryParam { // @public (undocumented) export interface GlossaryListTermsQueryParamProperties { + "api-version"?: string; limit?: number; offset?: number; sort?: string; @@ -3012,6 +3117,7 @@ export interface GlossaryPartialUpdateQueryParam { // @public (undocumented) export interface GlossaryPartialUpdateQueryParamProperties { + "api-version"?: string; ignoreTermsAndCategories?: boolean; } @@ -3052,6 +3158,7 @@ export interface GlossaryPartialUpdateTermQueryParam { // @public (undocumented) export interface GlossaryPartialUpdateTermQueryParamProperties { + "api-version"?: string; includeTermHierarchy?: boolean; } @@ -3065,8 +3172,7 @@ export interface GlossaryUpdate200Response extends HttpResponse { // @public (undocumented) export interface GlossaryUpdateBodyParam { - // (undocumented) - body?: AtlasGlossary; + body: AtlasGlossary; } // @public @@ -3079,8 +3185,7 @@ export interface GlossaryUpdateCategory200Response extends HttpResponse { // @public (undocumented) export interface GlossaryUpdateCategoryBodyParam { - // (undocumented) - body?: AtlasGlossaryCategory; + body: AtlasGlossaryCategory; } // @public (undocumented) @@ -3113,6 +3218,7 @@ export interface GlossaryUpdateQueryParam { // @public (undocumented) export interface GlossaryUpdateQueryParamProperties { + "api-version"?: string; ignoreTermsAndCategories?: boolean; } @@ -3126,8 +3232,7 @@ export interface GlossaryUpdateTerm200Response extends HttpResponse { // @public (undocumented) export interface GlossaryUpdateTermBodyParam { - // (undocumented) - body?: AtlasGlossaryTerm; + body: AtlasGlossaryTerm; } // @public (undocumented) @@ -3149,17 +3254,21 @@ export interface GlossaryUpdateTermQueryParam { // @public (undocumented) export interface GlossaryUpdateTermQueryParamProperties { + "api-version"?: string; includeTermHierarchy?: boolean; } // @public export interface ImportInfoOutput { childObjectName?: string; - importStatus?: string; + importStatus?: ImportStatusOutput; parentObjectName?: string; remarks?: string; } +// @public +export type ImportStatusOutput = string; + // @public (undocumented) export function isUnexpected(response: EntityCreateOrUpdate200Response | EntityCreateOrUpdateDefaultResponse): response is EntityCreateOrUpdateDefaultResponse; @@ -3182,7 +3291,7 @@ export function isUnexpected(response: EntityGet200Response | EntityGetDefaultRe export function isUnexpected(response: EntityPartialUpdateAttributeByGuid200Response | EntityPartialUpdateAttributeByGuidDefaultResponse): response is EntityPartialUpdateAttributeByGuidDefaultResponse; // @public (undocumented) -export function isUnexpected(response: EntityDeleteOperation200Response | EntityDeleteOperationDefaultResponse): response is EntityDeleteOperationDefaultResponse; +export function isUnexpected(response: EntityDelete200Response | EntityDeleteDefaultResponse): response is EntityDeleteDefaultResponse; // @public (undocumented) export function isUnexpected(response: EntityGetClassification200Response | EntityGetClassificationDefaultResponse): response is EntityGetClassificationDefaultResponse; @@ -3332,7 +3441,7 @@ export function isUnexpected(response: GlossaryGet200Response | GlossaryGetDefau export function isUnexpected(response: GlossaryUpdate200Response | GlossaryUpdateDefaultResponse): response is GlossaryUpdateDefaultResponse; // @public (undocumented) -export function isUnexpected(response: GlossaryDeleteOperation204Response | GlossaryDeleteOperationDefaultResponse): response is GlossaryDeleteOperationDefaultResponse; +export function isUnexpected(response: GlossaryDelete204Response | GlossaryDeleteDefaultResponse): response is GlossaryDeleteDefaultResponse; // @public (undocumented) export function isUnexpected(response: GlossaryListCategories200Response | GlossaryListCategoriesDefaultResponse): response is GlossaryListCategoriesDefaultResponse; @@ -3380,7 +3489,7 @@ export function isUnexpected(response: RelationshipUpdate200Response | Relations export function isUnexpected(response: RelationshipGet200Response | RelationshipGetDefaultResponse): response is RelationshipGetDefaultResponse; // @public (undocumented) -export function isUnexpected(response: RelationshipDeleteOperation204Response | RelationshipDeleteOperationDefaultResponse): response is RelationshipDeleteOperationDefaultResponse; +export function isUnexpected(response: RelationshipDelete204Response | RelationshipDeleteDefaultResponse): response is RelationshipDeleteDefaultResponse; // @public (undocumented) export function isUnexpected(response: TypeGetBusinessMetadataDefByGuid200Response | TypeGetBusinessMetadataDefByGuidDefaultResponse): response is TypeGetBusinessMetadataDefByGuidDefaultResponse; @@ -3425,7 +3534,7 @@ export function isUnexpected(response: TypeGetByGuid200Response | TypeGetByGuidD export function isUnexpected(response: TypeGetByName200Response | TypeGetByNameDefaultResponse): response is TypeGetByNameDefaultResponse; // @public (undocumented) -export function isUnexpected(response: TypeDeleteOperation204Response | TypeDeleteOperationDefaultResponse): response is TypeDeleteOperationDefaultResponse; +export function isUnexpected(response: TypeDelete204Response | TypeDeleteDefaultResponse): response is TypeDeleteDefaultResponse; // @public (undocumented) export function isUnexpected(response: TypeList200Response | TypeListDefaultResponse): response is TypeListDefaultResponse; @@ -3448,6 +3557,12 @@ export function isUnexpected(response: TypeGetTermTemplateDefByGuid200Response | // @public (undocumented) export function isUnexpected(response: TypeGetTermTemplateDefByName200Response | TypeGetTermTemplateDefByNameDefaultResponse): response is TypeGetTermTemplateDefByNameDefaultResponse; +// @public +export type LineageDirection = string; + +// @public +export type LineageDirectionOutput = string; + // @public (undocumented) export interface LineageGet { get(options: LineageGetParameters): StreamableMethod; @@ -3495,7 +3610,7 @@ export interface LineageGetByUniqueAttributeQueryParam { export interface LineageGetByUniqueAttributeQueryParamProperties { "attr:qualifiedName"?: string; depth?: number; - direction: string; + direction: LineageDirection; } // @public (undocumented) @@ -3538,7 +3653,8 @@ export interface LineageGetNextPageQueryParam { // @public (undocumented) export interface LineageGetNextPageQueryParamProperties { - direction: string; + "api-version": string; + direction: LineageDirection; limit?: number; offset?: number; } @@ -3555,7 +3671,7 @@ export interface LineageGetQueryParam { // @public (undocumented) export interface LineageGetQueryParamProperties { depth?: number; - direction: string; + direction: LineageDirection; } // @public @@ -3585,7 +3701,7 @@ export interface NumberFormat { numberInstance?: NumberFormat; parseIntegerOnly?: boolean; percentInstance?: NumberFormat; - roundingMode?: string; + roundingMode?: RoundingMode; } // @public @@ -3603,7 +3719,7 @@ export interface NumberFormatOutput { numberInstance?: NumberFormatOutput; parseIntegerOnly?: boolean; percentInstance?: NumberFormatOutput; - roundingMode?: string; + roundingMode?: RoundingModeOutput; } // @public @@ -3618,6 +3734,10 @@ export type PurviewDataMapClient = Client & { path: Routes; }; +// @public +export interface PurviewDataMapClientOptions extends ClientOptions { +} + // @public export interface PurviewObjectId { displayText?: string; @@ -3655,17 +3775,23 @@ export interface QueryOptions { // @public export interface QueryResultOutput { + "@search.count"?: number; + "@search.count.approximate"?: boolean; + "@search.facets"?: SearchFacetResultValueOutput; continuationToken?: string; - searchCount?: number; - searchCountApproximate?: boolean; - searchFacets?: SearchFacetResultValueOutput; value?: Array; } +// @public +export type RelationshipCategory = string; + +// @public +export type RelationshipCategoryOutput = string; + // @public (undocumented) export interface RelationshipCreate { - post(options?: RelationshipCreateParameters): StreamableMethod; - put(options?: RelationshipUpdateParameters): StreamableMethod; + post(options: RelationshipCreateParameters): StreamableMethod; + put(options: RelationshipUpdateParameters): StreamableMethod; } // @public @@ -3678,8 +3804,7 @@ export interface RelationshipCreate200Response extends HttpResponse { // @public (undocumented) export interface RelationshipCreateBodyParam { - // (undocumented) - body?: AtlasRelationship; + body: AtlasRelationship; } // @public (undocumented) @@ -3694,13 +3819,13 @@ export interface RelationshipCreateDefaultResponse extends HttpResponse { export type RelationshipCreateParameters = RelationshipCreateBodyParam & RequestParameters; // @public -export interface RelationshipDeleteOperation204Response extends HttpResponse { +export interface RelationshipDelete204Response extends HttpResponse { // (undocumented) status: "204"; } // @public (undocumented) -export interface RelationshipDeleteOperationDefaultResponse extends HttpResponse { +export interface RelationshipDeleteDefaultResponse extends HttpResponse { // (undocumented) body: AtlasErrorResponseOutput; // (undocumented) @@ -3712,7 +3837,7 @@ export type RelationshipDeleteParameters = RequestParameters; // @public (undocumented) export interface RelationshipGet { - delete(options?: RelationshipDeleteParameters): StreamableMethod; + delete(options?: RelationshipDeleteParameters): StreamableMethod; get(options?: RelationshipGetParameters): StreamableMethod; } @@ -3756,8 +3881,7 @@ export interface RelationshipUpdate200Response extends HttpResponse { // @public (undocumented) export interface RelationshipUpdateBodyParam { - // (undocumented) - body?: AtlasRelationship; + body: AtlasRelationship; } // @public (undocumented) @@ -3783,6 +3907,12 @@ export interface ResourceLinkOutput { url?: string; } +// @public +export type RoundingMode = string; + +// @public +export type RoundingModeOutput = string; + // @public (undocumented) export interface Routes { (path: "/atlas/v2/entity"): EntityCreateOrUpdate; @@ -3881,8 +4011,8 @@ export interface SearchFacetResultValueOutput { // @public export interface SearchFacetSort { - count?: string; - value?: string; + count?: SearchSortOrder; + value?: SearchSortOrder; } // @public @@ -3896,6 +4026,8 @@ export interface SearchHighlightsOutput { // @public export interface SearchResultValueOutput { + "@search.highlights"?: SearchHighlightsOutput; + "@search.score"?: number; assetType?: string[]; classification?: string[]; contact?: Array; @@ -3912,20 +4044,30 @@ export interface SearchResultValueOutput { objectType?: string; owner?: string; qualifiedName?: string; - searchHighlights?: SearchHighlightsOutput; - searchScore?: number; term?: Array; termStatus?: string; termTemplate?: string[]; updateTime?: number; } +// @public +export type SearchSortOrder = string; + // @public export interface SearchTaxonomySetting { assetTypes?: string[]; facet?: SearchFacetItem; } +// @public +export type SortTypeOutput = string; + +// @public +export type StatusAtlasRelationship = string; + +// @public +export type StatusAtlasRelationshipOutput = string; + // @public export interface SuggestOptions { filter?: unknown; @@ -3940,6 +4082,8 @@ export interface SuggestResultOutput { // @public export interface SuggestResultValueOutput { + "@search.score"?: number; + "@search.text"?: string; assetType?: string[]; classification?: string[]; contact?: Array; @@ -3956,8 +4100,6 @@ export interface SuggestResultValueOutput { objectType?: string; owner?: string; qualifiedName?: string; - searchScore?: number; - searchText?: string; term?: Array; termStatus?: string; termTemplate?: string[]; @@ -3971,10 +4113,16 @@ export interface TermSearchResultValueOutput { name?: string; } +// @public +export type TermStatus = string; + +// @public +export type TermStatusOutput = string; + // @public export interface TermTemplateDef { attributeDefs?: Array; - category?: string; + category?: TypeCategory; createdBy?: string; createTime?: number; dateFormatter?: DateFormat; @@ -3993,7 +4141,7 @@ export interface TermTemplateDef { // @public export interface TermTemplateDefOutput { attributeDefs?: Array; - category?: string; + category?: TypeCategoryOutput; createdBy?: string; createTime?: number; dateFormatter?: DateFormatOutput; @@ -4053,8 +4201,7 @@ export interface TypeBulkCreate200Response extends HttpResponse { // @public (undocumented) export interface TypeBulkCreateBodyParam { - // (undocumented) - body?: AtlasTypesDef; + body: AtlasTypesDef; } // @public (undocumented) @@ -4076,8 +4223,7 @@ export interface TypeBulkDelete204Response extends HttpResponse { // @public (undocumented) export interface TypeBulkDeleteBodyParam { - // (undocumented) - body?: AtlasTypesDef; + body: AtlasTypesDef; } // @public (undocumented) @@ -4101,8 +4247,7 @@ export interface TypeBulkUpdate200Response extends HttpResponse { // @public (undocumented) export interface TypeBulkUpdateBodyParam { - // (undocumented) - body?: AtlasTypesDef; + body: AtlasTypesDef; } // @public (undocumented) @@ -4117,13 +4262,19 @@ export interface TypeBulkUpdateDefaultResponse extends HttpResponse { export type TypeBulkUpdateParameters = TypeBulkUpdateBodyParam & RequestParameters; // @public -export interface TypeDeleteOperation204Response extends HttpResponse { +export type TypeCategory = string; + +// @public +export type TypeCategoryOutput = string; + +// @public +export interface TypeDelete204Response extends HttpResponse { // (undocumented) status: "204"; } // @public (undocumented) -export interface TypeDeleteOperationDefaultResponse extends HttpResponse { +export interface TypeDeleteDefaultResponse extends HttpResponse { // (undocumented) body: AtlasErrorResponseOutput; // (undocumented) @@ -4207,7 +4358,7 @@ export type TypeGetByGuidParameters = RequestParameters; // @public (undocumented) export interface TypeGetByName { - delete(options?: TypeDeleteParameters): StreamableMethod; + delete(options?: TypeDeleteParameters): StreamableMethod; get(options?: TypeGetByNameParameters): StreamableMethod; } @@ -4492,7 +4643,18 @@ export interface TypeGetTermTemplateDefByGuidDefaultResponse extends HttpRespons } // @public (undocumented) -export type TypeGetTermTemplateDefByGuidParameters = RequestParameters; +export type TypeGetTermTemplateDefByGuidParameters = TypeGetTermTemplateDefByGuidQueryParam & RequestParameters; + +// @public (undocumented) +export interface TypeGetTermTemplateDefByGuidQueryParam { + // (undocumented) + queryParameters: TypeGetTermTemplateDefByGuidQueryParamProperties; +} + +// @public (undocumented) +export interface TypeGetTermTemplateDefByGuidQueryParamProperties { + "api-version": string; +} // @public (undocumented) export interface TypeGetTermTemplateDefByName { @@ -4516,14 +4678,25 @@ export interface TypeGetTermTemplateDefByNameDefaultResponse extends HttpRespons } // @public (undocumented) -export type TypeGetTermTemplateDefByNameParameters = RequestParameters; +export type TypeGetTermTemplateDefByNameParameters = TypeGetTermTemplateDefByNameQueryParam & RequestParameters; + +// @public (undocumented) +export interface TypeGetTermTemplateDefByNameQueryParam { + // (undocumented) + queryParameters: TypeGetTermTemplateDefByNameQueryParamProperties; +} + +// @public (undocumented) +export interface TypeGetTermTemplateDefByNameQueryParamProperties { + "api-version": string; +} // @public (undocumented) export interface TypeList { - delete(options?: TypeBulkDeleteParameters): StreamableMethod; + delete(options: TypeBulkDeleteParameters): StreamableMethod; get(options?: TypeListParameters): StreamableMethod; - post(options?: TypeBulkCreateParameters): StreamableMethod; - put(options?: TypeBulkUpdateParameters): StreamableMethod; + post(options: TypeBulkCreateParameters): StreamableMethod; + put(options: TypeBulkUpdateParameters): StreamableMethod; } // @public @@ -4574,8 +4747,9 @@ export interface TypeListHeadersQueryParam { // @public (undocumented) export interface TypeListHeadersQueryParamProperties { + "api-version"?: string; includeTermTemplate?: boolean; - type?: string; + type?: TypeCategory; } // @public (undocumented) @@ -4589,8 +4763,9 @@ export interface TypeListQueryParam { // @public (undocumented) export interface TypeListQueryParamProperties { + "api-version"?: string; includeTermTemplate?: boolean; - type?: string; + type?: TypeCategory; } // (No @packageDocumentation comment for this package) diff --git a/sdk/purview/purview-datamap-rest/src/clientDefinitions.ts b/sdk/purview/purview-datamap-rest/src/clientDefinitions.ts index 3f1b09802c78..e5e669b3141c 100644 --- a/sdk/purview/purview-datamap-rest/src/clientDefinitions.ts +++ b/sdk/purview/purview-datamap-rest/src/clientDefinitions.ts @@ -114,8 +114,8 @@ import type { EntityGetDefaultResponse, EntityPartialUpdateAttributeByGuid200Response, EntityPartialUpdateAttributeByGuidDefaultResponse, - EntityDeleteOperation200Response, - EntityDeleteOperationDefaultResponse, + EntityDelete200Response, + EntityDeleteDefaultResponse, EntityGetClassification200Response, EntityGetClassificationDefaultResponse, EntityRemoveClassification204Response, @@ -214,8 +214,8 @@ import type { GlossaryGetDefaultResponse, GlossaryUpdate200Response, GlossaryUpdateDefaultResponse, - GlossaryDeleteOperation204Response, - GlossaryDeleteOperationDefaultResponse, + GlossaryDelete204Response, + GlossaryDeleteDefaultResponse, GlossaryListCategories200Response, GlossaryListCategoriesDefaultResponse, GlossaryListCategoriesHeaders200Response, @@ -246,8 +246,8 @@ import type { RelationshipUpdateDefaultResponse, RelationshipGet200Response, RelationshipGetDefaultResponse, - RelationshipDeleteOperation204Response, - RelationshipDeleteOperationDefaultResponse, + RelationshipDelete204Response, + RelationshipDeleteDefaultResponse, TypeGetBusinessMetadataDefByGuid200Response, TypeGetBusinessMetadataDefByGuidDefaultResponse, TypeGetBusinessMetadataDefByName200Response, @@ -276,8 +276,8 @@ import type { TypeGetByGuidDefaultResponse, TypeGetByName200Response, TypeGetByNameDefaultResponse, - TypeDeleteOperation204Response, - TypeDeleteOperationDefaultResponse, + TypeDelete204Response, + TypeDeleteDefaultResponse, TypeList200Response, TypeListDefaultResponse, TypeBulkCreate200Response, @@ -306,7 +306,7 @@ export interface EntityCreateOrUpdate { * For each contact type, the maximum number of contacts is 20. */ post( - options?: EntityCreateOrUpdateParameters, + options: EntityCreateOrUpdateParameters, ): StreamableMethod; } @@ -326,7 +326,7 @@ export interface EntityListByGuids { * is 20. */ post( - options?: EntityBulkCreateOrUpdateParameters, + options: EntityBulkCreateOrUpdateParameters, ): StreamableMethod< EntityBulkCreateOrUpdate200Response | EntityBulkCreateOrUpdateDefaultResponse >; @@ -342,7 +342,7 @@ export interface EntityListByGuids { export interface EntityAddClassification { /** Associate a classification to multiple entities in bulk. */ post( - options?: EntityAddClassificationParameters, + options: EntityAddClassificationParameters, ): StreamableMethod; } @@ -367,7 +367,7 @@ export interface EntityGet { /** Delete an entity identified by its GUID. */ delete( options?: EntityDeleteParameters, - ): StreamableMethod; + ): StreamableMethod; } export interface EntityGetClassification { @@ -445,7 +445,7 @@ export interface EntityGetByUniqueAttributes { * /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. */ put( - options?: EntityPartialUpdateByUniqueAttributesParameters, + options: EntityPartialUpdateByUniqueAttributesParameters, ): StreamableMethod< | EntityPartialUpdateByUniqueAttributes200Response | EntityPartialUpdateByUniqueAttributesDefaultResponse @@ -504,7 +504,7 @@ export interface EntityAddClassificationsByUniqueAttribute { export interface EntityBulkSetClassifications { /** Set classifications on entities in bulk. */ post( - options?: EntityBulkSetClassificationsParameters, + options: EntityBulkSetClassificationsParameters, ): StreamableMethod< EntityBulkSetClassifications200Response | EntityBulkSetClassificationsDefaultResponse >; @@ -692,19 +692,15 @@ export interface GlossaryList { /** * 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/{glossaryId}/terms' - * and - * - * 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. + * separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' + * and 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'. */ get( options?: GlossaryListParameters, ): StreamableMethod; /** Create a glossary. */ post( - options?: GlossaryCreateParameters, + options: GlossaryCreateParameters, ): StreamableMethod; } @@ -720,7 +716,7 @@ export interface GlossaryCreateCategories { export interface GlossaryCreateCategory { /** Create a glossary category. */ post( - options?: GlossaryCreateCategoryParameters, + options: GlossaryCreateCategoryParameters, ): StreamableMethod; } @@ -731,7 +727,7 @@ export interface GlossaryGetCategory { ): StreamableMethod; /** Update the given glossary category by its GUID. */ put( - options?: GlossaryUpdateCategoryParameters, + options: GlossaryUpdateCategoryParameters, ): StreamableMethod; /** Delete a glossary category. */ delete( @@ -775,7 +771,7 @@ export interface GlossaryListCategoryTerms { export interface GlossaryCreateTerm { /** Create a glossary term. */ post( - options?: GlossaryCreateTermParameters, + options: GlossaryCreateTermParameters, ): StreamableMethod; } @@ -786,7 +782,7 @@ export interface GlossaryGetTerm { ): StreamableMethod; /** Update the given glossary term by its GUID. */ put( - options?: GlossaryUpdateTermParameters, + options: GlossaryUpdateTermParameters, ): StreamableMethod; /** Delete a glossary term. */ delete( @@ -865,7 +861,7 @@ export interface GlossaryGet { ): StreamableMethod; /** Update the given glossary. */ put( - options?: GlossaryUpdateParameters, + options: GlossaryUpdateParameters, ): StreamableMethod; /** * Delete a glossary. Will delete underlying terms/categories together. Recommend @@ -873,7 +869,7 @@ export interface GlossaryGet { */ delete( options?: GlossaryDeleteParameters, - ): StreamableMethod; + ): StreamableMethod; } export interface GlossaryListCategories { @@ -953,21 +949,21 @@ export interface GlossaryListTermHeaders { export interface DiscoveryQuery { /** Get data using search. */ post( - options?: DiscoveryQueryParameters, + options: DiscoveryQueryParameters, ): StreamableMethod; } export interface DiscoverySuggest { /** Get search suggestions by query criteria. */ post( - options?: DiscoverySuggestParameters, + options: DiscoverySuggestParameters, ): StreamableMethod; } export interface DiscoveryAutoComplete { /** Get auto complete options. */ post( - options?: DiscoveryAutoCompleteParameters, + options: DiscoveryAutoCompleteParameters, ): StreamableMethod; } @@ -1014,11 +1010,11 @@ export interface LineageGetByUniqueAttribute { export interface RelationshipCreate { /** Create a new relationship between entities. */ post( - options?: RelationshipCreateParameters, + options: RelationshipCreateParameters, ): StreamableMethod; /** Update an existing relationship between entities. */ put( - options?: RelationshipUpdateParameters, + options: RelationshipUpdateParameters, ): StreamableMethod; } @@ -1030,9 +1026,7 @@ export interface RelationshipGet { /** Delete a relationship between entities by its GUID. */ delete( options?: RelationshipDeleteParameters, - ): StreamableMethod< - RelationshipDeleteOperation204Response | RelationshipDeleteOperationDefaultResponse - >; + ): StreamableMethod; } export interface TypeGetBusinessMetadataDefByGuid { @@ -1146,7 +1140,7 @@ export interface TypeGetByName { /** Delete API for type identified by its name. */ delete( options?: TypeDeleteParameters, - ): StreamableMethod; + ): StreamableMethod; } export interface TypeList { @@ -1154,24 +1148,20 @@ export interface TypeList { get( options?: TypeListParameters, ): StreamableMethod; - /** - * Create all atlas type definitions in bulk, only new definitions will be - * created. - * Any changes to the existing definitions will be discarded. - */ + /** Create all atlas type definitions in bulk. Please avoid recreating existing types. */ post( - options?: TypeBulkCreateParameters, + options: TypeBulkCreateParameters, ): StreamableMethod; /** * Update all types in bulk, changes detected in the type definitions would be * persisted. */ put( - options?: TypeBulkUpdateParameters, + options: TypeBulkUpdateParameters, ): StreamableMethod; /** Delete API for all types in bulk. */ delete( - options?: TypeBulkDeleteParameters, + options: TypeBulkDeleteParameters, ): StreamableMethod; } diff --git a/sdk/purview/purview-datamap-rest/src/isUnexpected.ts b/sdk/purview/purview-datamap-rest/src/isUnexpected.ts index aca467e40c65..28d827fbe3a5 100644 --- a/sdk/purview/purview-datamap-rest/src/isUnexpected.ts +++ b/sdk/purview/purview-datamap-rest/src/isUnexpected.ts @@ -16,8 +16,8 @@ import type { EntityGetDefaultResponse, EntityPartialUpdateAttributeByGuid200Response, EntityPartialUpdateAttributeByGuidDefaultResponse, - EntityDeleteOperation200Response, - EntityDeleteOperationDefaultResponse, + EntityDelete200Response, + EntityDeleteDefaultResponse, EntityGetClassification200Response, EntityGetClassificationDefaultResponse, EntityRemoveClassification204Response, @@ -116,8 +116,8 @@ import type { GlossaryGetDefaultResponse, GlossaryUpdate200Response, GlossaryUpdateDefaultResponse, - GlossaryDeleteOperation204Response, - GlossaryDeleteOperationDefaultResponse, + GlossaryDelete204Response, + GlossaryDeleteDefaultResponse, GlossaryListCategories200Response, GlossaryListCategoriesDefaultResponse, GlossaryListCategoriesHeaders200Response, @@ -148,8 +148,8 @@ import type { RelationshipUpdateDefaultResponse, RelationshipGet200Response, RelationshipGetDefaultResponse, - RelationshipDeleteOperation204Response, - RelationshipDeleteOperationDefaultResponse, + RelationshipDelete204Response, + RelationshipDeleteDefaultResponse, TypeGetBusinessMetadataDefByGuid200Response, TypeGetBusinessMetadataDefByGuidDefaultResponse, TypeGetBusinessMetadataDefByName200Response, @@ -178,8 +178,8 @@ import type { TypeGetByGuidDefaultResponse, TypeGetByName200Response, TypeGetByNameDefaultResponse, - TypeDeleteOperation204Response, - TypeDeleteOperationDefaultResponse, + TypeDelete204Response, + TypeDeleteDefaultResponse, TypeList200Response, TypeListDefaultResponse, TypeBulkCreate200Response, @@ -321,8 +321,8 @@ export function isUnexpected( | EntityPartialUpdateAttributeByGuidDefaultResponse, ): response is EntityPartialUpdateAttributeByGuidDefaultResponse; export function isUnexpected( - response: EntityDeleteOperation200Response | EntityDeleteOperationDefaultResponse, -): response is EntityDeleteOperationDefaultResponse; + response: EntityDelete200Response | EntityDeleteDefaultResponse, +): response is EntityDeleteDefaultResponse; export function isUnexpected( response: EntityGetClassification200Response | EntityGetClassificationDefaultResponse, ): response is EntityGetClassificationDefaultResponse; @@ -499,8 +499,8 @@ export function isUnexpected( response: GlossaryUpdate200Response | GlossaryUpdateDefaultResponse, ): response is GlossaryUpdateDefaultResponse; export function isUnexpected( - response: GlossaryDeleteOperation204Response | GlossaryDeleteOperationDefaultResponse, -): response is GlossaryDeleteOperationDefaultResponse; + response: GlossaryDelete204Response | GlossaryDeleteDefaultResponse, +): response is GlossaryDeleteDefaultResponse; export function isUnexpected( response: GlossaryListCategories200Response | GlossaryListCategoriesDefaultResponse, ): response is GlossaryListCategoriesDefaultResponse; @@ -547,8 +547,8 @@ export function isUnexpected( response: RelationshipGet200Response | RelationshipGetDefaultResponse, ): response is RelationshipGetDefaultResponse; export function isUnexpected( - response: RelationshipDeleteOperation204Response | RelationshipDeleteOperationDefaultResponse, -): response is RelationshipDeleteOperationDefaultResponse; + response: RelationshipDelete204Response | RelationshipDeleteDefaultResponse, +): response is RelationshipDeleteDefaultResponse; export function isUnexpected( response: | TypeGetBusinessMetadataDefByGuid200Response @@ -600,8 +600,8 @@ export function isUnexpected( response: TypeGetByName200Response | TypeGetByNameDefaultResponse, ): response is TypeGetByNameDefaultResponse; export function isUnexpected( - response: TypeDeleteOperation204Response | TypeDeleteOperationDefaultResponse, -): response is TypeDeleteOperationDefaultResponse; + response: TypeDelete204Response | TypeDeleteDefaultResponse, +): response is TypeDeleteDefaultResponse; export function isUnexpected( response: TypeList200Response | TypeListDefaultResponse, ): response is TypeListDefaultResponse; @@ -639,8 +639,8 @@ export function isUnexpected( | EntityGetDefaultResponse | EntityPartialUpdateAttributeByGuid200Response | EntityPartialUpdateAttributeByGuidDefaultResponse - | EntityDeleteOperation200Response - | EntityDeleteOperationDefaultResponse + | EntityDelete200Response + | EntityDeleteDefaultResponse | EntityGetClassification200Response | EntityGetClassificationDefaultResponse | EntityRemoveClassification204Response @@ -739,8 +739,8 @@ export function isUnexpected( | GlossaryGetDefaultResponse | GlossaryUpdate200Response | GlossaryUpdateDefaultResponse - | GlossaryDeleteOperation204Response - | GlossaryDeleteOperationDefaultResponse + | GlossaryDelete204Response + | GlossaryDeleteDefaultResponse | GlossaryListCategories200Response | GlossaryListCategoriesDefaultResponse | GlossaryListCategoriesHeaders200Response @@ -771,8 +771,8 @@ export function isUnexpected( | RelationshipUpdateDefaultResponse | RelationshipGet200Response | RelationshipGetDefaultResponse - | RelationshipDeleteOperation204Response - | RelationshipDeleteOperationDefaultResponse + | RelationshipDelete204Response + | RelationshipDeleteDefaultResponse | TypeGetBusinessMetadataDefByGuid200Response | TypeGetBusinessMetadataDefByGuidDefaultResponse | TypeGetBusinessMetadataDefByName200Response @@ -801,8 +801,8 @@ export function isUnexpected( | TypeGetByGuidDefaultResponse | TypeGetByName200Response | TypeGetByNameDefaultResponse - | TypeDeleteOperation204Response - | TypeDeleteOperationDefaultResponse + | TypeDelete204Response + | TypeDeleteDefaultResponse | TypeList200Response | TypeListDefaultResponse | TypeBulkCreate200Response @@ -825,7 +825,7 @@ export function isUnexpected( | EntityAddClassificationDefaultResponse | EntityGetDefaultResponse | EntityPartialUpdateAttributeByGuidDefaultResponse - | EntityDeleteOperationDefaultResponse + | EntityDeleteDefaultResponse | EntityGetClassificationDefaultResponse | EntityRemoveClassificationDefaultResponse | EntityGetClassificationsDefaultResponse @@ -875,7 +875,7 @@ export function isUnexpected( | GlossaryListRelatedTermsDefaultResponse | GlossaryGetDefaultResponse | GlossaryUpdateDefaultResponse - | GlossaryDeleteOperationDefaultResponse + | GlossaryDeleteDefaultResponse | GlossaryListCategoriesDefaultResponse | GlossaryListCategoriesHeadersDefaultResponse | GlossaryGetDetailedDefaultResponse @@ -891,7 +891,7 @@ export function isUnexpected( | RelationshipCreateDefaultResponse | RelationshipUpdateDefaultResponse | RelationshipGetDefaultResponse - | RelationshipDeleteOperationDefaultResponse + | RelationshipDeleteDefaultResponse | TypeGetBusinessMetadataDefByGuidDefaultResponse | TypeGetBusinessMetadataDefByNameDefaultResponse | TypeGetClassificationDefByGuidDefaultResponse @@ -906,7 +906,7 @@ export function isUnexpected( | TypeGetStructDefByNameDefaultResponse | TypeGetByGuidDefaultResponse | TypeGetByNameDefaultResponse - | TypeDeleteOperationDefaultResponse + | TypeDeleteDefaultResponse | TypeListDefaultResponse | TypeBulkCreateDefaultResponse | TypeBulkUpdateDefaultResponse diff --git a/sdk/purview/purview-datamap-rest/src/models.ts b/sdk/purview/purview-datamap-rest/src/models.ts index d01c2b3b99f6..c3a8f178a7ed 100644 --- a/sdk/purview/purview-datamap-rest/src/models.ts +++ b/sdk/purview/purview-datamap-rest/src/models.ts @@ -52,7 +52,7 @@ export interface AtlasEntity { * * Possible values: "ACTIVE", "DELETED" */ - status?: string; + status?: EntityStatus; /** The update time of the record. */ updateTime?: number; /** The user who updated the record. */ @@ -82,7 +82,7 @@ export interface AtlasClassification { * * Possible values: "ACTIVE", "DELETED" */ - entityStatus?: string; + entityStatus?: EntityStatus; /** Determines if propagations will be removed on entity deletion. */ removePropagationsOnEntityDelete?: boolean; /** An array of time boundaries indicating validity periods. */ @@ -118,7 +118,7 @@ export interface AtlasTermAssignmentHeader { * * Possible values: "DISCOVERED", "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER" */ - status?: string; + status?: AtlasTermAssignmentStatus; /** The steward of the term. */ steward?: string; /** The GUID of the term. */ @@ -163,7 +163,7 @@ export interface AtlasEntityHeader { * * Possible values: "ACTIVE", "DELETED" */ - status?: string; + status?: EntityStatus; } /** @@ -194,15 +194,11 @@ export interface AtlasEntityHeaders { guidHeaderMap?: Record; } -/** Business metadata to send to the service */ -export interface BusinessMetadataOptions { - /** - * InputStream of file - * - * NOTE: The following type 'File' is part of WebAPI and available since Node 20. If your Node version is lower than Node 20. - * You could leverage our helpers 'createFile' or 'createFileFromStream' to create a File object. They could help you specify filename, type, and others. - */ - file: string | Uint8Array | ReadableStream | NodeJS.ReadableStream | File; +export interface BusinessMetadataOptionsFilePartDescriptor { + name: "file"; + body: string | Uint8Array | ReadableStream | NodeJS.ReadableStream | File; + filename?: string; + contentType?: string; } /** MoveEntitiesOptions */ @@ -274,7 +270,7 @@ export interface AtlasRelatedTermHeader { * * Possible values: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", "OTHER" */ - status?: string; + status?: AtlasTermRelationshipStatus; /** The steward of the term. */ steward?: string; /** The GUID of the term. */ @@ -362,7 +358,7 @@ export interface AtlasGlossaryTerm { * * Possible values: "Draft", "Approved", "Alert", "Expired" */ - status?: string; + status?: TermStatus; /** The nick name of the term. */ nickName?: string; /** The hierarchy information of the term. */ @@ -458,7 +454,7 @@ export interface AtlasRelatedObjectId { * * Possible values: "ACTIVE", "DELETED" */ - entityStatus?: string; + entityStatus?: EntityStatus; /** Relationship type */ relationshipType?: string; /** @@ -473,7 +469,7 @@ export interface AtlasRelatedObjectId { * * Possible values: "ACTIVE", "DELETED" */ - relationshipStatus?: string; + relationshipStatus?: StatusAtlasRelationship; } /** @@ -504,7 +500,7 @@ export interface AtlasTermCategorizationHeader { * * Possible values: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", "OTHER" */ - status?: string; + status?: AtlasTermRelationshipStatus; } /** The search query of advanced search request. */ @@ -548,13 +544,13 @@ export interface SearchFacetSort { * * Possible values: "asc", "desc" */ - count?: string; + count?: SearchSortOrder; /** * Order by value * * Possible values: "asc", "desc" */ - value?: string; + value?: SearchSortOrder; } /** Taxonomy setting for search request */ @@ -628,7 +624,7 @@ export interface AtlasRelationship { * * Possible values: "ACTIVE", "DELETED" */ - status?: string; + status?: StatusAtlasRelationship; /** The update time of the record. */ updateTime?: number; /** The user who updated the record. */ @@ -654,7 +650,7 @@ export interface AtlasBusinessMetadataDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -740,7 +736,7 @@ export interface NumberFormat { * * Possible values: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY" */ - roundingMode?: string; + roundingMode?: RoundingMode; } /** The timezone information. */ @@ -766,7 +762,7 @@ export interface AtlasAttributeDef { * * Possible values: "SINGLE", "LIST", "SET" */ - cardinality?: string; + cardinality?: CardinalityValue; /** An array of constraints. */ constraints?: Array; /** The default value of the attribute. */ @@ -808,7 +804,7 @@ export interface AtlasClassificationDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -875,7 +871,7 @@ export interface AtlasEntityDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -924,7 +920,7 @@ export interface AtlasRelationshipAttributeDef { * * Possible values: "SINGLE", "LIST", "SET" */ - cardinality?: string; + cardinality?: CardinalityValue; /** An array of constraints. */ constraints?: Array; /** The default value of the attribute. */ @@ -962,7 +958,7 @@ export interface AtlasEnumDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1051,7 +1047,7 @@ export interface AtlasRelationshipDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1106,7 +1102,7 @@ export interface AtlasRelationshipDef { * * Possible values: "ASSOCIATION", "AGGREGATION", "COMPOSITION" */ - relationshipCategory?: string; + relationshipCategory?: RelationshipCategory; /** The label of the relationship. */ relationshipLabel?: string; } @@ -1123,7 +1119,7 @@ export interface AtlasRelationshipEndDef { * * Possible values: "SINGLE", "LIST", "SET" */ - cardinality?: string; + cardinality?: CardinalityValue; /** The description of the relationship end definition. */ description?: string; /** Determines if it is container. */ @@ -1143,7 +1139,7 @@ export interface AtlasStructDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1199,7 +1195,7 @@ export interface TermTemplateDef { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategory; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1229,3 +1225,30 @@ export interface TermTemplateDef { /** An array of attribute definitions. */ attributeDefs?: Array; } + +/** Alias for BusinessAttributeUpdateBehavior */ +export type BusinessAttributeUpdateBehavior = string; +/** Alias for EntityStatus */ +export type EntityStatus = string; +/** Alias for AtlasTermAssignmentStatus */ +export type AtlasTermAssignmentStatus = string; +/** Business metadata to send to the service */ +export type BusinessMetadataOptions = FormData | Array; +/** Alias for AtlasTermRelationshipStatus */ +export type AtlasTermRelationshipStatus = string; +/** Alias for TermStatus */ +export type TermStatus = string; +/** Alias for StatusAtlasRelationship */ +export type StatusAtlasRelationship = string; +/** Alias for SearchSortOrder */ +export type SearchSortOrder = string; +/** Alias for LineageDirection */ +export type LineageDirection = string; +/** Alias for TypeCategory */ +export type TypeCategory = string; +/** Alias for RoundingMode */ +export type RoundingMode = string; +/** Alias for CardinalityValue */ +export type CardinalityValue = string; +/** Alias for RelationshipCategory */ +export type RelationshipCategory = string; diff --git a/sdk/purview/purview-datamap-rest/src/outputModels.ts b/sdk/purview/purview-datamap-rest/src/outputModels.ts index e8d6ec311647..51cab200410e 100644 --- a/sdk/purview/purview-datamap-rest/src/outputModels.ts +++ b/sdk/purview/purview-datamap-rest/src/outputModels.ts @@ -54,7 +54,7 @@ export interface AtlasEntityOutput { * * Possible values: "ACTIVE", "DELETED" */ - status?: string; + status?: EntityStatusOutput; /** The update time of the record. */ updateTime?: number; /** The user who updated the record. */ @@ -84,7 +84,7 @@ export interface AtlasClassificationOutput { * * Possible values: "ACTIVE", "DELETED" */ - entityStatus?: string; + entityStatus?: EntityStatusOutput; /** Determines if propagations will be removed on entity deletion. */ removePropagationsOnEntityDelete?: boolean; /** An array of time boundaries indicating validity periods. */ @@ -120,7 +120,7 @@ export interface AtlasTermAssignmentHeaderOutput { * * Possible values: "DISCOVERED", "PROPOSED", "IMPORTED", "VALIDATED", "DEPRECATED", "OBSOLETE", "OTHER" */ - status?: string; + status?: AtlasTermAssignmentStatusOutput; /** The steward of the term. */ steward?: string; /** The GUID of the term. */ @@ -175,7 +175,7 @@ export interface AtlasEntityHeaderOutput { * * Possible values: "ACTIVE", "DELETED" */ - status?: string; + status?: EntityStatusOutput; } /** An error response from the service */ @@ -212,24 +212,13 @@ export interface AtlasClassificationsOutput { * * Possible values: "NONE", "ASC", "DESC" */ - sortType?: string; + sortType?: SortTypeOutput; /** The start index of the page. */ startIndex?: number; /** The total count of items. */ totalCount?: number; } -/** Business metadata to send to the service */ -export interface BusinessMetadataOptionsOutput { - /** - * InputStream of file - * - * NOTE: The following type 'File' is part of WebAPI and available since Node 20. If your Node version is lower than Node 20. - * You could leverage our helpers 'createFile' or 'createFileFromStream' to create a File object. They could help you specify filename, type, and others. - */ - file: Uint8Array; -} - /** Bulk import result */ export interface BulkImportResultOutput { /** failed importInfoList */ @@ -247,7 +236,7 @@ export interface ImportInfoOutput { * * Possible values: "SUCCESS", "FAILED" */ - importStatus?: string; + importStatus?: ImportStatusOutput; /** parentObjectName */ parentObjectName?: string; /** remarks */ @@ -317,7 +306,7 @@ export interface AtlasRelatedTermHeaderOutput { * * Possible values: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", "OTHER" */ - status?: string; + status?: AtlasTermRelationshipStatusOutput; /** The steward of the term. */ steward?: string; /** The GUID of the term. */ @@ -405,7 +394,7 @@ export interface AtlasGlossaryTermOutput { * * Possible values: "Draft", "Approved", "Alert", "Expired" */ - status?: string; + status?: TermStatusOutput; /** The nick name of the term. */ nickName?: string; /** The hierarchy information of the term. */ @@ -501,7 +490,7 @@ export interface AtlasRelatedObjectIdOutput { * * Possible values: "ACTIVE", "DELETED" */ - entityStatus?: string; + entityStatus?: EntityStatusOutput; /** Relationship type */ relationshipType?: string; /** @@ -516,7 +505,7 @@ export interface AtlasRelatedObjectIdOutput { * * Possible values: "ACTIVE", "DELETED" */ - relationshipStatus?: string; + relationshipStatus?: StatusAtlasRelationshipOutput; } /** @@ -547,7 +536,7 @@ export interface AtlasTermCategorizationHeaderOutput { * * Possible values: "DRAFT", "ACTIVE", "DEPRECATED", "OBSOLETE", "OTHER" */ - status?: string; + status?: AtlasTermRelationshipStatusOutput; } /** The extended information of glossary. */ @@ -594,9 +583,9 @@ export interface QueryResultOutput { * The total number of search results (not the number of documents in a single * page). */ - searchCount?: number; + "@search.count"?: number; /** 'True' if the '@search.count' is an approximate value and vise versa. */ - searchCountApproximate?: boolean; + "@search.count.approximate"?: boolean; /** The token used to get next batch of data. Absent if there's no more data. */ continuationToken?: string; /** @@ -604,7 +593,7 @@ export interface QueryResultOutput { * contactId, and label. When the facet is specified in the request, the value of * the facet is returned as an element of @search.facets. */ - searchFacets?: SearchFacetResultValueOutput; + "@search.facets"?: SearchFacetResultValueOutput; /** Search result value */ value?: Array; } @@ -651,14 +640,14 @@ export interface SearchResultValueOutput { * The search score calculated by the search engine. The results are ordered by * search score by default. */ - searchScore?: number; + "@search.score"?: number; /** * 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. */ - searchHighlights?: SearchHighlightsOutput; + "@search.highlights"?: SearchHighlightsOutput; /** * The object type of the record. Object type is the top-level property to * distinguish whether a record is an asset or a term. @@ -761,12 +750,12 @@ export interface SuggestResultValueOutput { * The search score calculated by the search engine. The results are ordered by * search score by default. */ - searchScore?: number; + "@search.score"?: number; /** * The target text that contains the keyword as prefix. The keyword is wrapped * with emphasis mark. */ - searchText?: string; + "@search.text"?: string; /** * The object type of the record. Object type is the top-level property to * distinguish whether a record is an asset or a term. @@ -848,7 +837,7 @@ export interface AtlasLineageInfoOutput { * * Possible values: "INPUT", "OUTPUT", "BOTH" */ - lineageDirection?: string; + lineageDirection?: LineageDirectionOutput; /** An array of parentRelations relations. */ parentRelations?: Array; /** An array of lineage relations. */ @@ -904,7 +893,7 @@ export interface AtlasRelationshipOutput { * * Possible values: "ACTIVE", "DELETED" */ - status?: string; + status?: StatusAtlasRelationshipOutput; /** The update time of the record. */ updateTime?: number; /** The user who updated the record. */ @@ -938,7 +927,7 @@ export interface AtlasBusinessMetadataDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1024,7 +1013,7 @@ export interface NumberFormatOutput { * * Possible values: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", "UNNECESSARY" */ - roundingMode?: string; + roundingMode?: RoundingModeOutput; } /** The timezone information. */ @@ -1050,7 +1039,7 @@ export interface AtlasAttributeDefOutput { * * Possible values: "SINGLE", "LIST", "SET" */ - cardinality?: string; + cardinality?: CardinalityValueOutput; /** An array of constraints. */ constraints?: Array; /** The default value of the attribute. */ @@ -1092,7 +1081,7 @@ export interface AtlasClassificationDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1159,7 +1148,7 @@ export interface AtlasEntityDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1208,7 +1197,7 @@ export interface AtlasRelationshipAttributeDefOutput { * * Possible values: "SINGLE", "LIST", "SET" */ - cardinality?: string; + cardinality?: CardinalityValueOutput; /** An array of constraints. */ constraints?: Array; /** The default value of the attribute. */ @@ -1246,7 +1235,7 @@ export interface AtlasEnumDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1335,7 +1324,7 @@ export interface AtlasRelationshipDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1390,7 +1379,7 @@ export interface AtlasRelationshipDefOutput { * * Possible values: "ASSOCIATION", "AGGREGATION", "COMPOSITION" */ - relationshipCategory?: string; + relationshipCategory?: RelationshipCategoryOutput; /** The label of the relationship. */ relationshipLabel?: string; } @@ -1407,7 +1396,7 @@ export interface AtlasRelationshipEndDefOutput { * * Possible values: "SINGLE", "LIST", "SET" */ - cardinality?: string; + cardinality?: CardinalityValueOutput; /** The description of the relationship end definition. */ description?: string; /** Determines if it is container. */ @@ -1427,7 +1416,7 @@ export interface AtlasStructDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1465,7 +1454,7 @@ export interface AtlasTypeDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1555,7 +1544,7 @@ export interface AtlasTypeDefOutput { * * Possible values: "ASSOCIATION", "AGGREGATION", "COMPOSITION" */ - relationshipCategory?: string; + relationshipCategory?: RelationshipCategoryOutput; /** The label of the relationship. */ relationshipLabel?: string; /** An array of attribute definitions. */ @@ -1587,7 +1576,7 @@ export interface TermTemplateDefOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The created time of the record. */ createTime?: number; /** The user who created the record. */ @@ -1625,9 +1614,34 @@ export interface AtlasTypeDefHeaderOutput { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - category?: string; + category?: TypeCategoryOutput; /** The GUID of the type definition. */ guid?: string; /** The name of the type definition. */ name?: string; } + +/** Alias for EntityStatusOutput */ +export type EntityStatusOutput = string; +/** Alias for AtlasTermAssignmentStatusOutput */ +export type AtlasTermAssignmentStatusOutput = string; +/** Alias for SortTypeOutput */ +export type SortTypeOutput = string; +/** Alias for ImportStatusOutput */ +export type ImportStatusOutput = string; +/** Alias for AtlasTermRelationshipStatusOutput */ +export type AtlasTermRelationshipStatusOutput = string; +/** Alias for TermStatusOutput */ +export type TermStatusOutput = string; +/** Alias for StatusAtlasRelationshipOutput */ +export type StatusAtlasRelationshipOutput = string; +/** Alias for LineageDirectionOutput */ +export type LineageDirectionOutput = string; +/** Alias for TypeCategoryOutput */ +export type TypeCategoryOutput = string; +/** Alias for RoundingModeOutput */ +export type RoundingModeOutput = string; +/** Alias for CardinalityValueOutput */ +export type CardinalityValueOutput = string; +/** Alias for RelationshipCategoryOutput */ +export type RelationshipCategoryOutput = string; diff --git a/sdk/purview/purview-datamap-rest/src/parameters.ts b/sdk/purview/purview-datamap-rest/src/parameters.ts index 2606c81f1f47..c0a50020bf00 100644 --- a/sdk/purview/purview-datamap-rest/src/parameters.ts +++ b/sdk/purview/purview-datamap-rest/src/parameters.ts @@ -3,6 +3,7 @@ import type { RequestParameters } from "@azure-rest/core-client"; import type { + BusinessAttributeUpdateBehavior, AtlasEntityWithExtInfo, AtlasEntitiesWithExtInfo, ClassificationAssociateOptions, @@ -17,22 +18,27 @@ import type { QueryOptions, SuggestOptions, AutoCompleteOptions, + LineageDirection, AtlasRelationship, + TypeCategory, AtlasTypesDef, } from "./models.js"; export interface EntityCreateOrUpdateBodyParam { - body?: AtlasEntityWithExtInfo; + /** Body parameter. */ + body: AtlasEntityWithExtInfo; } export interface EntityCreateOrUpdateQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** * Used to define the update behavior for business attributes when updating * entities. * * Possible values: "ignore", "replace", "merge" */ - businessAttributeUpdateBehavior?: string; + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; /** * The collection where entities will be moved to. Only specify a value if you * need to move an entity to another collection. @@ -48,9 +54,21 @@ export type EntityCreateOrUpdateParameters = EntityCreateOrUpdateQueryParam & EntityCreateOrUpdateBodyParam & RequestParameters; +/** This is the wrapper object for the parameter `guid` with explode set to true and style set to form. */ +export interface EntityListByGuidsGuidQueryParam { + /** Value of the parameter */ + value: string[]; + /** Should we explode the value? */ + explode: true; + /** Style of the value */ + style: "form"; +} + export interface EntityListByGuidsQueryParamProperties { - /** An array of GUIDs of entities to list. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */ - guid: string; + /** The API version to use for this operation. */ + "api-version"?: string; + /** An array of GUIDs of entities to list. */ + guid: EntityListByGuidsGuidQueryParam; /** Whether to return minimal information for referred entities. */ minExtInfo?: boolean; /** Whether to ignore relationship attributes. */ @@ -64,10 +82,13 @@ export interface EntityListByGuidsQueryParam { export type EntityListByGuidsParameters = EntityListByGuidsQueryParam & RequestParameters; export interface EntityBulkCreateOrUpdateBodyParam { - body?: AtlasEntitiesWithExtInfo; + /** Body parameter. */ + body: AtlasEntitiesWithExtInfo; } export interface EntityBulkCreateOrUpdateQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** * The collection where entities will be moved to. Only specify a value if you * need to move an entity to another collection. @@ -79,7 +100,7 @@ export interface EntityBulkCreateOrUpdateQueryParamProperties { * * Possible values: "ignore", "replace", "merge" */ - businessAttributeUpdateBehavior?: string; + businessAttributeUpdateBehavior?: BusinessAttributeUpdateBehavior; } export interface EntityBulkCreateOrUpdateQueryParam { @@ -90,9 +111,19 @@ export type EntityBulkCreateOrUpdateParameters = EntityBulkCreateOrUpdateQueryPa EntityBulkCreateOrUpdateBodyParam & RequestParameters; +/** This is the wrapper object for the parameter `guid` with explode set to true and style set to form. */ +export interface EntityBulkDeleteGuidQueryParam { + /** Value of the parameter */ + value: string[]; + /** Should we explode the value? */ + explode: true; + /** Style of the value */ + style: "form"; +} + export interface EntityBulkDeleteQueryParamProperties { - /** An array of GUIDs of entities to delete. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */ - guid: string; + /** An array of GUIDs of entities to delete. */ + guid: EntityBulkDeleteGuidQueryParam; } export interface EntityBulkDeleteQueryParam { @@ -102,7 +133,8 @@ export interface EntityBulkDeleteQueryParam { export type EntityBulkDeleteParameters = EntityBulkDeleteQueryParam & RequestParameters; export interface EntityAddClassificationBodyParam { - body?: ClassificationAssociateOptions; + /** Body parameter. */ + body: ClassificationAssociateOptions; } export type EntityAddClassificationParameters = EntityAddClassificationBodyParam & @@ -180,7 +212,8 @@ export type EntityGetByUniqueAttributesParameters = EntityGetByUniqueAttributesQ RequestParameters; export interface EntityPartialUpdateByUniqueAttributesBodyParam { - body?: AtlasEntityWithExtInfo; + /** Body parameter. */ + body: AtlasEntityWithExtInfo; } export interface EntityPartialUpdateByUniqueAttributesQueryParamProperties { @@ -275,7 +308,8 @@ export type EntityUpdateClassificationsByUniqueAttributeParameters = RequestParameters; export interface EntityBulkSetClassificationsBodyParam { - body?: AtlasEntityHeaders; + /** Body parameter. */ + body: AtlasEntityHeaders; } export type EntityBulkSetClassificationsParameters = EntityBulkSetClassificationsBodyParam & @@ -350,7 +384,8 @@ export type EntityAddOrUpdateBusinessMetadataAttributesParameters = export type EntityGetSampleBusinessMetadataTemplateParameters = RequestParameters; export interface EntityImportBusinessMetadataBodyParam { - body?: BusinessMetadataOptions; + /** Body parameter. */ + body: BusinessMetadataOptions; } export interface EntityImportBusinessMetadataMediaTypesParam { @@ -450,10 +485,13 @@ export type EntityAddLabelsByUniqueAttributeParameters = RequestParameters; export interface EntityMoveEntitiesToCollectionBodyParam { - body?: MoveEntitiesOptions; + /** Body parameter. */ + body: MoveEntitiesOptions; } export interface EntityMoveEntitiesToCollectionQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; /** The collection where entities will be moved to. */ collectionId: string; } @@ -467,6 +505,8 @@ export type EntityMoveEntitiesToCollectionParameters = EntityMoveEntitiesToColle RequestParameters; export interface GlossaryListQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** The page size - by default there is no paging. */ limit?: number; /** The offset for pagination purpose. */ @@ -484,7 +524,8 @@ export interface GlossaryListQueryParam { export type GlossaryListParameters = GlossaryListQueryParam & RequestParameters; export interface GlossaryCreateBodyParam { - body?: AtlasGlossary; + /** Body parameter. */ + body: AtlasGlossary; } export type GlossaryCreateParameters = GlossaryCreateBodyParam & RequestParameters; @@ -498,14 +539,16 @@ export type GlossaryCreateCategoriesParameters = GlossaryCreateCategoriesBodyPar RequestParameters; export interface GlossaryCreateCategoryBodyParam { - body?: AtlasGlossaryCategory; + /** Body parameter. */ + body: AtlasGlossaryCategory; } export type GlossaryCreateCategoryParameters = GlossaryCreateCategoryBodyParam & RequestParameters; export type GlossaryGetCategoryParameters = RequestParameters; export interface GlossaryUpdateCategoryBodyParam { - body?: AtlasGlossaryCategory; + /** Body parameter. */ + body: AtlasGlossaryCategory; } export type GlossaryUpdateCategoryParameters = GlossaryUpdateCategoryBodyParam & RequestParameters; @@ -555,7 +598,8 @@ export type GlossaryListCategoryTermsParameters = GlossaryListCategoryTermsQuery RequestParameters; export interface GlossaryCreateTermBodyParam { - body?: AtlasGlossaryTerm; + /** Body parameter. */ + body: AtlasGlossaryTerm; } export interface GlossaryCreateTermQueryParamProperties { @@ -570,13 +614,26 @@ export interface GlossaryCreateTermQueryParam { export type GlossaryCreateTermParameters = GlossaryCreateTermQueryParam & GlossaryCreateTermBodyParam & RequestParameters; -export type GlossaryGetTermParameters = RequestParameters; + +export interface GlossaryGetTermQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; +} + +export interface GlossaryGetTermQueryParam { + queryParameters?: GlossaryGetTermQueryParamProperties; +} + +export type GlossaryGetTermParameters = GlossaryGetTermQueryParam & RequestParameters; export interface GlossaryUpdateTermBodyParam { - body?: AtlasGlossaryTerm; + /** Body parameter. */ + body: AtlasGlossaryTerm; } export interface GlossaryUpdateTermQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** Whether include term hierarchy */ includeTermHierarchy?: boolean; } @@ -599,6 +656,8 @@ export interface GlossaryPartialUpdateTermBodyParam { } export interface GlossaryPartialUpdateTermQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** Whether include term hierarchy */ includeTermHierarchy?: boolean; } @@ -617,6 +676,8 @@ export interface GlossaryCreateTermsBodyParam { } export interface GlossaryCreateTermsQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** Whether include term hierarchy */ includeTermHierarchy?: boolean; } @@ -662,6 +723,8 @@ export type GlossaryDeleteTermAssignmentFromEntitiesParameters = GlossaryDeleteTermAssignmentFromEntitiesBodyParam & RequestParameters; export interface GlossaryListRelatedTermsQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** The page size - by default there is no paging. */ limit?: number; /** The offset for pagination purpose. */ @@ -679,10 +742,13 @@ export type GlossaryListRelatedTermsParameters = GlossaryListRelatedTermsQueryPa export type GlossaryGetParameters = RequestParameters; export interface GlossaryUpdateBodyParam { - body?: AtlasGlossary; + /** Body parameter. */ + body: AtlasGlossary; } export interface GlossaryUpdateQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** Whether ignore terms and categories */ ignoreTermsAndCategories?: boolean; } @@ -726,7 +792,17 @@ export interface GlossaryListCategoriesHeadersQueryParam { export type GlossaryListCategoriesHeadersParameters = GlossaryListCategoriesHeadersQueryParam & RequestParameters; -export type GlossaryGetDetailedParameters = RequestParameters; + +export interface GlossaryGetDetailedQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; +} + +export interface GlossaryGetDetailedQueryParam { + queryParameters?: GlossaryGetDetailedQueryParamProperties; +} + +export type GlossaryGetDetailedParameters = GlossaryGetDetailedQueryParam & RequestParameters; export interface GlossaryPartialUpdateBodyParam { /** @@ -737,6 +813,8 @@ export interface GlossaryPartialUpdateBodyParam { } export interface GlossaryPartialUpdateQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** Whether ignore terms and categories */ ignoreTermsAndCategories?: boolean; } @@ -750,6 +828,8 @@ export type GlossaryPartialUpdateParameters = GlossaryPartialUpdateQueryParam & RequestParameters; export interface GlossaryListTermsQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** The page size - by default there is no paging. */ limit?: number; /** The offset for pagination purpose. */ @@ -781,22 +861,58 @@ export type GlossaryListTermHeadersParameters = GlossaryListTermHeadersQueryPara RequestParameters; export interface DiscoveryQueryBodyParam { - body?: QueryOptions; + /** Body parameter. */ + body: QueryOptions; +} + +export interface DiscoveryQueryQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; } -export type DiscoveryQueryParameters = DiscoveryQueryBodyParam & RequestParameters; +export interface DiscoveryQueryQueryParam { + queryParameters: DiscoveryQueryQueryParamProperties; +} + +export type DiscoveryQueryParameters = DiscoveryQueryQueryParam & + DiscoveryQueryBodyParam & + RequestParameters; export interface DiscoverySuggestBodyParam { - body?: SuggestOptions; + /** Body parameter. */ + body: SuggestOptions; } -export type DiscoverySuggestParameters = DiscoverySuggestBodyParam & RequestParameters; +export interface DiscoverySuggestQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; +} + +export interface DiscoverySuggestQueryParam { + queryParameters: DiscoverySuggestQueryParamProperties; +} + +export type DiscoverySuggestParameters = DiscoverySuggestQueryParam & + DiscoverySuggestBodyParam & + RequestParameters; export interface DiscoveryAutoCompleteBodyParam { - body?: AutoCompleteOptions; + /** Body parameter. */ + body: AutoCompleteOptions; +} + +export interface DiscoveryAutoCompleteQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; } -export type DiscoveryAutoCompleteParameters = DiscoveryAutoCompleteBodyParam & RequestParameters; +export interface DiscoveryAutoCompleteQueryParam { + queryParameters: DiscoveryAutoCompleteQueryParamProperties; +} + +export type DiscoveryAutoCompleteParameters = DiscoveryAutoCompleteQueryParam & + DiscoveryAutoCompleteBodyParam & + RequestParameters; export interface LineageGetQueryParamProperties { /** The number of hops for lineage. */ @@ -806,7 +922,7 @@ export interface LineageGetQueryParamProperties { * * Possible values: "INPUT", "OUTPUT", "BOTH" */ - direction: string; + direction: LineageDirection; } export interface LineageGetQueryParam { @@ -816,12 +932,14 @@ export interface LineageGetQueryParam { export type LineageGetParameters = LineageGetQueryParam & RequestParameters; export interface LineageGetNextPageQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; /** * The direction of the lineage, which could be INPUT, OUTPUT or BOTH. * * Possible values: "INPUT", "OUTPUT", "BOTH" */ - direction: string; + direction: LineageDirection; /** The offset for pagination purpose. */ offset?: number; /** The page size - by default there is no paging. */ @@ -842,7 +960,7 @@ export interface LineageGetByUniqueAttributeQueryParamProperties { * * Possible values: "INPUT", "OUTPUT", "BOTH" */ - direction: string; + direction: LineageDirection; /** * The qualified name of the entity. (This is only an example. qualifiedName can * be changed to other unique attributes) @@ -858,13 +976,15 @@ export type LineageGetByUniqueAttributeParameters = LineageGetByUniqueAttributeQ RequestParameters; export interface RelationshipCreateBodyParam { - body?: AtlasRelationship; + /** Body parameter. */ + body: AtlasRelationship; } export type RelationshipCreateParameters = RelationshipCreateBodyParam & RequestParameters; export interface RelationshipUpdateBodyParam { - body?: AtlasRelationship; + /** Body parameter. */ + body: AtlasRelationship; } export type RelationshipUpdateParameters = RelationshipUpdateBodyParam & RequestParameters; @@ -897,6 +1017,8 @@ export type TypeGetByNameParameters = RequestParameters; export type TypeDeleteParameters = RequestParameters; export interface TypeListQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** * Whether include termtemplatedef when return all typedefs. * This is always true @@ -908,7 +1030,7 @@ export interface TypeListQueryParamProperties { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - type?: string; + type?: TypeCategory; } export interface TypeListQueryParam { @@ -918,24 +1040,29 @@ export interface TypeListQueryParam { export type TypeListParameters = TypeListQueryParam & RequestParameters; export interface TypeBulkCreateBodyParam { - body?: AtlasTypesDef; + /** Body parameter. */ + body: AtlasTypesDef; } export type TypeBulkCreateParameters = TypeBulkCreateBodyParam & RequestParameters; export interface TypeBulkUpdateBodyParam { - body?: AtlasTypesDef; + /** Body parameter. */ + body: AtlasTypesDef; } export type TypeBulkUpdateParameters = TypeBulkUpdateBodyParam & RequestParameters; export interface TypeBulkDeleteBodyParam { - body?: AtlasTypesDef; + /** Body parameter. */ + body: AtlasTypesDef; } export type TypeBulkDeleteParameters = TypeBulkDeleteBodyParam & RequestParameters; export interface TypeListHeadersQueryParamProperties { + /** The API version to use for this operation. */ + "api-version"?: string; /** * Whether include termtemplatedef when return all typedefs. * This is always true @@ -947,7 +1074,7 @@ export interface TypeListHeadersQueryParamProperties { * * Possible values: "PRIMITIVE", "OBJECT_ID_TYPE", "ENUM", "STRUCT", "CLASSIFICATION", "ENTITY", "ARRAY", "MAP", "RELATIONSHIP", "TERM_TEMPLATE" */ - type?: string; + type?: TypeCategory; } export interface TypeListHeadersQueryParam { @@ -955,5 +1082,27 @@ export interface TypeListHeadersQueryParam { } export type TypeListHeadersParameters = TypeListHeadersQueryParam & RequestParameters; -export type TypeGetTermTemplateDefByGuidParameters = RequestParameters; -export type TypeGetTermTemplateDefByNameParameters = RequestParameters; + +export interface TypeGetTermTemplateDefByGuidQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; +} + +export interface TypeGetTermTemplateDefByGuidQueryParam { + queryParameters: TypeGetTermTemplateDefByGuidQueryParamProperties; +} + +export type TypeGetTermTemplateDefByGuidParameters = TypeGetTermTemplateDefByGuidQueryParam & + RequestParameters; + +export interface TypeGetTermTemplateDefByNameQueryParamProperties { + /** The API version to use for this operation. */ + "api-version": string; +} + +export interface TypeGetTermTemplateDefByNameQueryParam { + queryParameters: TypeGetTermTemplateDefByNameQueryParamProperties; +} + +export type TypeGetTermTemplateDefByNameParameters = TypeGetTermTemplateDefByNameQueryParam & + RequestParameters; diff --git a/sdk/purview/purview-datamap-rest/src/purviewDataMapClient.ts b/sdk/purview/purview-datamap-rest/src/purviewDataMapClient.ts index dc62affcfc44..6c45a462e527 100644 --- a/sdk/purview/purview-datamap-rest/src/purviewDataMapClient.ts +++ b/sdk/purview/purview-datamap-rest/src/purviewDataMapClient.ts @@ -7,20 +7,22 @@ import { logger } from "./logger.js"; import type { TokenCredential } from "@azure/core-auth"; import type { PurviewDataMapClient } from "./clientDefinitions.js"; +/** The optional parameters for the client */ +export interface PurviewDataMapClientOptions extends ClientOptions {} + /** * Initialize a new instance of `PurviewDataMapClient` - * @param endpoint - A sequence of textual characters. + * @param endpointParam - A sequence of textual characters. * @param credentials - uniquely identify client credential * @param options - the parameter for all optional parameters */ export default function createClient( - endpoint: string, + endpointParam: string, credentials: TokenCredential, - options: ClientOptions = {}, + options: PurviewDataMapClientOptions = {}, ): PurviewDataMapClient { - const baseUrl = options.baseUrl ?? `${endpoint}/datamap/api`; - options.apiVersion = options.apiVersion ?? "2023-09-01"; - const userAgentInfo = `azsdk-js-purview-datamap-rest/1.0.0-beta.2`; + const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}/datamap/api`; + const userAgentInfo = `azsdk-js-purview-datamap-rest/1.0.0-beta.1`; const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}` @@ -37,8 +39,14 @@ export default function createClient( scopes: options.credentials?.scopes ?? ["https://purview.azure.net/.default"], }, }; + const client = getClient(endpointUrl, credentials, options) as PurviewDataMapClient; - const client = getClient(baseUrl, credentials, options) as PurviewDataMapClient; + client.pipeline.removePolicy({ name: "ApiVersionPolicy" }); + if (options.apiVersion) { + logger.warning( + "This client does not support client api-version, please change it at the operation level", + ); + } return client; } diff --git a/sdk/purview/purview-datamap-rest/src/responses.ts b/sdk/purview/purview-datamap-rest/src/responses.ts index aabe1b9451f2..58e5f9bec412 100644 --- a/sdk/purview/purview-datamap-rest/src/responses.ts +++ b/sdk/purview/purview-datamap-rest/src/responses.ts @@ -1,6 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. +import type { RawHttpHeaders } from "@azure/core-rest-pipeline"; import type { HttpResponse } from "@azure-rest/core-client"; import type { EntityMutationResultOutput, @@ -13,10 +14,10 @@ import type { BulkImportResultOutput, AtlasGlossaryOutput, AtlasGlossaryCategoryOutput, + AtlasRelatedCategoryHeaderOutput, AtlasRelatedTermHeaderOutput, AtlasGlossaryTermOutput, AtlasRelatedObjectIdOutput, - AtlasRelatedCategoryHeaderOutput, AtlasGlossaryExtInfoOutput, QueryResultOutput, SuggestResultOutput, @@ -113,12 +114,12 @@ export interface EntityPartialUpdateAttributeByGuidDefaultResponse extends HttpR } /** The request has succeeded. */ -export interface EntityDeleteOperation200Response extends HttpResponse { +export interface EntityDelete200Response extends HttpResponse { status: "200"; body: EntityMutationResultOutput; } -export interface EntityDeleteOperationDefaultResponse extends HttpResponse { +export interface EntityDeleteDefaultResponse extends HttpResponse { status: string; body: AtlasErrorResponseOutput; } @@ -311,11 +312,16 @@ export interface EntityAddOrUpdateBusinessMetadataAttributesDefaultResponse exte body: AtlasErrorResponseOutput; } +export interface EntityGetSampleBusinessMetadataTemplate200Headers { + "content-type": "application/octet-stream"; +} + /** The request has succeeded. */ export interface EntityGetSampleBusinessMetadataTemplate200Response extends HttpResponse { status: "200"; /** Value may contain any sequence of octets */ body: Uint8Array; + headers: RawHttpHeaders & EntityGetSampleBusinessMetadataTemplate200Headers; } export interface EntityGetSampleBusinessMetadataTemplateDefaultResponse extends HttpResponse { @@ -644,11 +650,11 @@ export interface GlossaryUpdateDefaultResponse extends HttpResponse { } /** There is no content to send for this request, but the headers may be useful. */ -export interface GlossaryDeleteOperation204Response extends HttpResponse { +export interface GlossaryDelete204Response extends HttpResponse { status: "204"; } -export interface GlossaryDeleteOperationDefaultResponse extends HttpResponse { +export interface GlossaryDeleteDefaultResponse extends HttpResponse { status: string; body: AtlasErrorResponseOutput; } @@ -819,11 +825,11 @@ export interface RelationshipGetDefaultResponse extends HttpResponse { } /** There is no content to send for this request, but the headers may be useful. */ -export interface RelationshipDeleteOperation204Response extends HttpResponse { +export interface RelationshipDelete204Response extends HttpResponse { status: "204"; } -export interface RelationshipDeleteOperationDefaultResponse extends HttpResponse { +export interface RelationshipDeleteDefaultResponse extends HttpResponse { status: string; body: AtlasErrorResponseOutput; } @@ -983,11 +989,11 @@ export interface TypeGetByNameDefaultResponse extends HttpResponse { } /** There is no content to send for this request, but the headers may be useful. */ -export interface TypeDeleteOperation204Response extends HttpResponse { +export interface TypeDelete204Response extends HttpResponse { status: "204"; } -export interface TypeDeleteOperationDefaultResponse extends HttpResponse { +export interface TypeDeleteDefaultResponse extends HttpResponse { status: string; body: AtlasErrorResponseOutput; } diff --git a/sdk/purview/purview-datamap-rest/test/public/entityTest.spec.ts b/sdk/purview/purview-datamap-rest/test/public/entityTest.spec.ts index 46a2e54763de..8c58bd300339 100644 --- a/sdk/purview/purview-datamap-rest/test/public/entityTest.spec.ts +++ b/sdk/purview/purview-datamap-rest/test/public/entityTest.spec.ts @@ -4,7 +4,6 @@ import type { Recorder } from "@azure-tools/test-recorder"; import { createRecorder } from "./utils/recordedClient.js"; import { createClient } from "./utils/recordedClient.js"; -import { createFile } from "../../src/index.js"; import { isUnexpected } from "../../src/isUnexpected.js"; import { describe, it, assert, beforeEach, afterEach } from "vitest"; @@ -28,9 +27,13 @@ hive_database,hive_db_1,bmWithAllTypes.attr8,"Awesome Attribute 1",name`); const response = await client.path("/atlas/v2/entity/businessmetadata/import").post({ contentType: "multipart/form-data", - body: { - file: createFile(fileContent, "template_2.csv"), - }, + body: [ + { + name: "file", + body: fileContent, + filename: "template_2.csv", + }, + ], }); assert.strictEqual(isUnexpected(response), false); }); diff --git a/sdk/purview/purview-datamap-rest/tsp-location.yaml b/sdk/purview/purview-datamap-rest/tsp-location.yaml index 2a823d141089..7f50fab51b20 100644 --- a/sdk/purview/purview-datamap-rest/tsp-location.yaml +++ b/sdk/purview/purview-datamap-rest/tsp-location.yaml @@ -1,5 +1,4 @@ directory: specification/purview/Azure.Analytics.Purview.DataMap +commit: b9d42131fa23babd959c491b44870a30ea9506cd repo: Azure/azure-rest-api-specs -commit: e4dd3e7e4d0402a81b2bef7dd754d3e46e8a8ab5 -additionalDirectories: [] - +additionalDirectories: