From bff6a049fd1d55205ba46700aa61899127b5cd5e Mon Sep 17 00:00:00 2001 From: lawrencegripper Date: Mon, 9 Oct 2023 17:08:09 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=B9=20Update=20ARM=20Specs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../expanders/swagger-armspecs.generated.go | 49 +- .../data-plane/Identity/api-set.json | 2 +- .../CommunicationIdentity.json | 24 +- .../digitaltwins.json | 251 +- .../digitaltwins/data-plane/api-set.json | 2 +- .../AzureCommunicationServices.json | 1054 ++- .../stable/2023-09-01/purviewdatamap.json | 7267 +++++++++++++++++ .../purviewDevopsPolicy.json | 636 -- swagger-specs/purview/data-plane/api-set.json | 2 +- .../preview/2023-06-01-preview/policy.json | 350 + .../resource-manager/api-set.json | 1 + .../{2022-09-01 => 2023-11-01}/search.json | 214 +- .../search/resource-manager/api-set.json | 2 +- 13 files changed, 9146 insertions(+), 708 deletions(-) rename swagger-specs/communication/data-plane/Identity/stable/{2023-08-01 => 2022-10-01}/CommunicationIdentity.json (86%) rename swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/{2023-06-30 => 2023-10-31}/digitaltwins.json (88%) create mode 100644 swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json delete mode 100644 swagger-specs/purview/data-plane/Azure.Analytics.Purview.DevopsPolicies/preview/2022-11-01-preview/purviewDevopsPolicy.json create mode 100644 swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json create mode 100644 swagger-specs/purviewpolicy/resource-manager/api-set.json rename swagger-specs/search/resource-manager/Microsoft.Search/stable/{2022-09-01 => 2023-11-01}/search.json (92%) diff --git a/internal/pkg/expanders/swagger-armspecs.generated.go b/internal/pkg/expanders/swagger-armspecs.generated.go index 8ef2ae23b..01fb83fc1 100644 --- a/internal/pkg/expanders/swagger-armspecs.generated.go +++ b/internal/pkg/expanders/swagger-armspecs.generated.go @@ -14496,7 +14496,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Purview/operations", "2021-12-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Purview/operations", "2023-06-01-preview"), }, { Display: "accounts", @@ -14550,6 +14550,10 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }}, }}, }, + { + Display: "policies", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/{scope}/providers/Microsoft.Purview/policies", "2023-06-01-preview"), + }, { Display: "operations", Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Quota/operations", "2023-02-01"), @@ -15313,7 +15317,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "searchServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices", "2023-11-01"), }, { Display: "alerts", @@ -16004,46 +16008,55 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }}, }}, }, + { + Display: "usages", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages", "2023-11-01"), + SubResources: []swagger.ResourceType{ + { + Display: "{skuName}", + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}", "2023-11-01"), + }}, + }, { Display: "searchServices", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{searchServiceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2022-09-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2022-09-01"), - PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2022-09-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2023-11-01"), + PatchEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}", "2023-11-01"), Children: []swagger.ResourceType{ { Display: "listAdminKeys", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys", "2023-11-01"), Verb: "POST", }, { Display: "privateEndpointConnections", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{privateEndpointConnectionName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2022-09-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2022-09-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}", "2023-11-01"), }}, }, { Display: "privateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources", "2023-11-01"), }, { Display: "sharedPrivateLinkResources", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources", "2023-11-01"), SubResources: []swagger.ResourceType{ { Display: "{sharedPrivateLinkResourceName}", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2022-09-01"), - DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2022-09-01"), - PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2023-11-01"), + DeleteEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2023-11-01"), + PutEndpoint: endpoints.MustGetEndpointInfoFromURL("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}", "2023-11-01"), }}, }}, SubResources: []swagger.ResourceType{}, @@ -21866,7 +21879,7 @@ func (e *SwaggerAPISetARMResources) loadResourceTypes() []swagger.ResourceType { }, { Display: "operations", - Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Search/operations", "2022-09-01"), + Endpoint: endpoints.MustGetEndpointInfoFromURL("/providers/Microsoft.Search/operations", "2023-11-01"), }, { Display: "assessmentMetadata", diff --git a/swagger-specs/communication/data-plane/Identity/api-set.json b/swagger-specs/communication/data-plane/Identity/api-set.json index 65232d08f..e29e2b580 100644 --- a/swagger-specs/communication/data-plane/Identity/api-set.json +++ b/swagger-specs/communication/data-plane/Identity/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["stable/2023-08-01/CommunicationIdentity.json"], "name": "package-2023-08"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["stable/2022-10-01/CommunicationIdentity.json"], "name": "package-2022-10"} \ No newline at end of file diff --git a/swagger-specs/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json b/swagger-specs/communication/data-plane/Identity/stable/2022-10-01/CommunicationIdentity.json similarity index 86% rename from swagger-specs/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json rename to swagger-specs/communication/data-plane/Identity/stable/2022-10-01/CommunicationIdentity.json index 03b0aa1c0..9dbc1cbce 100644 --- a/swagger-specs/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json +++ b/swagger-specs/communication/data-plane/Identity/stable/2022-10-01/CommunicationIdentity.json @@ -3,7 +3,7 @@ "info": { "title": "CommunicationIdentityClient", "description": "Azure Communication Identity Service", - "version": "2023-08-01" + "version": "2022-10-01" }, "paths": { "/identities": { @@ -23,20 +23,6 @@ { "$ref": "#/parameters/ApiVersionParameter" }, - { - "in": "header", - "name": "Repeatability-Request-ID", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. Internal identifiers shouldn't be used. The value should be an opaque meaningless string in UUID format.", - "type": "string", - "format": "uuid" - }, - { - "in": "header", - "name": "Repeatability-First-Sent", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date", - "type": "string", - "format": "date-time-rfc1123" - }, { "in": "body", "name": "body", @@ -57,17 +43,11 @@ "description": "Created - Returns the created identity.", "schema": { "$ref": "#/definitions/CommunicationIdentityAccessTokenResult" - }, - "headers": { - "Repeatability-Result": { - "description": "Result of idempotent request. Present only in case of idempotent processing.", - "type": "string" - } } } }, "x-ms-examples": { - "Create an Identity and optionally an access token with custom expiration time within the [60-1440] minutes range. If expiration time is not specified, the default value of 1440 minutes (24 hours) will be used. You can also specify optional idempotent processing using Repeatability-Request-ID and Repeatability-First-Sent headers. If the headers are not provided, the request will be processed in a non-idempotent way which can lead to more identities being created than intended on a retry.": { + "Create an Identity and optionally an access token with custom expiration time within the [60-1440] minutes range. If expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.": { "$ref": "./examples/CreateIdentity.json" } } diff --git a/swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json b/swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2023-10-31/digitaltwins.json similarity index 88% rename from swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json rename to swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2023-10-31/digitaltwins.json index a3cd086df..375539d44 100644 --- a/swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json +++ b/swagger-specs/digitaltwins/data-plane/Microsoft.DigitalTwins/stable/2023-10-31/digitaltwins.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-06-30", + "version": "2023-10-31", "title": "Azure Digital Twins API", "description": "A service for managing and querying digital twins and digital twin models." }, @@ -1537,7 +1537,7 @@ "Jobs" ], "operationId": "ImportJobs_Delete", - "description": "Deletes an import job.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.", + "description": "Deletes an import job. This is simply used to remove a job id, so it may be reused later. It can not be used to stop entities from being imported.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.", "x-ms-examples": { "Delete an import job": { "$ref": "./examples/ImportJobDelete.json" @@ -1584,7 +1584,7 @@ "Jobs" ], "operationId": "ImportJobs_Cancel", - "description": "Cancels an import job.\nStatus codes:\n* 200 Request Accepted\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.", + "description": "Cancels an import job that is currently running. Service will stop any import operations triggered by the current import job that are in progress, and go to a cancelled state. Please note that this will leave your instance in an unknown state as there won't be any rollback operation. \nStatus codes:\n* 200 Request Accepted\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.", "x-ms-examples": { "Cancel a job": { "$ref": "./examples/ImportJobCancel.json" @@ -1619,6 +1619,159 @@ } } } + }, + "/jobs/deletions": { + "parameters": [ + { + "$ref": "#/parameters/traceparent" + }, + { + "$ref": "#/parameters/tracestate" + } + ], + "post": { + "tags": [ + "Jobs" + ], + "operationId": "DeleteJobs_Add", + "x-ms-long-running-operation": true, + "description": "Initiates a job which deletes all models, twins, and relationships on the instance. Does not delete any other types of entities.\nStatus codes:\n* 202 Created\n* 400 Bad Request\n * JobLimitReached - The maximum number of delete jobs allowed has been reached. \n * ValidationFailed - Operation-Id already exists.", + "x-ms-examples": { + "Add a job": { + "$ref": "./examples/DeleteJobPost.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/operation-id" + }, + { + "$ref": "#/parameters/timeoutInMinutes" + } + ], + "responses": { + "202": { + "description": "Job Accepted", + "schema": { + "$ref": "#/definitions/DeleteJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "description": "The URL to track the status of the long running operation." + } + } + }, + "default": { + "description": "Default response.", + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code for specific error that occurred." + } + }, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "operationId": "DeleteJobs_List", + "description": "Retrieves all deletion jobs. This may be useful to find a delete job that was previously requested, or to view a history of delete jobs that have run or are currently running on the instance.\nStatus codes:\n* 200 OK", + "x-ms-examples": { + "Get all import jobs": { + "$ref": "./examples/DeleteJobList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/max-items-per-page" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeleteJobCollection" + } + }, + "default": { + "description": "Default response.", + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code for specific error that occurred." + } + }, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/jobs/deletions/{id}": { + "parameters": [ + { + "$ref": "#/parameters/traceparent" + }, + { + "$ref": "#/parameters/tracestate" + } + ], + "get": { + "tags": [ + "Jobs" + ], + "operationId": "DeleteJobs_GetById", + "description": "Retrieves a delete job.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * DeleteJobNotFound - The delete job was not found.", + "x-ms-examples": { + "Get an import job by id": { + "$ref": "./examples/DeleteJobGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/deleteJobId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeleteJob" + } + }, + "default": { + "description": "Default response.", + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code for specific error that occurred." + } + }, + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } } }, "definitions": { @@ -1933,6 +2086,75 @@ } } }, + "DeleteJob": { + "description": "A job which contains a reference to the operations to perform, results, and execution metadata.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the delete job.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.", + "enum": [ + "notstarted", + "running", + "failed", + "succeeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "delete-job-status", + "modelAsExtensible": true, + "modelAsString": false + } + }, + "createdDateTime": { + "description": "Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "finishedDateTime": { + "description": "End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "purgeDateTime": { + "description": "Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Details of the error(s) that occurred executing the import job." + } + } + }, + "DeleteJobCollection": { + "description": "A collection of delete job objects.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "description": "The list of delete job objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DeleteJob" + } + }, + "nextLink": { + "description": "A URI to retrieve the next page of results.", + "type": "string" + } + } + }, "ErrorResponse": { "description": "Error response.", "required": [ @@ -2043,6 +2265,14 @@ "type": "string", "x-ms-parameter-location": "method" }, + "deleteJobId": { + "name": "id", + "in": "path", + "description": "The id for the delete job. The id is unique within the service and case sensitive.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "componentPath": { "name": "componentPath", "in": "path", @@ -2071,6 +2301,21 @@ "postfix": "Options" } }, + "operation-id": { + "name": "operation-id", + "in": "header", + "description": "ID for the operation's status monitor. The ID is generated if header was not passed by the client.", + "required": false, + "type": "string" + }, + "timeoutInMinutes": { + "name": "timeoutInMinutes", + "in": "query", + "description": "Desired timeout for the delete job. Once the specified timeout is reached, service will stop any delete operations triggered by the current delete job that are in progress, and go to a failed state. Please note that this will leave your instance in an unknown state as there won't be any rollback operation.", + "required": false, + "type": "integer", + "format": "int32" + }, "if-none-match-star": { "name": "If-None-Match", "in": "header", diff --git a/swagger-specs/digitaltwins/data-plane/api-set.json b/swagger-specs/digitaltwins/data-plane/api-set.json index affb41844..2455eb665 100644 --- a/swagger-specs/digitaltwins/data-plane/api-set.json +++ b/swagger-specs/digitaltwins/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json"], "name": "package-2023-06-30"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.DigitalTwins/stable/2023-10-31/digitaltwins.json"], "name": "package-2023-10-31"} \ No newline at end of file diff --git a/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 2ceb3cdac..60cf419dc 100644 --- a/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/swagger-specs/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -9,45 +9,808 @@ "definitions": { "AcsIncomingCallEventData": { "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event", + "type": "object", + "properties": { + "to": { + "description": "The communication identifier of the target user.", + "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", + "x-ms-client-name": "toCommunicationIdentifier" + }, + "from": { + "description": "The communication identifier of the user who initiated the call.", + "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", + "x-ms-client-name": "fromCommunicationIdentifier" + }, + "serverCallId": { + "description": "The Id of the server call", + "type": "string" + }, + "callerDisplayName": { + "description": "Display name of caller.", + "type": "string" + }, + "customContext": { + "description": "Custom Context of Incoming Call", + "$ref": "#/definitions/AcsIncomingCallCustomContext" + }, + "incomingCallContext": { + "description": "Signed incoming call context.", + "type": "string" + }, + "correlationId": { + "description": "CorrelationId (CallId).", + "type": "string" + } + } + }, + "AcsUserDisconnectedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", + "type": "object", + "properties": { + "userCommunicationIdentifier": { + "description": "The communication identifier of the user who was disconnected", + "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + } + } + }, + "AcsRouterJobCancelledEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "note": { + "description": "Router Job Note", + "type": "string" + }, + "dispositionCode": { + "description": "Router Job Disposition Code", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_cancelled.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_cancelled.json" + } + } + }, + "AcsRouterJobClassificationFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "classificationPolicyId": { + "description": "Router Job Classification Policy Id", + "type": "string" + }, + "errors": { + "description": "Router Job Classification Failed Errors", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterCommunicationError" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_classification_failed.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_classification_failed.json" + } + } + }, + "AcsRouterJobClassifiedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "queueDetails": { + "description": "Router Job Queue Info", + "$ref": "#/definitions/AcsRouterQueueDetails" + }, + "classificationPolicyId": { + "description": "Router Job Classification Policy Id", + "type": "string" + }, + "priority": { + "description": "Router Job Priority", + "type": "integer", + "format": "int32" + }, + "attachedWorkerSelectors": { + "description": "Router Job Attached Worker Selector", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_classified.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_classified.json" + } + } + }, + "AcsRouterJobClosedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "assignmentId": { + "description": "Router Job Closed Assignment Id", + "type": "string" + }, + "workerId": { + "description": "Router Job Closed Worker Id", + "type": "string" + }, + "dispositionCode": { + "description": "Router Job Closed Disposition Code", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_closed.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_closed.json" + } + } + }, + "AcsRouterJobCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "assignmentId": { + "description": "Router Job Completed Assignment Id", + "type": "string" + }, + "workerId": { + "description": "Router Job Completed Worker Id", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_completed.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_completed.json" + } + } + }, + "AcsRouterJobDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_deleted.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_deleted.json" + } + } + }, + "AcsRouterJobExceptionTriggeredEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "ruleKey": { + "description": "Router Job Exception Triggered Rule Key", + "type": "string" + }, + "exceptionRuleId": { + "description": "Router Job Exception Triggered Rule Id", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_exception_triggered.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_exception_triggered.json" + } + } + }, + "AcsRouterJobQueuedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "priority": { + "description": "Router Job Priority", + "type": "integer", + "format": "int32" + }, + "attachedWorkerSelectors": { + "description": "Router Job Queued Attached Worker Selector", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "requestedWorkerSelectors": { + "description": "Router Job Queued Requested Worker Selector", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_queued.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_queued.json" + } + } + }, + "AcsRouterJobReceivedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "jobStatus": { + "description": "Router Job Received Job Status", + "type": "string", + "enum": [ + "PendingClassification", + "Queued", + "Assigned", + "Completed", + "Closed", + "Cancelled", + "ClassificationFailed", + "Created", + "PendingSchedule", + "Scheduled", + "ScheduleFailed", + "WaitingForActivation" + ], + "x-ms-enum": { + "name": "acsRouterJobStatus", + "modelAsString": true + } + }, + "classificationPolicyId": { + "description": "Router Job Classification Policy Id", + "type": "string" + }, + "priority": { + "description": "Router Job Priority", + "type": "integer", + "format": "int32" + }, + "requestedWorkerSelectors": { + "description": "Router Job Received Requested Worker Selectors", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "scheduledOn": { + "description": "Router Job Received Scheduled Time in UTC", + "type": "string", + "format": "date-time" + }, + "unavailableForMatching": { + "description": "Unavailable For Matching for Router Job Received", + "type": "boolean" + } + }, + "required": [ + "unavailableForMatching" + ], + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_received.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_received.json" + } + } + }, + "AcsRouterJobSchedulingFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "priority": { + "description": "Router Job Priority", + "type": "integer", + "format": "int32" + }, + "expiredAttachedWorkerSelectors": { + "description": "Router Job Scheduling Failed Attached Worker Selector Expired", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "expiredRequestedWorkerSelectors": { + "description": "Router Job Scheduling Failed Requested Worker Selector Expired", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "scheduledOn": { + "description": "Router Job Scheduling Failed Scheduled Time in UTC", + "type": "string", + "format": "date-time" + }, + "failureReason": { + "description": "Router Job Scheduling Failed Reason", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_scheduling_failed.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_scheduling_failed.json" + } + } + }, + "AcsRouterJobUnassignedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "assignmentId": { + "description": "Router Job Unassigned Assignment Id", + "type": "string" + }, + "workerId": { + "description": "Router Job Unassigned Worker Id", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_unassigned.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_unassigned.json" + } + } + }, + "AcsRouterJobWaitingForActivationEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "priority": { + "description": "Router Job Waiting For Activation Priority", + "type": "integer", + "format": "int32" + }, + "expiredAttachedWorkerSelectors": { + "description": "Router Job Waiting For Activation Worker Selector Expired", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "expiredRequestedWorkerSelectors": { + "description": "Router Job Waiting For Activation Requested Worker Selector Expired", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "scheduledOn": { + "description": "Router Job Waiting For Activation Scheduled Time in UTC", + "type": "string", + "format": "date-time" + }, + "unavailableForMatching": { + "description": "Router Job Waiting For Activation Unavailable For Matching", + "type": "boolean" + } + }, + "required": [ + "unavailableForMatching" + ], + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_waiting_for_activation.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_waiting_for_activation.json" + } + } + }, + "AcsRouterJobWorkerSelectorsExpiredEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterJobEventData" + } + ], + "properties": { + "expiredRequestedWorkerSelectors": { + "description": "Router Job Worker Selectors Expired Requested Worker Selectors", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + }, + "expiredAttachedWorkerSelectors": { + "description": "Router Job Worker Selectors Expired Attached Worker Selectors", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterWorkerSelector" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_job_worker_selectors_expired.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_job_worker_selectors_expired.json" + } + } + }, + "AcsRouterWorkerDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ], + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_deleted.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_deleted.json" + } + } + }, + "AcsRouterWorkerDeregisteredEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event", + "type": "object", + "properties": { + "workerId": { + "description": "Router Worker Deregistered Worker Id", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_deregistered.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_deregistered.json" + } + } + }, + "AcsRouterWorkerOfferAcceptedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ], + "properties": { + "queueId": { + "description": "Router Worker Offer Accepted Queue Id", + "type": "string" + }, + "offerId": { + "description": "Router Worker Offer Accepted Offer Id", + "type": "string" + }, + "assignmentId": { + "description": "Router Worker Offer Accepted Assignment Id", + "type": "string" + }, + "jobPriority": { + "description": "Router Worker Offer Accepted Job Priority", + "type": "integer", + "format": "int32" + }, + "workerLabels": { + "type": "object", + "description": "Router Worker Offer Accepted Worker Labels", + "additionalProperties": { + "type": "string" + } + }, + "workerTags": { + "type": "object", + "description": "Router Worker Offer Accepted Worker Tags", + "additionalProperties": { + "type": "string" + } + }, + "jobLabels": { + "type": "object", + "description": "Router Worker Offer Accepted Job Labels", + "additionalProperties": { + "type": "string" + } + }, + "jobTags": { + "type": "object", + "description": "Router Worker Offer Accepted Job Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_offer_accepted.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_offer_accepted.json" + } + } + }, + "AcsRouterWorkerOfferDeclinedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ], + "properties": { + "queueId": { + "description": "Router Worker Offer Declined Queue Id", + "type": "string" + }, + "offerId": { + "description": "Router Worker Offer Declined Offer Id", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_offer_declined.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_offer_declined.json" + } + } + }, + "AcsRouterWorkerOfferExpiredEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ], "properties": { - "to": { - "description": "The communication identifier of the target user.", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", - "x-ms-client-name": "toCommunicationIdentifier" + "queueId": { + "description": "Router Worker Offer Expired Queue Id", + "type": "string" }, - "from": { - "description": "The communication identifier of the user who initiated the call.", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", - "x-ms-client-name": "fromCommunicationIdentifier" + "offerId": { + "description": "Router Worker Offer Expired Offer Id", + "type": "string" + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_offer_expired.json" }, - "serverCallId": { - "description": "The Id of the server call", + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_offer_expired.json" + } + } + }, + "AcsRouterWorkerOfferIssuedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ], + "properties": { + "queueId": { + "description": "Router Worker Offer Issued Queue Id", "type": "string" }, - "callerDisplayName": { - "description": "Display name of caller.", + "offerId": { + "description": "Router Worker Offer Issued Offer Id", "type": "string" }, - "customContext": { - "description": "Custom Context of Incoming Call", - "$ref": "#/definitions/AcsIncomingCallCustomContext" + "jobPriority": { + "description": "Router Worker Offer Issued Job Priority", + "type": "integer", + "format": "int32" }, - "incomingCallContext": { - "description": "Signed incoming call context.", + "workerLabels": { + "type": "object", + "description": "Router Worker Offer Issued Worker Labels", + "additionalProperties": { + "type": "string" + } + }, + "offeredOn": { + "description": "Router Worker Offer Issued Time in UTC", + "type": "string", + "format": "date-time" + }, + "expiresOn": { + "description": "Router Worker Offer Issued Expiration Time in UTC", + "type": "string", + "format": "date-time" + }, + "workerTags": { + "type": "object", + "description": "Router Worker Offer Issued Worker Tags", + "additionalProperties": { + "type": "string" + } + }, + "jobLabels": { + "type": "object", + "description": "Router Worker Offer Issued Job Labels", + "additionalProperties": { + "type": "string" + } + }, + "jobTags": { + "type": "object", + "description": "Router Worker Offer Issued Job Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_offer_issued.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_offer_issued.json" + } + } + }, + "AcsRouterWorkerOfferRevokedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterWorkerEventData" + } + ], + "properties": { + "queueId": { + "description": "Router Worker Offer Revoked Queue Id", "type": "string" }, - "correlationId": { - "description": "CorrelationId (CallId).", + "offerId": { + "description": "Router Worker Offer Revoked Offer Id", "type": "string" } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_offer_revoked.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_offer_revoked.json" + } } }, - "AcsUserDisconnectedEventData": { - "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", + "AcsRouterWorkerRegisteredEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event", + "type": "object", "properties": { - "userCommunicationIdentifier": { - "description": "The communication identifier of the user who was disconnected", - "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + "workerId": { + "description": "Router Worker Registered Worker Id", + "type": "string" + }, + "queueAssignments": { + "description": "Router Worker Registered Queue Info", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterQueueDetails" + } + }, + "channelConfigurations": { + "description": "Router Worker Registered Channel Configuration", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterChannelConfiguration" + } + }, + "totalCapacity": { + "description": "Router Worker Register Total Capacity", + "type": "integer", + "format": "int32" + }, + "labels": { + "type": "object", + "description": "Router Worker Registered Labels", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "type": "object", + "description": "Router Worker Registered Tags", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-examples": { + "snapshotCreatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/router_worker_registered.json" + }, + "snapshotCreatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/router_worker_registered.json" } } }, @@ -58,6 +821,7 @@ "$ref": "#/definitions/AcsChatMessageEventBaseProperties" } ], + "type": "object", "properties": { "messageBody": { "description": "The body of the chat message", @@ -79,6 +843,7 @@ "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ], + "type": "object", "properties": { "messageBody": { "description": "The body of the chat message", @@ -100,6 +865,7 @@ "$ref": "#/definitions/AcsChatMessageEventBaseProperties" } ], + "type": "object", "properties": { "messageBody": { "description": "The body of the chat message", @@ -126,6 +892,7 @@ "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ], + "type": "object", "properties": { "messageBody": { "description": "The body of the chat message", @@ -152,6 +919,7 @@ "$ref": "#/definitions/AcsChatMessageEventBaseProperties" } ], + "type": "object", "properties": { "deleteTime": { "description": "The time at which the message was deleted", @@ -167,6 +935,7 @@ "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ], + "type": "object", "properties": { "deleteTime": { "description": "The time at which the message was deleted", @@ -182,6 +951,7 @@ "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ], + "type": "object", "properties": { "createdByCommunicationIdentifier": { "description": "The communication identifier of the user who created the thread", @@ -210,6 +980,7 @@ "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" } ], + "type": "object", "properties": { "createdByCommunicationIdentifier": { "description": "The communication identifier of the user who created the thread", @@ -238,6 +1009,7 @@ "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ], + "type": "object", "properties": { "deletedByCommunicationIdentifier": { "description": "The communication identifier of the user who deleted the thread", @@ -257,6 +1029,7 @@ "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" } ], + "type": "object", "properties": { "deletedByCommunicationIdentifier": { "description": "The communication identifier of the user who deleted the thread", @@ -276,6 +1049,7 @@ "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ], + "type": "object", "properties": { "editedByCommunicationIdentifier": { "description": "The communication identifier of the user who updated the thread properties", @@ -302,6 +1076,7 @@ "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" } ], + "type": "object", "properties": { "editedByCommunicationIdentifier": { "description": "The communication identifier of the user who updated the thread properties", @@ -328,6 +1103,7 @@ "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ], + "type": "object", "properties": { "time": { "description": "The time at which the user was added to the thread", @@ -351,6 +1127,7 @@ "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ], + "type": "object", "properties": { "time": { "description": "The time at which the user was removed to the thread", @@ -374,6 +1151,7 @@ "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ], + "type": "object", "properties": { "time": { "description": "The time at which the user was added to the thread", @@ -402,6 +1180,7 @@ "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ], + "type": "object", "properties": { "time": { "description": "The time at which the user was removed to the thread", @@ -430,6 +1209,7 @@ "$ref": "#/definitions/AcsSmsEventBaseProperties" } ], + "type": "object", "properties": { "deliveryStatus": { "description": "Status of Delivery", @@ -464,6 +1244,7 @@ "$ref": "#/definitions/AcsSmsEventBaseProperties" } ], + "type": "object", "properties": { "message": { "description": "The SMS content", @@ -478,6 +1259,7 @@ }, "AcsRecordingFileStatusUpdatedEventData": { "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.", + "type": "object", "properties": { "recordingStorageInfo": { "description": "The details of recording storage information", @@ -659,6 +1441,7 @@ "$ref": "#/definitions/AcsChatEventBaseProperties" } ], + "type": "object", "properties": { "createTime": { "description": "The original creation time of the thread", @@ -679,6 +1462,7 @@ "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ], + "type": "object", "properties": { "createTime": { "description": "The original creation time of the thread", @@ -699,6 +1483,7 @@ "$ref": "#/definitions/AcsChatEventBaseProperties" } ], + "type": "object", "properties": { "messageId": { "description": "The chat message id", @@ -735,6 +1520,7 @@ "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ], + "type": "object", "properties": { "messageId": { "description": "The chat message id", @@ -778,6 +1564,68 @@ } } }, + "AcsRouterJobEventData": { + "description": "Schema of common properties of all Router Job events", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterEventData" + } + ], + "properties": { + "queueId": { + "description": "Router Job events Queue Id", + "type": "string" + }, + "labels": { + "description": "Router Job events Labels", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "tags": { + "description": "Router Jobs events Tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AcsRouterWorkerEventData": { + "description": "Schema of common properties of all Router Worker events", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AcsRouterEventData" + } + ], + "properties": { + "workerId": { + "description": "Router Worker events Worker Id", + "type": "string" + } + } + }, + "AcsRouterEventData": { + "description": "Schema of common properties of all Router events", + "type": "object", + "properties": { + "jobId": { + "description": "Router Event Job ID", + "type": "string" + }, + "channelReference": { + "description": "Router Event Channel Reference", + "type": "string" + }, + "channelId": { + "description": "Router Event Channel ID", + "type": "string" + } + } + }, "AcsChatEventBaseProperties": { "description": "Schema of common properties of all chat events", "type": "object", @@ -920,6 +1768,164 @@ } } } + }, + "AcsRouterChannelConfiguration": { + "description": "Router Channel Configuration", + "type": "object", + "properties": { + "channelId": { + "description": "Channel ID for Router Job", + "type": "string" + }, + "capacityCostPerJob": { + "description": "Capacity Cost Per Job for Router Job", + "type": "integer", + "format": "int32" + }, + "maxNumberOfJobs": { + "description": "Max Number of Jobs for Router Job", + "type": "integer", + "format": "int32" + } + } + }, + "AcsRouterQueueDetails": { + "description": "Router Queue Details", + "type": "object", + "properties": { + "id": { + "description": "Router Queue Id", + "type": "string" + }, + "name": { + "description": "Router Queue Name", + "type": "string" + }, + "labels": { + "description": "Router Queue Labels", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AcsRouterCommunicationError": { + "description": "Router Communication Error", + "type": "object", + "properties": { + "code": { + "description": "Router Communication Error Code", + "type": "string" + }, + "message": { + "description": "Router Communication Error Message", + "type": "string" + }, + "target": { + "description": "Router Communication Error Target", + "type": "string" + }, + "innerError": { + "description": "Router Communication Inner Error", + "$ref": "#/definitions/AcsRouterCommunicationError" + }, + "details": { + "description": "List of Router Communication Errors", + "type": "array", + "items": { + "$ref": "#/definitions/AcsRouterCommunicationError" + } + } + } + }, + "AcsRouterWorkerSelector": { + "description": "Router Job Worker Selector", + "type": "object", + "properties": { + "key": { + "description": "Router Job Worker Selector Key", + "type": "string" + }, + "labelOperator": { + "description": "Router Job Worker Selector Label Operator", + "type": "string", + "enum": [ + "Equal", + "NotEqual", + "Greater", + "Less", + "GreaterThanOrEqual", + "LessThanOrEqual" + ], + "x-ms-enum": { + "name": "acsRouterLabelOperator", + "modelAsString": true, + "values": [ + { + "value": "Equal", + "description": "=" + }, + { + "value": "NotEqual", + "description": "!=" + }, + { + "value": "Greater", + "description": ">" + }, + { + "value": "Less", + "description": "<" + }, + { + "value": "GreaterThanOrEqual", + "description": ">=" + }, + { + "value": "LessThanOrEqual", + "description": "<=" + } + ] + } + }, + "labelValue": { + "description": "Router Job Worker Selector Value", + "type": "object" + }, + "ttl": { + "description": "Router Job Worker Selector TTL", + "type": "number", + "x-ms-client-name": "timeToLive" + }, + "state": { + "description": "Router Job Worker Selector State", + "type": "string", + "enum": [ + "active", + "expired" + ], + "x-ms-enum": { + "name": "AcsRouterWorkerSelectorState", + "modelAsString": true, + "values": [ + { + "value": "active", + "description": "Router Job Worker Selector is Active" + }, + { + "value": "expired", + "description": "Router Job Worker Selector has Expire" + } + ] + } + }, + "expirationTime": { + "description": "Router Job Worker Selector Expiration Time", + "type": "string", + "format": "date-time" + } + } } } } diff --git a/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json new file mode 100644 index 000000000..d8d6e86e4 --- /dev/null +++ b/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -0,0 +1,7267 @@ +{ + "swagger": "2.0", + "info": { + "title": "Purview Data Map Service REST API Document", + "description": "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments. This spec defines REST API of Purview Data Map Service.", + "version": "2023-09-01" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + }, + "basePath": "/datamap/api", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/atlas/v2/entity": { + "post": { + "tags": [ + "Entity" + ], + "description": "Create or update an entity.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "operationId": "Entity_CreateOrUpdate", + "x-ms-examples": { + "Entity_Create": { + "$ref": "./examples/Entity_Create.json" + }, + "Entity_Update": { + "$ref": "./examples/Entity_Update.json" + }, + "Entity_AddCustomAttribute": { + "$ref": "./examples/Entity_AddCustomAttribute.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "entity", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + { + "$ref": "#/parameters/businessAttributeUpdateBehavior" + }, + { + "$ref": "#/parameters/collectionId" + }, + { + "$ref": "#/parameters/atlasAPIVersion" + } + ], + "responses": { + "200": { + "description": "Created with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/bulk": { + "get": { + "tags": [ + "Entity" + ], + "description": "List entities in bulk identified by its GUIDs.", + "operationId": "Entity_ListByGuids", + "x-ms-examples": { + "Entity_ListByGuids": { + "$ref": "./examples/Entity_ListByGuids.json" + } + }, + "parameters": [ + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to list.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "guids" + }, + { + "$ref": "#/parameters/minExtInfo" + }, + { + "$ref": "#/parameters/ignoreRelationships" + }, + { + "$ref": "#/parameters/atlasAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Entity" + ], + "description": "Create or update entities in bulk.\nExisting entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.\nMap and array of collections are not well supported. E.g., array>, array>.\nFor each contact type, the maximum number of contacts is 20.", + "operationId": "Entity_BulkCreateOrUpdate", + "x-ms-examples": { + "Entity_BulkCreateOrUpdate": { + "$ref": "./examples/Entity_BulkCreateOrUpdate.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "entities", + "description": "An array of entities to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + { + "$ref": "#/parameters/collectionId" + }, + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/businessAttributeUpdateBehavior" + } + ], + "responses": { + "200": { + "description": "Ok.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Entity" + ], + "description": "Delete a list of entities in bulk identified by their GUIDs or unique attributes.", + "operationId": "Entity_BulkDelete", + "x-ms-examples": { + "Entity_BulkDelete": { + "$ref": "./examples/Entity_BulkDelete.json" + } + }, + "parameters": [ + { + "name": "guid", + "in": "query", + "description": "An array of GUIDs of entities to delete.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "guids" + } + ], + "responses": { + "200": { + "description": "Deleted with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/bulk/classification": { + "post": { + "tags": [ + "Entity" + ], + "description": "Associate a classification to multiple entities in bulk.", + "operationId": "Entity_AddClassification", + "x-ms-examples": { + "Entity_AddClassificationToEntityByGuids": { + "$ref": "./examples/Entity_AddClassificationToEntityByGuids.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "request", + "description": "The request to associate a classification to multiple entities.", + "required": true, + "schema": { + "$ref": "#/definitions/ClassificationAssociateRequest" + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}": { + "get": { + "tags": [ + "Entity" + ], + "operationId": "Entity_Get", + "x-ms-examples": { + "Entity_Get": { + "$ref": "./examples/Entity_Get.json" + } + }, + "description": "Get complete definition of an entity given its GUID.", + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "$ref": "#/parameters/minExtInfo" + }, + { + "$ref": "#/parameters/ignoreRelationships" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Entity" + ], + "description": "Update entity partially - create or update entity attribute identified by its GUID.\nSupports only primitive attribute type and entity references.\nIt does not support updating complex types like arrays, and maps.\nNull updates are not possible.", + "operationId": "Entity_PartialUpdateAttributeByGuid", + "x-ms-examples": { + "Entity_PartialUpdateEntityAttributeByGuid": { + "$ref": "./examples/Entity_PartialUpdateAttributeByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "name": "name", + "in": "query", + "description": "The name of the attribute.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "The value of the attribute.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Updated with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Entity" + ], + "description": "Delete an entity identified by its GUID.", + "operationId": "Entity_Delete", + "x-ms-examples": { + "Entity_Delete": { + "$ref": "./examples/Entity_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + } + ], + "responses": { + "200": { + "description": "Deleted with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classification/{classificationName}": { + "get": { + "tags": [ + "Entity" + ], + "description": "Get classification for a given entity represented by a GUID.", + "operationId": "Entity_GetClassification", + "x-ms-examples": { + "Entity_GetClassification": { + "$ref": "./examples/Entity_GetClassification.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "$ref": "#/parameters/classificationName" + } + ], + "responses": { + "200": { + "description": "The classification for the given entity GUID.", + "schema": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Entity" + ], + "description": "Delete a given classification from an existing entity represented by a GUID.", + "operationId": "Entity_RemoveClassification", + "x-ms-examples": { + "Entity_RemoveClassification": { + "$ref": "./examples/Entity_RemoveClassification.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "$ref": "#/parameters/classificationName" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/classifications": { + "get": { + "tags": [ + "Entity" + ], + "description": "List classifications for a given entity represented by a GUID.", + "operationId": "Entity_GetClassifications", + "x-ms-examples": { + "Entity_GetClassifications": { + "$ref": "./examples/Entity_GetClassifications.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + } + ], + "responses": { + "200": { + "description": "An array of classifications for the given entity GUID.", + "schema": { + "$ref": "#/definitions/AtlasClassifications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Entity" + ], + "description": "Add classifications to an existing entity represented by a GUID.", + "operationId": "Entity_AddClassifications", + "x-ms-examples": { + "Entity_AddClassifications": { + "$ref": "./examples/Entity_AddClassifications.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "in": "body", + "name": "classifications", + "description": "An array of classifications to be added.", + "required": true, + "schema": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Entity" + ], + "description": "Update classifications to an existing entity represented by a guid.", + "operationId": "Entity_UpdateClassifications", + "x-ms-examples": { + "Entity_UpdateClassifications": { + "$ref": "./examples/Entity_UpdateClassifications.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "in": "body", + "name": "classifications", + "description": "An array of classifications to be updated.", + "required": true, + "schema": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}": { + "get": { + "tags": [ + "Entity" + ], + "description": "Get complete definition of an entity given its type and unique attribute.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=. \nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\nThe REST request would look something like this:\nGET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "operationId": "Entity_GetByUniqueAttributes", + "x-ms-examples": { + "Entity_GetByUniqueAttributes": { + "$ref": "./examples/Entity_GetByUniqueAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "$ref": "#/parameters/minExtInfo" + }, + { + "$ref": "#/parameters/ignoreRelationships" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "AtlasEntityWithExtInfo.", + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Entity" + ], + "description": "Update entity partially - Allow a subset of attributes to be updated on\nan entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName.\nNull updates are not possible.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:=.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\nThe REST request would look something like this:\nPUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "operationId": "Entity_PartialUpdateByUniqueAttributes", + "x-ms-examples": { + "Entity_PartialUpdateEntityByUniqueAttributes": { + "$ref": "./examples/Entity_PartialUpdateByUniqueAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + }, + { + "in": "body", + "name": "atlasEntityWithExtInfo", + "description": "Atlas entity with extended information.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityWithExtInfo" + } + } + ], + "responses": { + "200": { + "description": "Updated with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Entity" + ], + "description": "Delete an entity identified by its type and unique attributes.\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format:\nattr:\\=\\.\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\nThe REST request would look something like this:\nDELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "operationId": "Entity_DeleteByUniqueAttribute", + "x-ms-examples": { + "Entity_DeleteByUniqueAttribute": { + "$ref": "./examples/Entity_DeleteByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Deleted with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}": { + "delete": { + "tags": [ + "Entity" + ], + "description": "Delete a given classification from an entity identified by its type and unique attributes.", + "operationId": "Entity_RemoveClassificationByUniqueAttribute", + "x-ms-examples": { + "Entity_RemoveClassificationByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveClassificationByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "$ref": "#/parameters/classificationName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications": { + "post": { + "tags": [ + "Entity" + ], + "description": "Add classification to the entity identified by its type and unique attributes.", + "operationId": "Entity_AddClassificationsByUniqueAttribute", + "x-ms-examples": { + "Entity_AddClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_AddClassificationsByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + }, + { + "in": "body", + "name": "atlasClassificationArray", + "description": "An array of classification to be added.", + "required": true, + "schema": { + "type": "array", + "description": "An array of classification.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Entity" + ], + "description": "Update classification on an entity identified by its type and unique attributes.", + "operationId": "Entity_UpdateClassificationsByUniqueAttribute", + "x-ms-examples": { + "Entity_UpdateClassificationsByUniqueAttribute": { + "$ref": "./examples/Entity_UpdateClassificationsByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + }, + { + "in": "body", + "name": "atlasClassificationArray", + "description": "An array of classification to be updated.", + "required": true, + "schema": { + "type": "array", + "description": "An array of classification.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + } + } + ], + "responses": { + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/bulk/setClassifications": { + "post": { + "tags": [ + "Entity" + ], + "description": "Set classifications on entities in bulk.", + "operationId": "Entity_BulkSetClassifications", + "x-ms-examples": { + "Entity_BulkSetClassifications": { + "$ref": "./examples/Entity_BulkSetClassifications.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "entityHeaders", + "description": "Atlas entity headers.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasEntityHeaders" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "description": "Response that indicates each classification mutation result.", + "items": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}": { + "get": { + "tags": [ + "Entity" + ], + "description": "Bulk API to retrieve list of entities identified by its unique attributes.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\ntypeName=\\&attr_1:\\=\\&attr_2:\\=\\&attr_3:\\=\\\n\nNOTE: The attrName should be an unique attribute for the given entity-type\n\nThe REST request would look something like this\n\nGET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1\nNote: at least one unique attribute must be provided.", + "operationId": "Entity_ListByUniqueAttributes", + "x-ms-examples": { + "Entity_ListByUniqueAttributes": { + "$ref": "./examples/Entity_ListByUniqueAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "$ref": "#/parameters/minExtInfo" + }, + { + "$ref": "#/parameters/ignoreRelationships" + }, + { + "name": "attr_N:qualifiedName", + "in": "query", + "description": "Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AtlasEntitiesWithExtInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/header": { + "get": { + "tags": [ + "Entity" + ], + "description": "Get entity header given its GUID.", + "operationId": "Entity_GetHeader", + "x-ms-examples": { + "Entity_GetHeader": { + "$ref": "./examples/Entity_GetHeader.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/AtlasEntityHeader" + }, + "description": "AtlasEntityHeader" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata": { + "delete": { + "tags": [ + "Entity" + ], + "description": "Remove business metadata from an entity.", + "operationId": "Entity_RemoveBusinessMetadata", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_RemoveBusinessMetadata": { + "$ref": "./examples/Entity_RemoveBusinessMetadata.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "name": "businessMetadata", + "required": false, + "in": "body", + "schema": { + "$ref": "#/definitions/BusinessMetadata" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Entity" + ], + "description": "Add business metadata to an entity.", + "operationId": "Entity_AddOrUpdateBusinessMetadata", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_AddOrUpdateBusinessMetadata": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "in": "query", + "type": "boolean", + "name": "isOverwrite", + "description": "Whether to overwrite the existing business metadata on the entity or not, default is false.", + "required": false + }, + { + "name": "businessMetadata", + "required": false, + "in": "body", + "schema": { + "$ref": "#/definitions/BusinessMetadata" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}": { + "delete": { + "tags": [ + "Entity" + ], + "description": "Delete business metadata attributes from an entity.", + "operationId": "Entity_RemoveBusinessMetadataAttributes", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_RemoveBusinessAttribute": { + "$ref": "./examples/Entity_RemoveBusinessAttribute.json" + } + }, + "parameters": [ + { + "name": "bmName", + "in": "path", + "type": "string", + "description": "BusinessMetadata name", + "required": true + }, + { + "$ref": "#/parameters/guid" + }, + { + "name": "businessMetadataAttributes", + "required": false, + "in": "body", + "schema": { + "$ref": "#/definitions/BusinessMetadataAttributes" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Entity" + ], + "description": "Add or update business metadata attributes", + "operationId": "Entity_AddOrUpdateBusinessMetadataAttributes", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_AddOrUpdateBusinessAttribute": { + "$ref": "./examples/Entity_AddOrUpdate_BusinessAttribute.json" + } + }, + "parameters": [ + { + "name": "bmName", + "in": "path", + "type": "string", + "description": "BusinessMetadata name", + "required": true + }, + { + "$ref": "#/parameters/guid" + }, + { + "name": "businessMetadataAttributes", + "required": false, + "in": "body", + "schema": { + "$ref": "#/definitions/BusinessMetadataAttributes" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import/template": { + "get": { + "tags": [ + "Entity" + ], + "description": "Get the sample Template for uploading/creating bulk BusinessMetaData", + "operationId": "Entity_GetSampleBusinessMetadataTemplate", + "produces": [ + "application/octet-stream" + ], + "x-ms-examples": { + "Entity_GetSampleBusinessMetadataTemplate": { + "$ref": "./examples/Entity_GetSampleBusinessMetadataTemplate.json" + } + }, + "parameters": [], + "responses": { + "200": { + "schema": { + "description": "Template File", + "type": "file" + }, + "description": "Template File" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/businessmetadata/import": { + "post": { + "tags": [ + "Entity" + ], + "description": "Upload the file for creating Business Metadata in BULK", + "operationId": "Entity_ImportBusinessMetadata", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Entity_ImportBusinessMetadata": { + "$ref": "./examples/Entity_ImportBusinessMetadata.json" + } + }, + "parameters": [ + { + "name": "uploadedInputStream", + "in": "formData", + "type": "file", + "description": "InputStream of file" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/BulkImportResponse", + "description": "If Business Metadata creation was successful" + }, + "description": "If Business Metadata creation was successful" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/guid/{guid}/labels": { + "delete": { + "tags": [ + "Entity" + ], + "description": "delete given labels to a given entity", + "operationId": "Entity_RemoveLabels", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_RemoveLabels": { + "$ref": "./examples/Entity_Label.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "name": "body", + "required": false, + "in": "body", + "schema": { + "description": "set of labels to be deleted", + "type": "array", + "items": { + "type": "string" + } + }, + "description": "set of labels to be deleted" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Entity" + ], + "description": "Set labels to a given entity", + "operationId": "Entity_SetLabels", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_SetLabel": { + "$ref": "./examples/Entity_Label.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "name": "body", + "required": false, + "in": "body", + "schema": { + "description": "set of labels to be set to the entity", + "type": "array", + "items": { + "type": "string" + } + }, + "description": "set of labels to be set to the entity" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Entity" + ], + "description": "add given labels to a given entity", + "operationId": "Entity_AddLabel", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_AddLabel": { + "$ref": "./examples/Entity_Label.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "name": "body", + "required": false, + "in": "body", + "schema": { + "description": "set of labels to be added", + "type": "array", + "items": { + "type": "string" + } + }, + "description": "set of labels to be added" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels": { + "delete": { + "tags": [ + "Entity" + ], + "operationId": "Entity_RemoveLabelsByUniqueAttribute", + "description": "Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. ", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_RemoveLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_RemoveLabelsByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + }, + { + "name": "body", + "required": false, + "in": "body", + "schema": { + "description": "set of labels to be deleted", + "type": "array", + "items": { + "type": "string" + } + }, + "description": "set of labels to be deleted" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Entity" + ], + "operationId": "Entity_SetLabelsByUniqueAttribute", + "description": "Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_SetLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_SetLabelsByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + }, + { + "name": "body", + "required": false, + "in": "body", + "schema": { + "description": "set of labels to be set", + "type": "array", + "items": { + "type": "string" + } + }, + "description": "set of labels to be set" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Entity" + ], + "operationId": "Entity_AddLabelsByUniqueAttribute", + "description": "Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Entity_AddLabelsByUniqueAttribute": { + "$ref": "./examples/Entity_AddLabelsByUniqueAttribute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + }, + { + "name": "body", + "required": false, + "in": "body", + "schema": { + "description": "set of labels to be added", + "type": "array", + "items": { + "type": "string" + } + }, + "description": "set of labels to be added" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/entity/moveTo": { + "post": { + "tags": [ + "Entity" + ], + "description": "Move existing entities to the target collection.", + "operationId": "Entity_MoveEntitiesToCollection", + "x-ms-examples": { + "Collection_MoveEntitiesToCollection": { + "$ref": "./examples/Entity_MoveEntitiesToCollection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/requiredCollectionId" + }, + { + "$ref": "#/parameters/purviewAPIVersion" + }, + { + "in": "body", + "name": "moveEntitiesRequest", + "description": "Entity guids to be moved to target collection.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveEntitiesRequest" + } + } + ], + "responses": { + "200": { + "description": "Created with EntityMutationResponse.", + "schema": { + "$ref": "#/definitions/EntityMutationResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get all glossaries. Recommend using limit/offset to get pagination result. Recommended using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "operationId": "Glossary_List", + "x-ms-examples": { + "Glossary_List": { + "$ref": "./examples/Glossary_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + }, + { + "$ref": "#/parameters/ignoreTermsAndCategories" + }, + { + "$ref": "#/parameters/atlasAPIVersion" + } + ], + "responses": { + "200": { + "description": "An array of existing glossaries fitting the search criteria or empty list if nothing matches.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasGlossary" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Glossary" + ], + "description": "Create a glossary.", + "operationId": "Glossary_Create", + "x-ms-examples": { + "Glossary_Create": { + "$ref": "./examples/Glossary_Create.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "atlasGlossary", + "description": "Glossary definition, terms & categories can be anchored to a glossary.\nUsing the anchor attribute when creating the Term/Category.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary creation was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/categories": { + "post": { + "tags": [ + "Glossary" + ], + "description": "Create glossary category in bulk.", + "operationId": "Glossary_CreateCategories", + "x-ms-examples": { + "Glossary_CreateCategories": { + "$ref": "./examples/Glossary_CreateCategories.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "glossaryCategory", + "description": "An array of glossary category definitions to be created.", + "required": true, + "schema": { + "type": "array", + "description": "An array of glossary category definitions.", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + } + ], + "responses": { + "200": { + "description": "OK. If bulk glossary category creation was successful.", + "schema": { + "type": "array", + "description": "An array of glossary category created successfully in bulk.", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/category": { + "post": { + "tags": [ + "Glossary" + ], + "description": "Create a glossary category.", + "operationId": "Glossary_CreateCategory", + "x-ms-examples": { + "Glossary_CreateCategory": { + "$ref": "./examples/Glossary_CreateCategory.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "glossaryCategory", + "description": "The glossary category definition. A category must be anchored to a Glossary when creating.\nOptionally, terms belonging to the category and the hierarchy can also be defined during creation.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary category creation was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get specific glossary category by its GUID.", + "operationId": "Glossary_GetCategory", + "x-ms-examples": { + "Glossary_GetCategory": { + "$ref": "./examples/Glossary_GetCategory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/categoryGuid" + } + ], + "responses": { + "200": { + "description": "OK. If glossary category exists for given GUID.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Glossary" + ], + "description": "Update the given glossary category by its GUID.", + "operationId": "Glossary_UpdateCategory", + "x-ms-examples": { + "Glossary_UpdateCategory": { + "$ref": "./examples/Glossary_UpdateCategory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/categoryGuid" + }, + { + "in": "body", + "name": "glossaryCategory", + "description": "The glossary category to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary category partial update was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Glossary" + ], + "description": "Delete a glossary category.", + "operationId": "Glossary_DeleteCategory", + "x-ms-examples": { + "Glossary_DeleteCategory": { + "$ref": "./examples/Glossary_DeleteCategory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/categoryGuid" + } + ], + "responses": { + "204": { + "description": "OK. If glossary category deletion is successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/partial": { + "put": { + "tags": [ + "Glossary" + ], + "description": "Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.", + "operationId": "Glossary_PartialUpdateCategory", + "x-ms-examples": { + "Glossary_PartialUpdateCategory": { + "$ref": "./examples/Glossary_PartialUpdateCategory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/categoryGuid" + }, + { + "in": "body", + "name": "partialUpdates", + "description": "A map containing keys as attribute names and values as corresponding attribute values for partial update.", + "required": true, + "schema": { + "type": "object", + "description": "A map containing keys as attribute names and values as corresponding attribute values." + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary category partial update was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/related": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", + "operationId": "Glossary_ListRelatedCategories", + "x-ms-examples": { + "Glossary_ListRelatedCategories": { + "$ref": "./examples/Glossary_ListRelatedCategories.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/categoryGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. Gets an array of related categories.", + "schema": { + "$ref": "#/definitions/RelatedCategoryHeaders" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/category/{categoryGuid}/terms": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get all terms associated with the specific category.", + "operationId": "Glossary_ListCategoryTerms", + "x-ms-examples": { + "Glossary_ListCategoryTerms": { + "$ref": "./examples/Glossary_ListCategoryTerms.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/categoryGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "An array of terms for the given category or an empty list.", + "schema": { + "type": "array", + "description": "An array of terms for the given category or an empty list.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/term": { + "post": { + "tags": [ + "Glossary" + ], + "description": "Create a glossary term.", + "operationId": "Glossary_CreateTerm", + "x-ms-examples": { + "Glossary_CreateTerm": { + "$ref": "./examples/Glossary_CreateTerm.json" + }, + "Glossary_CreateTermWithTemplate": { + "$ref": "./examples/Glossary_CreateTermWithTemplate.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "glossaryTerm", + "description": "The glossary term definition. A term must be anchored to a Glossary at the time of creation.\nOptionally it can be categorized as well.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + { + "$ref": "#/parameters/includeTermHierarchy" + } + ], + "responses": { + "200": { + "description": "OK. If glossary term creation was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/term/{termGuid}": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get a specific glossary term by its GUID. ", + "operationId": "Glossary_GetTerm", + "x-ms-examples": { + "Glossary_GetTerm": { + "$ref": "./examples/Glossary_GetTerm.json" + }, + "Glossary_GetTerm_WithoutAssets": { + "$ref": "./examples/Glossary_GetTermWithoutAssets.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/termGuid" + } + ], + "responses": { + "200": { + "description": "OK. If glossary term exists for given GUID.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Glossary" + ], + "description": "Update the given glossary term by its GUID.", + "operationId": "Glossary_UpdateTerm", + "x-ms-examples": { + "Glossary_UpdateTerm": { + "$ref": "./examples/Glossary_UpdateTerm.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/termGuid" + }, + { + "in": "body", + "name": "glossaryTerm", + "description": "The glossary term to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + { + "$ref": "#/parameters/includeTermHierarchy" + } + ], + "responses": { + "200": { + "description": "OK. If glossary term update was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Glossary" + ], + "description": "Delete a glossary term.", + "operationId": "Glossary_DeleteTerm", + "x-ms-examples": { + "Glossary_DeleteTerm": { + "$ref": "./examples/Glossary_DeleteTerm.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/termGuid" + } + ], + "responses": { + "204": { + "description": "OK. If glossary term delete was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/term/{termGuid}/partial": { + "put": { + "tags": [ + "Glossary" + ], + "description": "Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.", + "operationId": "Glossary_PartialUpdateTerm", + "x-ms-examples": { + "Glossary_PartialUpdateTerm": { + "$ref": "./examples/Glossary_PartialUpdateTerm.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/termGuid" + }, + { + "$ref": "#/parameters/includeTermHierarchy" + }, + { + "in": "body", + "name": "partialUpdates", + "description": "A map containing keys as attribute names and values as corresponding attribute values to be updated.", + "required": true, + "schema": { + "type": "object", + "description": "A map containing keys as attribute names and values as corresponding attribute values." + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary partial update was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/terms": { + "post": { + "tags": [ + "Glossary" + ], + "description": "Create glossary terms in bulk.", + "operationId": "Glossary_CreateTerms", + "x-ms-examples": { + "Glossary_CreateTerms": { + "$ref": "./examples/Glossary_CreateTerms.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "in": "body", + "name": "glossaryTerm", + "description": "An array of glossary term definitions to be created in bulk.", + "required": true, + "schema": { + "type": "array", + "description": "An array of glossary term definitions.", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + }, + { + "$ref": "#/parameters/includeTermHierarchy" + } + ], + "responses": { + "200": { + "description": "OK. If bulk glossary terms creation was successful.", + "schema": { + "type": "array", + "description": "If bulk glossary terms creation was successful.", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/terms/{termGuid}/assignedEntities": { + "get": { + "tags": [ + "Glossary" + ], + "description": "List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.", + "operationId": "Glossary_ListEntitiesAssignedWithTerm", + "x-ms-examples": { + "Glossary_ListEntitiesAssignedWithTerm": { + "$ref": "./examples/Glossary_ListEntitiesAssignedWithTerm.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/termGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. An array of related objects (if any) for the given glossary or an empty list.", + "schema": { + "type": "array", + "description": "An array of related objects (if any) for the given glossary or an empty list.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Glossary" + ], + "description": "Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.", + "operationId": "Glossary_AssignTermToEntities", + "x-ms-examples": { + "Glossary_AssignTermToEntities": { + "$ref": "./examples/Glossary_AssignTermToEntities.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/termGuid" + }, + { + "in": "body", + "name": "relatedObjectIds", + "description": "An array of related object IDs to which the term has to be associated.", + "required": true, + "schema": { + "type": "array", + "description": "An array of related object IDs to which the term has to be associated.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + } + } + } + ], + "responses": { + "204": { + "description": "OK. If the term assignment was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Glossary" + ], + "description": "Delete the term assignment for the given list of related objects.", + "operationId": "Glossary_DeleteTermAssignmentFromEntities", + "x-ms-examples": { + "Glossary_RemoveTermAssignmentFromEntities": { + "$ref": "./examples/Glossary_RemoveTermAssignmentFromEntities.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/termGuid" + }, + { + "in": "body", + "name": "relatedObjectIds", + "description": "An array of related object IDs from which the term has to be dissociated.", + "required": true, + "schema": { + "type": "array", + "description": "An array of related object IDs from which the term has to be dissociated.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + } + } + } + ], + "responses": { + "204": { + "description": "OK. If glossary term dissociation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/terms/{termGuid}/related": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.", + "operationId": "Glossary_ListRelatedTerms", + "x-ms-examples": { + "Glossary_ListRelatedTerms": { + "$ref": "./examples/Glossary_ListRelatedTerms.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/termGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. An array of related glossary terms for the given glossary or an empty list.", + "schema": { + "$ref": "#/definitions/RelatedTermHeaders" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get a specific Glossary by its GUID.", + "operationId": "Glossary_Get", + "x-ms-examples": { + "Glossary_Get": { + "$ref": "./examples/Glossary_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/glossaryGuid" + } + ], + "responses": { + "200": { + "description": "OK. If glossary with given guid exists.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Glossary" + ], + "description": "Update the given glossary.", + "operationId": "Glossary_Update", + "x-ms-examples": { + "Glossary_Update": { + "$ref": "./examples/Glossary_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/glossaryGuid" + }, + { + "$ref": "#/parameters/ignoreTermsAndCategories" + }, + { + "in": "body", + "name": "updatedGlossary", + "description": "The glossary definition to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary update was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Glossary" + ], + "description": "Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.", + "operationId": "Glossary_Delete", + "x-ms-examples": { + "Glossary_Delete": { + "$ref": "./examples/Glossary_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/glossaryGuid" + } + ], + "responses": { + "204": { + "description": "OK. If glossary delete was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/categories": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.", + "operationId": "Glossary_ListCategories", + "x-ms-examples": { + "Glossary_ListCategories": { + "$ref": "./examples/Glossary_ListCategories.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/glossaryGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. An array of glossary categories for the given glossary or an empty list.", + "schema": { + "type": "array", + "description": "An array of glossary categories for the given glossary or an empty list.", + "items": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/categories/headers": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", + "operationId": "Glossary_ListCategoriesHeaders", + "x-ms-examples": { + "Glossary_ListCategoriesHeaders": { + "$ref": "./examples/Glossary_ListCategoriesHeaders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/glossaryGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. An array of glossary category headers for the given glossary or an empty list.", + "schema": { + "type": "array", + "description": "An array of glossary category headers for the given glossary or an empty list.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/detailed": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get a specific glossary with detailed information. This API is not recommend. Recommended fetch terms/categories details separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryGuid}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryGuid}/categories'.", + "operationId": "Glossary_GetDetailed", + "x-ms-examples": { + "Glossary_GetDetailed": { + "$ref": "./examples/Glossary_GetDetailed.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/glossaryGuid" + } + ], + "responses": { + "200": { + "description": "OK. If glossary exists for given GUID.", + "schema": { + "$ref": "#/definitions/AtlasGlossaryExtInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/partial": { + "put": { + "tags": [ + "Glossary" + ], + "description": "Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.", + "operationId": "Glossary_PartialUpdate", + "x-ms-examples": { + "Glossary_PartialUpdate": { + "$ref": "./examples/Glossary_PartialUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/glossaryGuid" + }, + { + "$ref": "#/parameters/ignoreTermsAndCategories" + }, + { + "in": "body", + "name": "partialUpdates", + "description": "A map containing keys as attribute names and values as corresponding attribute values.", + "required": true, + "schema": { + "type": "object", + "description": "A map containing keys as attribute names and values as corresponding attribute values." + } + } + ], + "responses": { + "200": { + "description": "OK. If glossary partial update was successful.", + "schema": { + "$ref": "#/definitions/AtlasGlossary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/terms": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.", + "operationId": "Glossary_ListTerms", + "x-ms-examples": { + "Glossary_ListTerms": { + "$ref": "./examples/Glossary_ListTerms.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/atlasAPIVersion" + }, + { + "$ref": "#/parameters/glossaryGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "schema": { + "type": "array", + "description": "An array of glossary terms for the given glossary or an empty list.", + "items": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/glossary/{glossaryGuid}/terms/headers": { + "get": { + "tags": [ + "Glossary" + ], + "description": "Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.", + "operationId": "Glossary_ListTermHeaders", + "x-ms-examples": { + "Glossary_ListTermHeaders": { + "$ref": "./examples/Glossary_ListTermHeaders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/glossaryGuid" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK. An array of glossary terms for the given glossary or an empty list.", + "schema": { + "type": "array", + "description": "An array of glossary terms for the given glossary or an empty list.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/search/query": { + "post": { + "tags": [ + "Discovery" + ], + "description": "Gets data using search.", + "operationId": "Discovery_Query", + "x-ms-examples": { + "Discovery_Query": { + "$ref": "./examples/Discovery_Query.json" + }, + "Discovery_Query_And": { + "$ref": "./examples/Discovery_Query_And.json" + }, + "Discovery_Query_Not": { + "$ref": "./examples/Discovery_Query_Not.json" + }, + "Discovery_Query_AndOrNested": { + "$ref": "./examples/Discovery_Query_AndOrNested.json" + }, + "Discovery_Query_SystemTime": { + "$ref": "./examples/Discovery_Query_SystemTime.json" + }, + "Discovery_Query_BusinessMetadataAttribute": { + "$ref": "./examples/Discovery_Query_BusinessMetadataAttribute.json" + }, + "Discovery_Query_Attribute": { + "$ref": "./examples/Discovery_Query_Attribute.json" + }, + "Discovery_Query_Classification": { + "$ref": "./examples/Discovery_Query_Classification.json" + }, + "Discovery_Query_FileExtension": { + "$ref": "./examples/Discovery_Query_FileExtension.json" + }, + "Discovery_Query_Id": { + "$ref": "./examples/Discovery_Query_Id.json" + }, + "Discovery_Query_EntityType": { + "$ref": "./examples/Discovery_Query_Type.json" + }, + "Discovery_Query_AssetType": { + "$ref": "./examples/Discovery_Query_AssetType.json" + }, + "Discovery_Query_Term": { + "$ref": "./examples/Discovery_Query_TermAssignment.json" + }, + "Discovery_Query_Facet": { + "$ref": "./examples/Discovery_Query_Facet.json" + }, + "Discovery_Query_Taxonomy": { + "$ref": "./examples/Discovery_Query_Taxonomy.json" + }, + "Discovery_Query_Collection": { + "$ref": "./examples/Discovery_Query_Collection.json" + }, + "Discovery_Query_GlossaryTerm": { + "$ref": "./examples/Discovery_Query_GlossaryTerm.json" + }, + "Discovery_Query_ObjectType": { + "$ref": "./examples/Discovery_Query_ObjectType.json" + }, + "Discovery_Query_PaginationFirstPage": { + "$ref": "./examples/Discovery_Query_PaginationFirstPage.json" + }, + "Discovery_Query_PaginationContinuationPage": { + "$ref": "./examples/Discovery_Query_PaginationContinuationPage.json" + }, + "Discovery_Query_PaginationLastPage": { + "$ref": "./examples/Discovery_Query_PaginationLastPage.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "searchRequest", + "description": "An object specifying the search criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest" + } + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the advanced search.", + "schema": { + "$ref": "#/definitions/SearchResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/search/suggest": { + "post": { + "tags": [ + "Discovery" + ], + "description": "Get search suggestions by query criteria.", + "operationId": "Discovery_Suggest", + "x-ms-examples": { + "Discovery_Suggest": { + "$ref": "./examples/Discovery_Suggest.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "suggestRequest", + "description": "An object specifying the suggest criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the suggestions.", + "schema": { + "$ref": "#/definitions/SuggestResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/search/autocomplete": { + "post": { + "tags": [ + "Discovery" + ], + "description": "Get auto complete options.", + "operationId": "Discovery_AutoComplete", + "x-ms-examples": { + "Discovery_AutoComplete": { + "$ref": "./examples/Discovery_AutoComplete.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "autoCompleteRequest", + "description": "An object specifying the autocomplete criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoCompleteRequest" + } + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the auto complete options.", + "schema": { + "$ref": "#/definitions/AutoCompleteResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/lineage/{guid}": { + "get": { + "tags": [ + "Lineage" + ], + "description": "Get lineage info of the entity specified by GUID.", + "operationId": "Lineage_Get", + "x-ms-examples": { + "Lineage_Get": { + "$ref": "./examples/Lineage_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "$ref": "#/parameters/depth" + }, + { + "$ref": "#/parameters/direction" + } + ], + "responses": { + "200": { + "description": "OK. If the request is valid.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/lineage/{guid}/next/": { + "get": { + "tags": [ + "Lineage" + ], + "description": "Return immediate next page lineage info about entity with pagination", + "operationId": "Lineage_GetNextPage", + "x-ms-examples": { + "Lineage_GetNextPage": { + "$ref": "./examples/Lineage_GetNextPage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/guid" + }, + { + "$ref": "#/parameters/direction" + }, + { + "$ref": "#/parameters/offset" + }, + { + "$ref": "#/parameters/limit" + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. If the input is valid.", + "schema": { + "$ref": "#/definitions/AtlasLineageInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/lineage/uniqueAttribute/type/{typeName}": { + "get": { + "tags": [ + "Lineage" + ], + "description": "Returns lineage info about entity.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:[attrName]=[attrValue]\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\nThe REST request would look something like this:\nGET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.", + "operationId": "Lineage_GetByUniqueAttribute", + "x-ms-examples": { + "Lineage_GetByUniqueAttribute": { + "$ref": "./examples/Lineage_GetByUniqueAttribute.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/typeName" + }, + { + "$ref": "#/parameters/depth" + }, + { + "$ref": "#/parameters/direction" + }, + { + "name": "attr:qualifiedName", + "in": "query", + "description": "The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/AtlasLineageInfo", + "description": "If Lineage exists for the given entity" + }, + "description": "If Lineage exists for the given entity" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/relationship": { + "post": { + "tags": [ + "Relationship" + ], + "description": "Create a new relationship between entities.", + "operationId": "Relationship_Create", + "x-ms-examples": { + "Relationship_Create": { + "$ref": "./examples/Relationship_Create.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "relationship", + "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "OK. The relationship is created.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Relationship" + ], + "description": "Update an existing relationship between entities.", + "operationId": "Relationship_Update", + "x-ms-examples": { + "Relationship_Update": { + "$ref": "./examples/Relationship_Update.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "relationship", + "description": "The AtlasRelationship object containing the information for the relationship to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + } + ], + "responses": { + "200": { + "description": "OK. The relationship is updated.", + "schema": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/relationship/guid/{guid}": { + "get": { + "tags": [ + "Relationship" + ], + "description": "Get relationship information between entities by its GUID.", + "operationId": "Relationship_Get", + "x-ms-examples": { + "Relationship_Get": { + "$ref": "./examples/Relationship_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/relationshipGuid" + }, + { + "$ref": "#/parameters/extendedInfo" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipWithExtInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Relationship" + ], + "description": "Delete a relationship between entities by its GUID.", + "operationId": "Relationship_Delete", + "x-ms-examples": { + "Relationship_Delete": { + "$ref": "./examples/Relationship_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/relationshipGuid" + } + ], + "responses": { + "204": { + "description": "OK. The relationship is deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the businessMetadata definition for the given guid", + "operationId": "Type_GetBusinessMetadataDefByGuid", + "x-ms-examples": { + "Type_GetBusinessMetadataDefByGuid": { + "$ref": "./examples/Type_GetBusinessMetadataDefByGuid.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "guid", + "in": "path", + "type": "string", + "description": "businessMetadata guid", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef", + "description": "On successful lookup of the the businessMetadata definition by it's guid" + }, + "description": "On successful lookup of the the businessMetadata definition by it's guid" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/businessmetadatadef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the businessMetadata definition by it's name (unique)", + "operationId": "Type_GetBusinessMetadataDefByName", + "x-ms-examples": { + "Type_GetBusinessMetadataDefByName": { + "$ref": "./examples/Type_GetBusinessMetadataDefByName.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "type": "string", + "description": "businessMetadata name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/AtlasBusinessMetadataDef", + "description": "On successful lookup of the the businessMetadata definition by it's name" + }, + "description": "On successful lookup of the the businessMetadata definition by it's name" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/classificationdef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the classification definition for the given GUID.", + "operationId": "Type_GetClassificationDefByGuid", + "x-ms-examples": { + "Type_GetClassificationDefByGuid": { + "$ref": "./examples/Type_GetClassificationDefByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/classificationDefGuid" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the classification definition by its GUID.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/classificationdef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the classification definition by its name (unique).", + "operationId": "Type_GetClassificationDefByName", + "x-ms-examples": { + "Type_GetClassificationDefByName": { + "$ref": "./examples/Type_GetClassificationDefByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/classificationDefName" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the classification definition by its name.", + "schema": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/entitydef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the Entity definition for the given GUID.", + "operationId": "Type_GetEntityDefByGuid", + "x-ms-examples": { + "Type_GetEntityDefByGuid": { + "$ref": "./examples/Type_GetEntityDefByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/entityDefGuid" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the entity definition by its GUID.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/entitydef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the entity definition by its name (unique).", + "operationId": "Type_GetEntityDefByName", + "x-ms-examples": { + "Type_GetEntityDefByName": { + "$ref": "./examples/Type_GetEntityDefByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/entityDefName" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the entity definition by its name.", + "schema": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/enumdef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the enum definition for the given GUID.", + "operationId": "Type_GetEnumDefByGuid", + "x-ms-examples": { + "Type_GetEnumDefByGuid": { + "$ref": "./examples/Type_GetEnumDefByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enumDefGuid" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the enum definition by its GUID.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/enumdef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the enum definition by its name (unique).", + "operationId": "Type_GetEnumDefByName", + "x-ms-examples": { + "Type_GetEnumDefByName": { + "$ref": "./examples/Type_GetEnumDefByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enumDefName" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the enum definition by its name.", + "schema": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/relationshipdef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the relationship definition for the given GUID.", + "operationId": "Type_GetRelationshipDefByGuid", + "x-ms-examples": { + "Type_GetRelationshipDefByGuid": { + "$ref": "./examples/Type_GetRelationshipDefByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/relationshipDefGuid" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the relationship definition by its GUID.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/relationshipdef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the relationship definition by its name (unique).", + "operationId": "Type_GetRelationshipDefByName", + "x-ms-examples": { + "Type_GetRelationshipDefByName": { + "$ref": "./examples/Type_GetRelationshipDefByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/relationshipDefName" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the relationship definition by its name.", + "schema": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/structdef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the struct definition for the given GUID.", + "operationId": "Type_GetStructDefByGuid", + "x-ms-examples": { + "Type_GetStructDefByGuid": { + "$ref": "./examples/Type_GetStructDefByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/structDefGuid" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the struct definition by its GUID.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/structdef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the struct definition by its name (unique).", + "operationId": "Type_GetStructDefByName", + "x-ms-examples": { + "Type_GetStructDefByName": { + "$ref": "./examples/Type_GetStructDefByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/structDefName" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the struct definition by its name.", + "schema": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/typedef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the type definition for the given GUID.", + "operationId": "Type_GetByGuid", + "x-ms-examples": { + "Type_GetByGuid": { + "$ref": "./examples/Type_GetByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeDefGuid" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the type definition by its GUID.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/typedef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the type definition by its name (unique).", + "operationId": "Type_GetByName", + "x-ms-examples": { + "Type_GetByName": { + "$ref": "./examples/Type_GetByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeDefName" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the type definition by its name.", + "schema": { + "$ref": "#/definitions/AtlasTypeDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Type" + ], + "description": "Delete API for type identified by its name.", + "operationId": "Type_Delete", + "x-ms-examples": { + "Type_Delete": { + "$ref": "./examples/Type_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/typeDefName" + } + ], + "responses": { + "204": { + "description": "On successful deletion of the requested type definitions" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/typedefs": { + "get": { + "tags": [ + "Type" + ], + "description": "List all type definitions in bulk.", + "operationId": "Type_List", + "x-ms-examples": { + "Type_List": { + "$ref": "./examples/Type_List.json" + }, + "Type_ListEnumDefs": { + "$ref": "./examples/Type_ListEnumDefs.json" + }, + "Type_ListTermTemplateDefs": { + "$ref": "./examples/Type_ListTermTemplateDefs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/includeTermTemplate" + }, + { + "$ref": "#/parameters/type" + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. AtlasTypesDef with type definitions matching the search criteria or else returns empty list of type definitions.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Type" + ], + "description": "Create all atlas type definitions in bulk, only new definitions will be created.\nAny changes to the existing definitions will be discarded.", + "operationId": "Type_BulkCreate", + "x-ms-examples": { + "Type_BulkCreate": { + "$ref": "./examples/Type_BulkCreate.json" + }, + "Type_BulkCreateBusinessMetadataDefs": { + "$ref": "./examples/Type_BulkCreateBusinessMetadataDefs.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "typesDef", + "description": "A composite wrapper object with corresponding lists of the type definition.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "OK. On successful update of requested type definitions.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Type" + ], + "description": "Update all types in bulk, changes detected in the type definitions would be persisted.", + "operationId": "Type_BulkUpdate", + "x-ms-examples": { + "Type_BulkUpdate": { + "$ref": "./examples/Type_BulkUpdate.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "typesDef", + "description": "A composite object that captures all type definition changes.", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "200": { + "description": "OK. On successful update of requested type definitions.", + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Type" + ], + "description": "Delete API for all types in bulk.", + "operationId": "Type_BulkDelete", + "x-ms-examples": { + "Type_BulkDelete": { + "$ref": "./examples/Type_BulkDelete.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "typesDef", + "description": "A composite object that captures all types to be deleted", + "required": true, + "schema": { + "$ref": "#/definitions/AtlasTypesDef" + } + } + ], + "responses": { + "204": { + "description": "OK. On successful deletion of the requested type definitions." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/atlas/v2/types/typedefs/headers": { + "get": { + "tags": [ + "Type" + ], + "description": "List all type definitions returned as a list of minimal information header.", + "operationId": "Type_ListHeaders", + "x-ms-examples": { + "Type_ListHeaders": { + "$ref": "./examples/Type_ListHeaders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/includeTermTemplate" + }, + { + "$ref": "#/parameters/type" + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", + "schema": { + "type": "array", + "description": "An array of AtlasTypeDefHeader matching the search criteria\nor an empty list if no match.", + "items": { + "$ref": "#/definitions/AtlasTypeDefHeader" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/types/termtemplatedef/guid/{guid}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the term template definition for the given GUID.", + "operationId": "Type_GetTermTemplateDefByGuid", + "x-ms-examples": { + "Type_GetTermTemplateDefByGuid": { + "$ref": "./examples/Type_GetTermTemplateDefByGuid.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/termTemplateDefGuid" + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the term template definition by its GUID.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/types/termtemplatedef/name/{name}": { + "get": { + "tags": [ + "Type" + ], + "description": "Get the term template definition by its name (unique).", + "operationId": "Type_GetTermTemplateDefByName", + "x-ms-examples": { + "Type_GetTermTemplateDefByName": { + "$ref": "./examples/Type_GetTermTemplateDefByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/termTemplateDefName" + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. On successful lookup of the the term template definition by its name.", + "schema": { + "$ref": "#/definitions/TermTemplateDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AtlasAttributeDef": { + "type": "object", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality" + }, + "constraints": { + "type": "array", + "description": "An array of constraints.", + "items": { + "$ref": "#/definitions/AtlasConstraintDef" + } + }, + "defaultValue": { + "type": "string", + "description": "The default value of the attribute." + }, + "description": { + "type": "string", + "description": "The description of the attribute." + }, + "includeInNotification": { + "type": "boolean", + "description": "Determines if it is included in notification." + }, + "isIndexable": { + "type": "boolean", + "description": "Determines if it is indexable." + }, + "isOptional": { + "type": "boolean", + "description": "Determines if it is optional." + }, + "isUnique": { + "type": "boolean", + "description": "Determines if it unique." + }, + "name": { + "type": "string", + "description": "The name of the attribute." + }, + "options": { + "type": "object", + "description": "The options for the attribute.", + "additionalProperties": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "valuesMaxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum count of the values." + }, + "valuesMinCount": { + "type": "integer", + "format": "int32", + "description": "The minimum count of the values." + } + }, + "title": "AtlasAttributeDef", + "description": "class that captures details of a struct-attribute." + }, + "AtlasBaseModelObject": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + } + }, + "title": "AtlasBaseModelObject", + "description": "The base model object." + }, + "AtlasBaseTypeDef": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory" + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "dateFormatter": { + "$ref": "#/definitions/DateFormat" + }, + "description": { + "type": "string", + "description": "The description of the type definition." + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + }, + "options": { + "type": "object", + "description": "The options for the type definition.", + "additionalProperties": { + "type": "string" + } + }, + "serviceType": { + "readOnly": false, + "description": "The service type.", + "type": "string" + }, + "typeVersion": { + "type": "string", + "description": "The version of the type." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "number", + "description": "The version of the record." + }, + "lastModifiedTS": { + "$ref": "#/definitions/LastModifiedTS" + } + }, + "title": "AtlasBaseTypeDef", + "description": "Base class that captures common-attributes for all types." + }, + "AtlasBusinessMetadataDef": { + "type": "object", + "title": "AtlasBusinessMetadataDef", + "allOf": [ + { + "$ref": "#/definitions/AtlasStructDef" + } + ], + "description": "class that captures details of a struct-type." + }, + "AtlasClassification": { + "type": "object", + "title": "AtlasClassification", + "properties": { + "entityGuid": { + "type": "string", + "description": "The GUID of the entity." + }, + "entityStatus": { + "$ref": "#/definitions/Status" + }, + "removePropagationsOnEntityDelete": { + "type": "boolean", + "description": "Determines if propagations will be removed on entity deletion." + }, + "validityPeriods": { + "type": "array", + "description": "An array of time boundaries indicating validity periods.", + "items": { + "$ref": "#/definitions/TimeBoundary" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStruct" + } + ], + "description": "An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity." + }, + "AtlasClassificationDef": { + "type": "object", + "title": "AtlasClassificationDef", + "properties": { + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n
    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStructDef" + } + ], + "description": "class that captures details of a classification-type." + }, + "AtlasClassifications": { + "type": "object", + "title": "AtlasClassifications", + "allOf": [ + { + "$ref": "#/definitions/PList" + } + ], + "description": "REST serialization friendly list." + }, + "AtlasConstraintDef": { + "type": "object", + "properties": { + "params": { + "type": "object", + "description": "The parameters of the constraint definition.", + "additionalProperties": {} + }, + "type": { + "type": "string", + "description": "The type of the constraint." + } + }, + "title": "AtlasConstraintDef", + "description": "class that captures details of a constraint." + }, + "AtlasEntitiesWithExtInfo": { + "type": "object", + "title": "AtlasEntitiesWithExtInfo", + "properties": { + "entities": { + "type": "array", + "description": "An array of entities.", + "items": { + "$ref": "#/definitions/AtlasEntity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasEntityExtInfo" + } + ], + "description": "An instance of an entity along with extended info - like hive_table, hive_database." + }, + "AtlasEntity": { + "type": "object", + "title": "AtlasEntity", + "properties": { + "businessAttributes": { + "readOnly": false, + "description": "Business Attributes", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "customAttributes": { + "readOnly": false, + "description": "Custom Attribute", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "guid": { + "type": "string", + "description": "The GUID of the entity." + }, + "homeId": { + "type": "string", + "description": "The home ID of the entity." + }, + "collectionId": { + "readOnly": true, + "type": "string", + "description": "The collection ID of the entity." + }, + "isIncomplete": { + "readOnly": false, + "description": "Whether it is a shell entity", + "type": "boolean" + }, + "labels": { + "readOnly": false, + "description": "labels", + "type": "array", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers indicating the meanings of the entity.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + } + }, + "provenanceType": { + "readOnly": false, + "description": "Used to record the provenance of an instance of an entity or relationship.", + "type": "number" + }, + "proxy": { + "type": "boolean", + "description": "Determines if there's a proxy." + }, + "relationshipAttributes": { + "type": "object", + "description": "The attributes of relationship.", + "additionalProperties": {} + }, + "status": { + "$ref": "#/definitions/Status" + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "number", + "description": "The version of the entity." + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for entities. Key could be Expert or Owner.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactBasic" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStruct" + } + ], + "description": "An instance of an entity - like hive_table, hive_database." + }, + "TermTemplateDef": { + "type": "object", + "title": "TermTemplateDef", + "allOf": [ + { + "$ref": "#/definitions/AtlasStructDef" + } + ], + "description": "term template definition for glossary term." + }, + "AtlasEntityDef": { + "type": "object", + "title": "AtlasEntityDef", + "properties": { + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStructDef" + } + ], + "description": "class that captures details of a entity-type." + }, + "AtlasEntityExtInfo": { + "type": "object", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entities.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntity" + } + } + }, + "title": "AtlasEntityExtInfo", + "description": "An instance of an entity along with extended info - like hive_table, hive_database." + }, + "AtlasEntityHeader": { + "type": "object", + "title": "AtlasEntityHeader", + "properties": { + "classificationNames": { + "type": "array", + "description": "An array of classification names.", + "items": { + "type": "string" + } + }, + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "guid": { + "type": "string", + "description": "The GUID of the record." + }, + "isIncomplete": { + "readOnly": false, + "description": "Whether it is a shell entity", + "type": "boolean" + }, + "labels": { + "readOnly": false, + "description": "labels", + "type": "array", + "items": { + "type": "string" + } + }, + "meaningNames": { + "type": "array", + "description": "An array of meanings.", + "items": { + "type": "string" + } + }, + "meanings": { + "type": "array", + "description": "An array of term assignment headers.", + "items": { + "$ref": "#/definitions/AtlasTermAssignmentHeader" + } + }, + "status": { + "$ref": "#/definitions/Status" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStruct" + } + ], + "description": "An instance of an entity - like hive_table, hive_database." + }, + "AtlasEntityHeaders": { + "type": "object", + "title": "AtlasEntityHeaders", + "properties": { + "guidHeaderMap": { + "readOnly": false, + "description": "The description of the guid header map,", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + } + }, + "description": "An instance of an entity header map." + }, + "AtlasEntityWithExtInfo": { + "type": "object", + "title": "AtlasEntityWithExtInfo", + "properties": { + "entity": { + "$ref": "#/definitions/AtlasEntity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasEntityExtInfo" + } + ], + "description": "An instance of an entity along with extended info - like hive_table, hive_database." + }, + "AtlasEnumDef": { + "type": "object", + "title": "AtlasEnumDef", + "properties": { + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasBaseTypeDef" + } + ], + "description": "class that captures details of an enum-type." + }, + "AtlasEnumElementDef": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the enum element definition." + }, + "ordinal": { + "type": "number", + "description": "The ordinal of the enum element definition." + }, + "value": { + "type": "string", + "description": "The value of the enum element definition." + } + }, + "title": "AtlasEnumElementDef", + "description": "class that captures details of an enum-element." + }, + "AtlasGlossary": { + "type": "object", + "title": "AtlasGlossary", + "properties": { + "categories": { + "type": "array", + "description": "An array of categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + } + }, + "language": { + "type": "string", + "description": "The language of the glossary." + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "usage": { + "type": "string", + "description": "The usage of the glossary." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasGlossaryBaseObject" + } + ], + "description": "The glossary object." + }, + "AtlasGlossaryBaseObject": { + "type": "object", + "title": "AtlasGlossaryBaseObject", + "properties": { + "classifications": { + "type": "array", + "description": "An array of classifications.", + "items": { + "$ref": "#/definitions/AtlasClassification" + } + }, + "longDescription": { + "type": "string", + "description": "The long version description." + }, + "name": { + "type": "string", + "description": "The name of the glossary object." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the glossary object." + }, + "shortDescription": { + "type": "string", + "description": "The short version of description." + }, + "lastModifiedTS": { + "$ref": "#/definitions/LastModifiedTS" + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasBaseModelObject" + } + ], + "description": "The glossary base object." + }, + "AtlasGlossaryCategory": { + "type": "object", + "title": "AtlasGlossaryCategory", + "properties": { + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader" + }, + "childrenCategories": { + "type": "array", + "description": "An array of children categories.", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + } + }, + "parentCategory": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + }, + "terms": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasGlossaryBaseObject" + } + ], + "description": "The glossary category." + }, + "AtlasGlossaryExtInfo": { + "type": "object", + "title": "AtlasGlossaryExtInfo", + "properties": { + "categoryInfo": { + "type": "object", + "description": "The glossary category information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryCategory" + } + }, + "termInfo": { + "type": "object", + "description": "The glossary term information.", + "additionalProperties": { + "$ref": "#/definitions/AtlasGlossaryTerm" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasGlossary" + } + ], + "description": "The extended information of glossary." + }, + "AtlasGlossaryHeader": { + "type": "object", + "properties": { + "displayText": { + "type": "string", + "description": "The display text." + }, + "glossaryGuid": { + "type": "string", + "description": "The GUID of the glossary." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + }, + "title": "AtlasGlossaryHeader", + "description": "The glossary header with basic information." + }, + "AtlasGlossaryTerm": { + "type": "object", + "title": "AtlasGlossaryTerm", + "properties": { + "abbreviation": { + "type": "string", + "description": "The abbreviation of the term." + }, + "templateName": { + "type": "array", + "items": { + "type": "object" + } + }, + "anchor": { + "$ref": "#/definitions/AtlasGlossaryHeader" + }, + "antonyms": { + "type": "array", + "description": "An array of related term headers as antonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "status": { + "$ref": "#/definitions/TermStatus" + }, + "nickName": { + "type": "string", + "description": "The nick name of the term." + }, + "hierarchyInfo": { + "type": "array", + "description": "The hierarchy information of the term.", + "items": { + "$ref": "#/definitions/PurviewObjectId" + } + }, + "resources": { + "type": "array", + "description": "An array of resource link for term", + "items": { + "$ref": "#/definitions/ResourceLink" + } + }, + "contacts": { + "type": "object", + "description": "The dictionary of contacts for terms. Key could be Expert or Steward.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactBasic" + } + } + }, + "attributes": { + "$ref": "#/definitions/TermCustomAttributes" + }, + "assignedEntities": { + "type": "array", + "description": "An array of related object IDs.", + "items": { + "$ref": "#/definitions/AtlasRelatedObjectId" + } + }, + "categories": { + "type": "array", + "description": "An array of term categorization headers.", + "items": { + "$ref": "#/definitions/AtlasTermCategorizationHeader" + } + }, + "classifies": { + "type": "array", + "description": "An array of related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "examples": { + "type": "array", + "description": "An array of examples.", + "items": { + "type": "string" + } + }, + "isA": { + "type": "array", + "description": "An array of related term headers indicating the is-a relationship.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "preferredTerms": { + "type": "array", + "description": "An array of preferred related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "preferredToTerms": { + "type": "array", + "description": "An array of related term headers that are preferred to.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "replacedBy": { + "type": "array", + "description": "An array of related term headers that are replaced by.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "replacementTerms": { + "type": "array", + "description": "An array of related term headers for replacement.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "seeAlso": { + "type": "array", + "description": "An array of related term headers for see also.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "synonyms": { + "type": "array", + "description": "An array of related term headers as synonyms.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "translatedTerms": { + "type": "array", + "description": "An array of translated related term headers.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "translationTerms": { + "type": "array", + "description": "An array of related term headers for translation.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "usage": { + "type": "string", + "description": "The usage of the term." + }, + "validValues": { + "type": "array", + "description": "An array of related term headers as valid values.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + }, + "validValuesFor": { + "type": "array", + "description": "An array of related term headers as valid values for other records.", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasGlossaryBaseObject" + } + ], + "description": "The glossary term." + }, + "ResourceLink": { + "title": "ResourceLink", + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for url." + }, + "url": { + "type": "string", + "description": "web url. http or https" + } + } + }, + "ContactBasic": { + "title": "ContactBasic", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure Active Directory object Id." + }, + "info": { + "type": "string", + "description": "additional information to describe this contact." + } + } + }, + "TermStatus": { + "type": "string", + "title": "Status", + "description": "Status of the AtlasGlossaryTerm", + "enum": [ + "Draft", + "Approved", + "Alert", + "Expired" + ], + "x-ms-enum": { + "name": "TermStatus", + "modelAsString": true + } + }, + "TermCustomAttributes": { + "title": "attributes", + "description": "The custom attributes of the term, which is map>.\nThe key of the first layer map is term template name.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TermCustomAttributesExtraProperties" + } + }, + "TermCustomAttributesExtraProperties": { + "type": "object", + "description": "The term attribute name and attribute value, which is map", + "additionalProperties": { + "description": "The value of custom term attribute" + } + }, + "AtlasLineageInfo": { + "type": "object", + "properties": { + "baseEntityGuid": { + "type": "string", + "description": "The GUID of the base entity." + }, + "guidEntityMap": { + "type": "object", + "description": "The GUID entity map.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "widthCounts": { + "type": "object", + "description": "The entity count in specific direction.", + "additionalProperties": { + "$ref": "#/definitions/AtlasLineageInfoExtraProperties" + } + }, + "lineageDepth": { + "type": "integer", + "format": "int32", + "description": "The depth of lineage." + }, + "lineageWidth": { + "type": "integer", + "format": "int32", + "description": "The width of lineage." + }, + "childrenCount": { + "type": "integer", + "format": "int32", + "description": "The number of children node." + }, + "lineageDirection": { + "$ref": "#/definitions/LineageDirection" + }, + "parentRelations": { + "type": "array", + "description": "An array of parentRelations relations.", + "items": { + "$ref": "#/definitions/ParentRelation" + } + }, + "relations": { + "type": "array", + "description": "An array of lineage relations.", + "items": { + "$ref": "#/definitions/LineageRelation" + } + } + }, + "title": "AtlasLineageInfo", + "description": "The lineage information." + }, + "AtlasLineageInfoExtraProperties": { + "type": "object", + "description": "The lineage direction", + "additionalProperties": { + "description": "The entity guid." + } + }, + "AtlasObjectId": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "description": "The GUID of the object." + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "uniqueAttributes": { + "type": "object", + "description": "The unique attributes of the object.", + "additionalProperties": {} + } + }, + "title": "AtlasObjectId", + "description": "Reference to an object-instance of a type - like entity." + }, + "PurviewObjectId": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayText": { + "type": "string" + }, + "itemPath": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "properties": { + "type": "object", + "additionalProperties": {} + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasObjectId" + } + ], + "title": "PurviewObjectId" + }, + "AtlasRelatedCategoryHeader": { + "type": "object", + "properties": { + "categoryGuid": { + "type": "string", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the category header." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "parentCategoryGuid": { + "type": "string", + "description": "The GUID of the parent category." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + } + }, + "title": "AtlasRelatedCategoryHeader", + "description": "The header of the related category." + }, + "AtlasRelatedObjectId": { + "type": "object", + "title": "AtlasRelatedObjectId", + "properties": { + "displayText": { + "type": "string", + "description": "The display text." + }, + "entityStatus": { + "$ref": "#/definitions/Status" + }, + "relationshipType": { + "type": "string" + }, + "relationshipAttributes": { + "$ref": "#/definitions/AtlasStruct" + }, + "relationshipGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "relationshipStatus": { + "$ref": "#/definitions/Status_AtlasRelationship" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasObjectId" + } + ], + "description": "Reference to an object-instance of AtlasEntity type used in relationship attribute values" + }, + "AtlasRelatedTermHeader": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the related term." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus" + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + }, + "title": "AtlasRelatedTermHeader", + "description": "The header of the related term." + }, + "AtlasRelationship": { + "type": "object", + "title": "AtlasRelationship", + "properties": { + "createTime": { + "type": "integer", + "format": "int64", + "description": "The created time of the record." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "end1": { + "$ref": "#/definitions/AtlasObjectId" + }, + "end2": { + "$ref": "#/definitions/AtlasObjectId" + }, + "guid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "homeId": { + "type": "string", + "description": "The home ID of the relationship." + }, + "label": { + "type": "string", + "description": "The label of the relationship." + }, + "provenanceType": { + "readOnly": false, + "description": "Used to record the provenance of an instance of an entity or relationship", + "type": "number" + }, + "status": { + "$ref": "#/definitions/Status_AtlasRelationship" + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The update time of the record." + }, + "updatedBy": { + "type": "string", + "description": "The user who updated the record." + }, + "version": { + "type": "number", + "description": "The version of the relationship." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStruct" + } + ], + "description": "Atlas relationship instance." + }, + "AtlasRelationshipDef": { + "type": "object", + "title": "AtlasRelationshipDef", + "properties": { + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef" + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef" + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory" + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasStructDef" + } + ], + "description": "AtlasRelationshipDef is a TypeDef that defines a relationship.\n

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

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

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

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

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

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

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

\nIn this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into\nthe entity instances" + }, + "AtlasRelationshipEndDef": { + "type": "object", + "properties": { + "cardinality": { + "$ref": "#/definitions/Cardinality" + }, + "description": { + "type": "string", + "description": "The description of the relationship end definition." + }, + "isContainer": { + "type": "boolean", + "description": "Determines if it is container." + }, + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "name": { + "type": "string", + "description": "The name of the relationship end definition." + }, + "type": { + "type": "string", + "description": "The type of the relationship end." + } + }, + "title": "AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." + }, + "AtlasRelationshipAttributeDef": { + "type": "object", + "properties": { + "isLegacyAttribute": { + "type": "boolean", + "description": "Determines if it is a legacy attribute." + }, + "relationshipTypeName": { + "type": "string", + "description": "The name of the relationship type." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasAttributeDef" + } + ], + "title": "AtlasRelationshipEndDef", + "description": "The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an\nattribute name, cardinality and whether it is the container end of the relationship." + }, + "AtlasRelationshipWithExtInfo": { + "type": "object", + "properties": { + "referredEntities": { + "type": "object", + "description": "The referred entity header.", + "additionalProperties": { + "$ref": "#/definitions/AtlasEntityHeader" + } + }, + "relationship": { + "$ref": "#/definitions/AtlasRelationship" + } + }, + "title": "AtlasRelationshipWithExtInfo", + "description": "The relationship with extended information." + }, + "AtlasStruct": { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "description": "The attributes of the struct.", + "additionalProperties": {} + }, + "typeName": { + "type": "string", + "description": "The name of the type." + }, + "lastModifiedTS": { + "$ref": "#/definitions/LastModifiedTS" + } + }, + "title": "AtlasStruct", + "description": "Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification." + }, + "AtlasStructDef": { + "type": "object", + "title": "AtlasStructDef", + "properties": { + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AtlasBaseTypeDef" + } + ], + "description": "class that captures details of a struct-type." + }, + "AtlasTermAssignmentHeader": { + "type": "object", + "properties": { + "confidence": { + "type": "integer", + "format": "int32", + "description": "The confidence of the term assignment." + }, + "createdBy": { + "type": "string", + "description": "The user who created the record." + }, + "description": { + "type": "string", + "description": "The description of the term assignment." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "expression": { + "type": "string", + "description": "The expression of the term assignment." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermAssignmentStatus" + }, + "steward": { + "type": "string", + "description": "The steward of the term." + }, + "termGuid": { + "type": "string", + "description": "The GUID of the term." + } + }, + "title": "AtlasTermAssignmentHeader", + "description": "The header for term assignment." + }, + "AtlasTermAssignmentStatus": { + "type": "string", + "title": "AtlasTermAssignmentStatus", + "description": "The status of terms assignment.", + "enum": [ + "DISCOVERED", + "PROPOSED", + "IMPORTED", + "VALIDATED", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermAssignmentStatus", + "modelAsString": true + } + }, + "AtlasTermCategorizationHeader": { + "type": "object", + "properties": { + "categoryGuid": { + "type": "string", + "description": "The GUID of the category." + }, + "description": { + "type": "string", + "description": "The description of the record." + }, + "displayText": { + "type": "string", + "description": "The display text." + }, + "relationGuid": { + "type": "string", + "description": "The GUID of the relationship." + }, + "status": { + "$ref": "#/definitions/AtlasTermRelationshipStatus" + } + }, + "title": "AtlasTermCategorizationHeader", + "description": "The basic information for term categorization." + }, + "AtlasTermRelationshipStatus": { + "type": "string", + "title": "AtlasTermRelationshipStatus", + "description": "The status of term relationship.", + "enum": [ + "DRAFT", + "ACTIVE", + "DEPRECATED", + "OBSOLETE", + "OTHER" + ], + "x-ms-enum": { + "name": "AtlasTermRelationshipStatus", + "modelAsString": true + } + }, + "AtlasTypeDefHeader": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/TypeCategory" + }, + "guid": { + "type": "string", + "description": "The GUID of the type definition." + }, + "name": { + "type": "string", + "description": "The name of the type definition." + } + }, + "title": "AtlasTypeDefHeader", + "description": "The basic information of the type definition." + }, + "AtlasTypesDef": { + "type": "object", + "properties": { + "businessMetadataDefs": { + "readOnly": false, + "description": "businessMetadataDefs", + "type": "array", + "items": { + "$ref": "#/definitions/AtlasBusinessMetadataDef" + } + }, + "classificationDefs": { + "type": "array", + "description": "An array of classification definitions.", + "items": { + "$ref": "#/definitions/AtlasClassificationDef" + } + }, + "entityDefs": { + "type": "array", + "description": "An array of entity definitions.", + "items": { + "$ref": "#/definitions/AtlasEntityDef" + } + }, + "enumDefs": { + "type": "array", + "description": "An array of enum definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumDef" + } + }, + "relationshipDefs": { + "type": "array", + "description": "An array of relationship definitions.", + "items": { + "$ref": "#/definitions/AtlasRelationshipDef" + } + }, + "structDefs": { + "type": "array", + "description": "An array of struct definitions.", + "items": { + "$ref": "#/definitions/AtlasStructDef" + } + }, + "termTemplateDefs": { + "type": "array", + "description": "An array of term template definitions.", + "items": { + "$ref": "#/definitions/TermTemplateDef" + } + } + }, + "title": "AtlasTypesDef", + "description": "The definitions of types." + }, + "AtlasExtraTypeDef": { + "type": "object", + "properties": { + "entityTypes": { + "type": "array", + "description": "Specifying a list of entityType names in the classificationDef, ensures that classifications can\nonly be applied to those entityTypes.\n

    \n
  • Any subtypes of the entity types inherit the restriction
    • \n
  • Any classificationDef subtypes inherit the parents entityTypes restrictions
    • \n
  • Any classificationDef subtypes can further restrict the parents entityTypes restrictions by specifying a subset of the entityTypes
    • \n
  • An empty entityTypes list when there are no parent restrictions means there are no restrictions
    • \n
  • An empty entityTypes list when there are parent restrictions means that the subtype picks up the parents restrictions
    • \n
  • If a list of entityTypes are supplied, where one inherits from another, this will be rejected. This should encourage cleaner classificationsDefs
    • \n
", + "items": { + "type": "string" + } + }, + "subTypes": { + "type": "array", + "description": "An array of sub types.", + "items": { + "type": "string" + } + }, + "superTypes": { + "type": "array", + "description": "An array of super types.", + "items": { + "type": "string" + } + }, + "relationshipAttributeDefs": { + "type": "array", + "description": "An array of relationship attributes.", + "items": { + "$ref": "#/definitions/AtlasRelationshipAttributeDef" + } + }, + "defaultValue": { + "type": "string", + "description": "The default value." + }, + "elementDefs": { + "type": "array", + "description": "An array of enum element definitions.", + "items": { + "$ref": "#/definitions/AtlasEnumElementDef" + } + }, + "endDef1": { + "$ref": "#/definitions/AtlasRelationshipEndDef" + }, + "endDef2": { + "$ref": "#/definitions/AtlasRelationshipEndDef" + }, + "relationshipCategory": { + "$ref": "#/definitions/RelationshipCategory" + }, + "relationshipLabel": { + "type": "string", + "description": "The label of the relationship." + }, + "attributeDefs": { + "type": "array", + "description": "An array of attribute definitions.", + "items": { + "$ref": "#/definitions/AtlasAttributeDef" + } + } + }, + "title": "AtlasExtraTypeDef", + "description": "Extra properties for a type." + }, + "AtlasTypeDef": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AtlasBaseTypeDef" + }, + { + "$ref": "#/definitions/AtlasExtraTypeDef" + } + ], + "title": "AtlasTypeDef", + "description": "The definitions of type." + }, + "ImportInfo": { + "type": "object", + "title": "ImportInfo", + "properties": { + "childObjectName": { + "readOnly": false, + "description": "childObjectName", + "type": "string" + }, + "importStatus": { + "readOnly": false, + "$ref": "#/definitions/ImportStatus", + "description": "importStatus" + }, + "parentObjectName": { + "readOnly": false, + "description": "parentObjectName", + "type": "string" + }, + "remarks": { + "readOnly": false, + "description": "remarks", + "type": "string" + } + }, + "example": { + "childObjectName": "...", + "importStatus": "SUCCESS", + "parentObjectName": "...", + "remarks": "..." + }, + "description": "ImportInfo" + }, + "ImportStatus": { + "type": "string", + "title": "ImportStatus", + "enum": [ + "SUCCESS", + "FAILED" + ], + "description": "ImportStatus", + "x-ms-enum": { + "name": "importStatus", + "modelAsString": true + } + }, + "BulkImportResponse": { + "type": "object", + "title": "BulkImportResponse", + "properties": { + "failedImportInfoList": { + "readOnly": false, + "description": "failed importInfoList", + "type": "array", + "items": { + "$ref": "#/definitions/ImportInfo" + } + }, + "successImportInfoList": { + "readOnly": false, + "description": "successful importInfoList", + "type": "array", + "items": { + "$ref": "#/definitions/ImportInfo" + } + } + }, + "example": { + "failedImportInfoList": [ + { + "childObjectName": "...", + "importStatus": "SUCCESS", + "parentObjectName": "...", + "remarks": "..." + }, + { + "childObjectName": "...", + "importStatus": "SUCCESS", + "parentObjectName": "...", + "remarks": "..." + } + ], + "successImportInfoList": [ + { + "childObjectName": "...", + "importStatus": "FAILED", + "parentObjectName": "...", + "remarks": "..." + }, + { + "childObjectName": "...", + "importStatus": "FAILED", + "parentObjectName": "...", + "remarks": "..." + } + ] + }, + "description": "example" + }, + "Cardinality": { + "type": "string", + "title": "Cardinality", + "description": "single-valued attribute or multi-valued attribute.", + "enum": [ + "SINGLE", + "LIST", + "SET" + ], + "x-ms-enum": { + "name": "Cardinality", + "modelAsString": true + } + }, + "ClassificationAssociateRequest": { + "type": "object", + "properties": { + "classification": { + "$ref": "#/definitions/AtlasClassification" + }, + "entityGuids": { + "type": "array", + "description": "The GUID of the entity.", + "items": { + "type": "string" + } + } + }, + "title": "ClassificationAssociateRequest", + "description": "The request for classification association." + }, + "MoveEntitiesRequest": { + "type": "object", + "properties": { + "entityGuids": { + "type": "array", + "description": "An array of entity guids to be moved to target collection.", + "items": { + "type": "string" + } + } + } + }, + "DateFormat": { + "type": "object", + "title": "DateFormat", + "properties": { + "availableLocales": { + "type": "array", + "description": "An array of available locales.", + "items": { + "type": "string" + } + }, + "calendar": { + "type": "number" + }, + "dateInstance": { + "$ref": "#/definitions/DateFormat" + }, + "dateTimeInstance": { + "$ref": "#/definitions/DateFormat" + }, + "instance": { + "$ref": "#/definitions/DateFormat" + }, + "lenient": { + "type": "boolean", + "description": "Determines the leniency of the date format." + }, + "numberFormat": { + "$ref": "#/definitions/NumberFormat" + }, + "timeInstance": { + "$ref": "#/definitions/DateFormat" + }, + "timeZone": { + "$ref": "#/definitions/TimeZone" + } + }, + "description": "The date format." + }, + "EntityMutationResponse": { + "type": "object", + "properties": { + "guidAssignments": { + "type": "object", + "description": "A map of GUID assignments with entities.", + "additionalProperties": { + "type": "string" + } + }, + "mutatedEntities": { + "type": "object", + "description": "The entity headers of mutated entities.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + } + } + }, + "partialUpdatedEntities": { + "type": "array", + "description": "An array of entity headers that partially updated.", + "items": { + "$ref": "#/definitions/AtlasEntityHeader" + } + } + }, + "title": "EntityMutationResponse", + "description": "The mutation response of entity." + }, + "LineageDirection": { + "type": "string", + "title": "LineageDirection", + "description": "The enum of lineage direction.", + "enum": [ + "INPUT", + "OUTPUT", + "BOTH" + ], + "x-ms-enum": { + "name": "LineageDirection", + "modelAsString": true + } + }, + "LineageRelation": { + "type": "object", + "properties": { + "fromEntityId": { + "type": "string", + "description": "The GUID of from-entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "toEntityId": { + "type": "string", + "description": "The GUID of to-entity." + } + }, + "title": "LineageRelation", + "description": "The lineage relation with GUID of the from and to entity." + }, + "ParentRelation": { + "type": "object", + "properties": { + "childEntityId": { + "type": "string", + "description": "The GUID of child entity." + }, + "relationshipId": { + "type": "string", + "description": "The GUID of relationship." + }, + "parentEntityId": { + "type": "string", + "description": "The GUID of parent entity." + } + }, + "title": "ParentRelation", + "description": "The lineage parents relation with GUID of the parent entity and to child entity." + }, + "NumberFormat": { + "type": "object", + "title": "NumberFormat", + "properties": { + "availableLocales": { + "type": "array", + "description": "The number format.", + "items": { + "type": "string" + } + }, + "currency": { + "type": "string", + "description": "The currency." + }, + "currencyInstance": { + "$ref": "#/definitions/NumberFormat" + }, + "groupingUsed": { + "type": "boolean", + "description": "Determines if grouping is used." + }, + "instance": { + "$ref": "#/definitions/NumberFormat" + }, + "integerInstance": { + "$ref": "#/definitions/NumberFormat" + }, + "maximumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of fraction digits." + }, + "maximumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The maximum of integer digits." + }, + "minimumFractionDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of fraction digits." + }, + "minimumIntegerDigits": { + "type": "integer", + "format": "int32", + "description": "The minimum of integer digits." + }, + "numberInstance": { + "$ref": "#/definitions/NumberFormat" + }, + "parseIntegerOnly": { + "type": "boolean", + "description": "Determines if only integer is parsed." + }, + "percentInstance": { + "$ref": "#/definitions/NumberFormat" + }, + "roundingMode": { + "$ref": "#/definitions/RoundingMode" + } + }, + "description": "The number format." + }, + "TermGuid": { + "type": "string", + "title": "termGuid", + "description": "The globally unique identifier for glossary term." + }, + "PList": { + "type": "object", + "properties": { + "list": { + "type": "array", + "description": "An array of objects.", + "items": { + "type": "object", + "properties": {} + } + }, + "pageSize": { + "type": "integer", + "format": "int32", + "description": "The size of the page." + }, + "sortBy": { + "type": "string", + "description": "The sorted by field." + }, + "sortType": { + "$ref": "#/definitions/SortType" + }, + "startIndex": { + "type": "integer", + "format": "int64", + "description": "The start index of the page." + }, + "totalCount": { + "type": "integer", + "format": "int64", + "description": "The total count of items." + } + }, + "title": "PList", + "description": "Paginated-list, for returning search results." + }, + "RelationshipCategory": { + "type": "string", + "title": "RelationshipCategory", + "description": "The Relationship category determines the style of relationship around containment and lifecycle.\nUML terminology is used for the values.\n

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

\nThe difference being in the lifecycles of the container and its children. In the COMPOSITION case,\nthe children cannot exist without the container. For AGGREGATION, the life cycles\nof the container and children are totally independent.", + "enum": [ + "ASSOCIATION", + "AGGREGATION", + "COMPOSITION" + ], + "x-ms-enum": { + "name": "RelationshipCategory", + "modelAsString": true + } + }, + "RoundingMode": { + "type": "string", + "title": "RoundingMode", + "description": "The enum of rounding mode.", + "enum": [ + "UP", + "DOWN", + "CEILING", + "FLOOR", + "HALF_UP", + "HALF_DOWN", + "HALF_EVEN", + "UNNECESSARY" + ], + "x-ms-enum": { + "name": "RoundingMode", + "modelAsString": true + } + }, + "SortType": { + "type": "string", + "title": "SortType", + "description": "to specify whether the result should be sorted? If yes, whether asc or desc.", + "enum": [ + "NONE", + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "SortType", + "modelAsString": true + } + }, + "Status": { + "type": "string", + "title": "Status", + "description": "Status of the entity - can be active or deleted. Deleted entities are not removed.", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "Status_AtlasRelationship": { + "type": "string", + "title": "Status", + "description": "The enum of relationship status.", + "enum": [ + "ACTIVE", + "DELETED" + ], + "x-ms-enum": { + "name": "Status_AtlasRelationship", + "modelAsString": true + } + }, + "TimeBoundary": { + "type": "object", + "properties": { + "endTime": { + "type": "string", + "description": "The end of the time boundary." + }, + "startTime": { + "type": "string", + "description": "The start of the time boundary." + }, + "timeZone": { + "type": "string", + "description": "The timezone of the time boundary." + } + }, + "title": "TimeBoundary", + "description": "Captures time-boundary details" + }, + "TimeZone": { + "type": "object", + "properties": { + "dstSavings": { + "type": "integer", + "format": "int32", + "description": "The value of the daylight saving time." + }, + "id": { + "type": "string", + "description": "The ID of the timezone." + }, + "availableIds": { + "type": "array", + "description": "An array of available IDs.", + "items": { + "type": "string" + } + }, + "default": { + "$ref": "#/definitions/TimeZone" + }, + "displayName": { + "type": "string", + "description": "The display name of the timezone." + }, + "rawOffset": { + "type": "integer", + "format": "int32", + "description": "The raw offset of the timezone." + } + }, + "title": "TimeZone", + "description": "The timezone information." + }, + "TypeCategory": { + "type": "string", + "title": "TypeCategory", + "description": "The enum of type category.", + "enum": [ + "PRIMITIVE", + "OBJECT_ID_TYPE", + "ENUM", + "STRUCT", + "CLASSIFICATION", + "ENTITY", + "ARRAY", + "MAP", + "RELATIONSHIP", + "TERM_TEMPLATE" + ], + "x-ms-enum": { + "name": "TypeCategory", + "modelAsString": true + } + }, + "SuggestResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } + } + }, + "title": "SuggestResult", + "description": "The result item of the search suggest." + }, + "SuggestResultValue": { + "type": "object", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by search score by default." + }, + "@search.text": { + "type": "string", + "description": "The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark." + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + } + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + }, + "title": "SuggestResultValue", + "description": "The value item of the search suggest." + }, + "SearchResult": { + "type": "object", + "properties": { + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of search results (not the number of documents in a single page)." + }, + "@search.count.approximate": { + "type": "boolean", + "description": "'True' if the '@search.count' is an approximate value and vise versa." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Absent if there's no more data." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetResultValue" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultValue" + } + } + }, + "title": "SearchResult", + "description": "The result of the search result." + }, + "SearchFacetResultValue": { + "type": "object", + "properties": { + "entityType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "assetType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "classification": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "term": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "contactId": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "contactType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "label": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "glossaryType": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "termStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + }, + "termTemplate": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItemValue" + } + } + }, + "title": "Context", + "description": "A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets." + }, + "SearchFacetItemValue": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "value": { + "type": "string", + "description": "The name of the facet item." + } + }, + "title": "SearchFacetItemValue", + "description": "The content of a search facet result item." + }, + "SearchFacetItem": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The count of the facet item." + }, + "facet": { + "type": "string", + "description": "The name of the facet item." + }, + "sort": { + "type": "object" + } + }, + "title": "SearchFacetItemValue", + "description": "The content of a search facet result item." + }, + "SearchOrderItem": { + "type": "object", + "description": "See examples for the usage of search order." + }, + "SearchResultValue": { + "type": "object", + "properties": { + "@search.score": { + "type": "number", + "format": "float", + "description": "The search score calculated by the search engine. The results are ordered by search score by default." + }, + "@search.highlights": { + "$ref": "#/definitions/SearchHighlights" + }, + "objectType": { + "type": "string", + "description": "The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term." + }, + "createTime": { + "type": "integer", + "format": "int64", + "description": "The create time of the record. The Unix epoch format." + }, + "updateTime": { + "type": "integer", + "format": "int64", + "description": "The last update time of the record. The Unix epoch format." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + }, + "entityType": { + "type": "string", + "description": "The type name of the asset." + }, + "description": { + "type": "string", + "description": "The description of the asset." + }, + "endorsement": { + "type": "string", + "description": "The endorsement of the asset." + }, + "owner": { + "type": "string", + "description": "The owner of the record." + }, + "classification": { + "type": "array", + "description": "The classifications of the record.", + "items": { + "type": "string" + } + }, + "label": { + "type": "array", + "description": "The labels of the asset.", + "items": { + "type": "string" + } + }, + "term": { + "type": "array", + "description": "The terms assigned to the asset.", + "items": { + "$ref": "#/definitions/TermSearchResultValue" + } + }, + "contact": { + "type": "array", + "description": "The contacts of the asset.", + "items": { + "$ref": "#/definitions/ContactSearchResultValue" + } + }, + "assetType": { + "type": "array", + "description": "The asset types of the asset.", + "items": { + "type": "string" + } + }, + "glossaryType": { + "type": "string", + "description": "The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory." + }, + "glossary": { + "type": "string", + "description": "The glossary name of the term." + }, + "termStatus": { + "type": "string", + "description": "The status of the term." + }, + "termTemplate": { + "type": "array", + "description": "The term template names used by the term.", + "items": { + "type": "string" + } + }, + "longDescription": { + "type": "string", + "description": "The definition of the term." + } + }, + "title": "SearchResultValue", + "description": "The value item of the search result." + }, + "SearchHighlights": { + "type": "object", + "description": "A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.", + "properties": { + "id": { + "type": "array", + "items": { + "type": "string" + } + }, + "qualifiedName": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "array", + "items": { + "type": "string" + } + }, + "entityType": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "title": "SearchHighlights" + }, + "TermSearchResultValue": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the term." + }, + "glossaryName": { + "type": "string", + "description": "The name of the glossary which contains the term." + }, + "guid": { + "type": "string", + "description": "The GUID of the term." + } + }, + "title": "Context", + "description": "The context." + }, + "ContactSearchResultValue": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the contact." + }, + "info": { + "type": "string", + "description": "The description of the contact." + }, + "contactType": { + "type": "string", + "description": "The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term." + } + }, + "title": "contact", + "description": "The contact in the search and suggest result." + }, + "AutoCompleteRequest": { + "type": "object", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100." + }, + "filter": { + "type": "object", + "description": "The filter for the autocomplete request." + } + }, + "title": "AutoCompleteRequest", + "description": "The query of autocomplete request." + }, + "AutoCompleteResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoCompleteResultValue" + } + } + }, + "title": "AutoCompleteResult", + "description": "The result of the autocomplete request." + }, + "AutoCompleteResultValue": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The completed term or phrase." + }, + "queryPlusText": { + "type": "string", + "description": "The completed search query text." + } + }, + "title": "AutoCompleteResultValue", + "description": "The value item of the autocomplete suggest." + }, + "SearchRequest": { + "type": "object", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all searchable fields." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit of the number of the search result. default value is 50; maximum value is 1000." + }, + "continuationToken": { + "type": "string", + "description": "The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data." + }, + "orderby": { + "type": "array", + "description": "The sort order of search results, can specify multiple fields.", + "items": { + "$ref": "#/definitions/SearchOrderItem" + } + }, + "filter": { + "type": "object", + "description": "The filter for the search. See examples for the usage of supported filters." + }, + "facets": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchFacetItem" + } + }, + "taxonomySetting": { + "type": "object", + "properties": { + "assetTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "facet": { + "$ref": "#/definitions/SearchFacetItem" + } + } + } + }, + "title": "SearchRequest", + "description": "The search query of advanced search request." + }, + "SuggestRequest": { + "type": "object", + "properties": { + "keywords": { + "type": "string", + "description": "The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100." + }, + "filter": { + "type": "object", + "description": "The filter for the search." + } + }, + "title": "SuggestRequest", + "description": "The query of suggest request." + }, + "LastModifiedTS": { + "type": "string", + "title": "lastModifiedTS", + "description": "ETag for concurrency control." + }, + "ErrorResponse": { + "description": "An error response from the service", + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "The request ID." + }, + "errorCode": { + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "type": "string", + "description": "The error message." + } + } + }, + "RelatedCategoryHeaders": { + "type": "object", + "description": "An array of related categories.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedCategoryHeader" + } + } + }, + "RelatedTermHeaders": { + "type": "object", + "description": "An array of related glossary terms for the given glossary or an empty list.", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/AtlasRelatedTermHeader" + } + } + }, + "BusinessMetadata": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "BusinessMetadata" + }, + "BusinessMetadataAttributes": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "BusinessMetadataAttributes" + } + }, + "parameters": { + "endpoint": { + "name": "endpoint", + "description": "The datamap endpoint of your Purview account. Example: https://{accountName}.purview.azure.com", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "format": "url", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "guid": { + "name": "guid", + "description": "The globally unique identifier of the entity.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "classificationName": { + "name": "classificationName", + "description": "The name of the classification.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "typeName": { + "name": "typeName", + "description": "The name of the type.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "categoryGuid": { + "name": "categoryGuid", + "description": "The globally unique identifier of the category.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "limit": { + "name": "limit", + "description": "The page size - by default there is no paging.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "offset": { + "name": "offset", + "description": "The offset for pagination purpose.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "sort": { + "name": "sort", + "description": "The sort order, ASC (default) or DESC.", + "in": "query", + "required": false, + "type": "string", + "default": "ASC", + "x-ms-parameter-location": "method" + }, + "termGuid": { + "name": "termGuid", + "in": "path", + "description": "The globally unique identifier for glossary term.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "fileId": { + "name": "fileId", + "in": "path", + "description": "The globally unique identifier for file.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "glossaryGuid": { + "name": "glossaryGuid", + "in": "path", + "description": "The globally unique identifier for glossary.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "operationGuid": { + "name": "operationGuid", + "in": "path", + "description": "The globally unique identifier for async operation job.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "glossaryName": { + "name": "glossaryName", + "in": "path", + "description": "The name of the glossary.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "searchLimit": { + "name": "limit", + "description": "Limits the result set to only include the specified number of entries.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "searchKeyword": { + "name": "keyword", + "description": "The keyword to get auto complete.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "depth": { + "name": "depth", + "description": "The number of hops for lineage.", + "in": "query", + "required": false, + "type": "integer", + "default": 3, + "format": "int32", + "x-ms-parameter-location": "method" + }, + "direction": { + "name": "direction", + "description": "The direction of the lineage, which could be INPUT, OUTPUT or BOTH.", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "BOTH", + "INPUT", + "OUTPUT" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "extendedInfo": { + "name": "extendedInfo", + "description": "Limits whether includes extended information.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "relationshipGuid": { + "name": "guid", + "description": "The globally unique identifier of the relationship.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "classificationDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the classification.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "classificationDefName": { + "name": "name", + "description": "The name of the classification.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "entityDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the entity.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "entityDefName": { + "name": "name", + "description": "The name of the entity.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "termTemplateDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the term template.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "termTemplateDefName": { + "name": "name", + "description": "The name of the term template.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "enumDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the enum.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "enumDefName": { + "name": "name", + "description": "The name of the enum.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "relationshipDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the relationship.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "relationshipDefName": { + "name": "name", + "description": "The name of the relationship.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "structDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the struct.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "structDefName": { + "name": "name", + "description": "The name of the struct.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "typeDefGuid": { + "name": "guid", + "description": "The globally unique identifier of the type.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "typeDefName": { + "name": "name", + "description": "The name of the type.", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 4096, + "x-ms-parameter-location": "method" + }, + "userId": { + "name": "userId", + "description": "The user ID.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "principalId": { + "name": "principalId", + "description": "The principal ID.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "minExtInfo": { + "name": "minExtInfo", + "description": "Whether to return minimal information for referred entities.", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "ignoreRelationships": { + "name": "ignoreRelationships", + "description": "Whether to ignore relationship attributes.", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "includeTermTemplate": { + "name": "includeTermTemplate", + "description": "Whether include termtemplatedef when return all typedefs.\nThis is always true when search filter type=term_template", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "includeTermHierarchy": { + "name": "includeTermHierarchy", + "description": "Whether include term hierarchy", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "extInfo": { + "name": "extInfo", + "description": "Whether include extended information like contact display name and attribute values", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "ignoreTermsAndCategories": { + "name": "ignoreTermsAndCategories", + "description": "Whether ignore terms and categories", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "purviewAPIVersion": { + "name": "api-version", + "description": "The version of the API.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "atlasAPIVersion": { + "name": "api-version", + "description": "The version of the API.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "type": { + "name": "type", + "description": "Typedef name as search filter when get typedefs.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "enum", + "entity", + "classification", + "relationship", + "struct", + "term_template" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "requiredCollectionId": { + "name": "collectionId", + "description": "The collection where entities will be moved to.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "collectionId": { + "name": "collectionId", + "description": "The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "forceDeleteEntityAssignment": { + "name": "forceDeleteEntityAssignment", + "description": "Whether delete entity assignment", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "forceDeleteChild": { + "name": "forceDeleteChild", + "description": "Whether delete child terms together with the parent term", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "businessAttributeUpdateBehavior": { + "name": "businessAttributeUpdateBehavior", + "description": "Used to define the update behavior for business attributes when updating entities.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ignore", + "replace", + "merge" + ], + "x-ms-enum": { + "name": "businessAttributeUpdateBehavior", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DevopsPolicies/preview/2022-11-01-preview/purviewDevopsPolicy.json b/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DevopsPolicies/preview/2022-11-01-preview/purviewDevopsPolicy.json deleted file mode 100644 index 11d27fb6c..000000000 --- a/swagger-specs/purview/data-plane/Azure.Analytics.Purview.DevopsPolicies/preview/2022-11-01-preview/purviewDevopsPolicy.json +++ /dev/null @@ -1,636 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Purview devops policies REST API Document", - "version": "2022-11-01-preview" - }, - "paths": { - "/devops-policies": { - "get": { - "tags": [ - "DevopsPolicy" - ], - "description": "List all devops policies.", - "operationId": "DevopsPolicy_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DevopsPolicyList" - } - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "x-ms-examples": { - "DevopsPolicy_List": { - "$ref": "./examples/DevopsPolicy_List.json" - } - } - } - }, - "/devops-policies/{purviewResourceName}/sql-security-auditor-roles": { - "put": { - "tags": [ - "DevopsPolicy" - ], - "description": "Create/replace sql security auditor devops policy", - "operationId": "DevopsSqlSecurityAuditorPolicy_CreateOrReplace", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "purviewResourceName", - "description": "Name of resource as registered on the Azure purview portal", - "required": true, - "type": "string" - }, - { - "in": "header", - "name": "If-Match", - "description": "Http Etag value of a policy to be updated. Required only during the replace operation", - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "in": "body", - "name": "body", - "description": "Devops policy object to create or update..", - "required": true, - "schema": { - "$ref": "#/definitions/DevopsPolicy" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/DevopsPolicy" - }, - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the policy entity", - "type": "string" - } - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DevopsPolicy" - }, - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the policy entity", - "type": "string" - } - } - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-examples": { - "DevopsSqlSecurityAuditorPolicy_CreateOrReplace": { - "$ref": "./examples/DevopsSqlSecurityAuditorPolicy_CreateOrReplace.json" - } - } - }, - "delete": { - "tags": [ - "DevopsPolicy" - ], - "description": "Deletes a devops sql security auditor policy", - "operationId": "DevopsSqlSecurityAuditorPolicy_Delete", - "parameters": [ - { - "in": "path", - "name": "purviewResourceName", - "description": "Name of resource as registered on the Azure purview portal", - "required": true, - "type": "string" - }, - { - "in": "header", - "name": "If-Match", - "description": "Http Etag value of a policy to be deleted.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-examples": { - "DevopsSqlSecurityAuditorPolicy_Delete": { - "$ref": "./examples/DevopsSqlSecurityAuditorPolicy_Delete.json" - } - } - }, - "get": { - "tags": [ - "DevopsPolicy" - ], - "description": "Get devops sql security auditor policy", - "operationId": "DevopsSqlSecurityAuditorPolicy_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "purviewResourceName", - "description": "Name of resource as registered on the Azure purview portal", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DevopsPolicy" - }, - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the policy entity", - "type": "string" - } - } - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-examples": { - "DevopsSqlSecurityAuditorPolicy_Get": { - "$ref": "./examples/DevopsSqlSecurityAuditorPolicy_Get.json" - } - } - } - }, - "/devops-policies/{purviewResourceName}/sql-perf-monitor-roles": { - "delete": { - "tags": [ - "DevopsPolicy" - ], - "description": "Deletes a devops sql perf monitor policy", - "operationId": "DevopsSqlPerfMonitorPolicy_Delete", - "parameters": [ - { - "in": "path", - "name": "purviewResourceName", - "description": "Name of resource as registered on the Azure purview portal", - "required": true, - "type": "string" - }, - { - "in": "header", - "name": "If-Match", - "description": "Http Etag value of a policy to be deleted.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-examples": { - "DevopsSqlPerfMonitorPolicy_Delete": { - "$ref": "./examples/DevopsSqlPerfMonitorPolicy_Delete.json" - } - } - }, - "put": { - "tags": [ - "DevopsPolicy" - ], - "description": "Create/replace devops sql perf monitor policy", - "operationId": "DevopsSqlPerfMonitorPolicy_CreateOrReplace", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "purviewResourceName", - "description": "Name of resource as registered on the Azure purview portal", - "required": true, - "type": "string" - }, - { - "in": "header", - "name": "If-Match", - "description": "Etag value of a policy to be updated. Required only during the replace operation", - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "in": "body", - "name": "body", - "description": "Devops policy object to create or update..", - "required": true, - "schema": { - "$ref": "#/definitions/DevopsPolicy" - } - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/DevopsPolicy" - }, - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the policy entity", - "type": "string" - } - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DevopsPolicy" - }, - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the policy entity", - "type": "string" - } - } - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-examples": { - "DevopsSqlPerfMonitorPolicy_CreateOrReplace": { - "$ref": "./examples/DevopsSqlPerfMonitorPolicy_CreateOrReplace.json" - } - } - }, - "get": { - "tags": [ - "DevopsPolicy" - ], - "description": "Get devops sql perf monitor policy", - "operationId": "DevopsSqlPerfMonitorPolicy_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "purviewResourceName", - "description": "Name of resource as registered on the Azure purview portal", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DevopsPolicy" - }, - "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the policy entity", - "type": "string" - } - } - }, - "default": { - "description": "An error response received from the Policy Service", - "schema": { - "$ref": "#/definitions/ErrorResponseModel" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "The error code" - } - } - } - }, - "x-ms-examples": { - "DevopsSqlPerfMonitorPolicy_Get": { - "$ref": "./examples/DevopsSqlPerfMonitorPolicy_Get.json" - } - } - } - } - }, - "definitions": { - "DevopsPolicyDecisionRule": { - "type": "object", - "required": [ - "effect", - "principals", - "principalGroups" - ], - "properties": { - "effect": { - "description": "The effect for rule", - "enum": [ - "Permit" - ], - "type": "string", - "x-ms-enum": { - "name": "Decision", - "modelAsString": true - } - }, - "purviewRoleName": { - "type": "string", - "description": "This is field will indicate the role of a devops policy." - }, - "principals": { - "type": "array", - "description": "Azure Active Directory Ids for users", - "items": { - "type": "string", - "description": "Azure Active Directory Id" - } - }, - "principalGroups": { - "type": "array", - "description": "Azure Active Directory Ids for groups", - "items": { - "type": "string", - "description": "Azure Active Directory Id" - } - }, - "resourceAzurePath": { - "type": "string", - "description": "Optional resource path of the azure resource" - } - } - }, - "ErrorModel": { - "description": "The error model for policy", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The error code", - "minLength": 1, - "type": "string" - }, - "message": { - "description": "The error message", - "minLength": 1, - "type": "string" - }, - "details": { - "description": "The error details", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "ErrorResponseModel": { - "description": "The error response model for policy", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "DevopsPolicy": { - "required": [ - "decisionRules", - "purviewResourceName" - ], - "type": "object", - "properties": { - "systemData": { - "$ref": "#/definitions/SystemData" - }, - "decisionRules": { - "type": "array", - "description": "Array of decisionRules for the policy", - "items": { - "$ref": "#/definitions/DevopsPolicyDecisionRule" - } - }, - "purviewResourceName": { - "type": "string", - "description": "Purview resource name" - } - } - }, - "DevopsPolicyList": { - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of policies", - "items": { - "$ref": "#/definitions/DevopsPolicy" - } - }, - "nextLink": { - "type": "string", - "description": "Pagination link" - } - } - }, - "SystemData": { - "type": "object", - "readOnly": true, - "properties": { - "createdBy": { - "type": "string", - "description": "Created by" - }, - "createdByType": { - "type": "string", - "description": "Created by type" - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "Created at" - }, - "lastModifiedBy": { - "type": "string", - "description": "last modified by" - }, - "lastModifiedByType": { - "type": "string", - "description": "last modified by type" - }, - "lastModifiedAt": { - "format": "date-time", - "type": "string", - "description": "last modified at" - } - } - } - }, - "parameters": { - "api-version": { - "in": "query", - "name": "api-version", - "description": "The api version to use.", - "required": true, - "type": "string", - "x-ms-client-name": "ApiVersion", - "x-ms-parameter-location": "method" - }, - "endpoint": { - "in": "path", - "name": "endpoint", - "description": "The endpoint of your Purview account. Example: https://{accountName}.purview.azure.com.", - "required": true, - "type": "string", - "format": "url", - "x-ms-parameter-location": "client", - "x-ms-skip-url-encoding": true - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/endpoint" - } - ] - }, - "basePath": "/policyStore", - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} diff --git a/swagger-specs/purview/data-plane/api-set.json b/swagger-specs/purview/data-plane/api-set.json index 9d29bf4b3..7ddb6e02c 100644 --- a/swagger-specs/purview/data-plane/api-set.json +++ b/swagger-specs/purview/data-plane/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Azure.Analytics.Purview.DevopsPolicies/preview/2022-11-01-preview/purviewDevopsPolicy.json"], "name": "package-2022-11-01-preview"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json"], "name": "package-2023-09"} \ No newline at end of file diff --git a/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json b/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json new file mode 100644 index 000000000..26d62df58 --- /dev/null +++ b/swagger-specs/purviewpolicy/resource-manager/Microsoft.Purview/preview/2023-06-01-preview/policy.json @@ -0,0 +1,350 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-06-01-preview", + "title": "PurviewPolicyClient", + "description": "Creates a Microsoft.Purview management client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/{scope}/providers/Microsoft.Purview/policies": { + "get": { + "tags": [ + "PolicyListing" + ], + "summary": "API to list the purview RBAC policies based on a scope", + "description": "The API lists the Azure purview RBAC policies affecting the scope. The scope can be any valid ARM resource id", + "operationId": "PurviewPolicies_List", + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/skipToken" + }, + { + "name": "$filter", + "in": "query", + "description": "Supported filters : $filter=policyType eq SelfService, $filter=policyType eq SqlDevops. Returns only the policies of the specified type. If not specified, all policies are returned.", + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListPolicies": { + "$ref": "./examples/PolicyList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/providers/Microsoft.Purview/operations": { + "get": { + "tags": [ + "Operation" + ], + "summary": "Lists the available operations", + "description": "List of available operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "PolicyList": { + "required": [ + "value" + ], + "description": "A paginated list of purview RBAC policies", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "A list of purview RBAC policies", + "items": { + "$ref": "#/definitions/Policy" + } + }, + "nextLink": { + "type": "string", + "description": "Pagination link" + } + } + }, + "AttributePredicate": { + "type": "object", + "description": "Attribute predicate for a policy permission", + "properties": { + "attributeName": { + "type": "string", + "description": "AttributeName of a policy permission" + }, + "attributeValueIncludedIn": { + "type": "array", + "description": "values for a policy permission", + "items": { + "type": "string" + } + } + } + }, + "PolicyDecisionRule": { + "type": "object", + "description": "Purview RBAC policy decision rule", + "required": [ + "effect" + ], + "properties": { + "effect": { + "description": "The effect for rule", + "enum": [ + "Permit", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "Decision", + "modelAsString": true + } + }, + "permission": { + "type": "array", + "description": "Array of attribute predicates", + "items": { + "$ref": "#/definitions/AttributePredicate" + }, + "x-ms-identifiers": [] + } + } + }, + "Policy": { + "required": [ + "id", + "source", + "decisionRules", + "members", + "etag", + "scopes" + ], + "type": "object", + "description": "Purview RBAC policy", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "The policy kind" + }, + "source": { + "type": "string", + "description": "The policy source" + }, + "etag": { + "type": "string", + "description": "The etag version of a policy" + }, + "scopes": { + "type": "array", + "description": "Array of scopes where the policy is published", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "members": { + "type": "object", + "description": "Members of the policy", + "$ref": "#/definitions/PolicyMembers" + }, + "decisionRules": { + "type": "array", + "description": "Array of decision rules for the policy", + "items": { + "$ref": "#/definitions/PolicyDecisionRule" + }, + "x-ms-identifiers": [] + }, + "expiryTime": { + "format": "date-time", + "description": "The timestamp of the expiry time of the policy (UTC).", + "type": "string" + }, + "requestor": { + "type": "string", + "description": "The AAD member who requested the policy" + } + } + }, + "PolicyMembers": { + "type": "object", + "description": "Policy member", + "properties": { + "fabricItemMembers": { + "type": "array", + "description": "Array of azure active directory members", + "items": { + "$ref": "#/definitions/FabricItemMember" + }, + "x-ms-identifiers": [] + }, + "aadMembers": { + "type": "array", + "description": "Array of azure active directory members", + "items": { + "$ref": "#/definitions/AADMember" + }, + "x-ms-identifiers": [] + } + } + }, + "AADMember": { + "type": "object", + "description": "Azure active directory member", + "properties": { + "tenantId": { + "type": "string", + "description": "The tenantId of the member" + }, + "objectId": { + "type": "string", + "description": "The objectId of the member" + }, + "objectType": { + "type": "string", + "description": "The objectType of the member.", + "enum": [ + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "objectType", + "modelAsString": true + } + } + } + }, + "FabricItemMember": { + "type": "object", + "description": "Microsoft fabric item member", + "properties": { + "sourcePath": { + "type": "string", + "description": "Source path of the member" + }, + "itemAccess": { + "type": "array", + "description": "Array of access items for the member", + "items": { + "type": "string", + "description": "access item" + } + } + } + } + }, + "parameters": { + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The api version to use.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "skipToken": { + "name": "skipToken", + "in": "query", + "description": "Paging key to paginate to next page.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/swagger-specs/purviewpolicy/resource-manager/api-set.json b/swagger-specs/purviewpolicy/resource-manager/api-set.json new file mode 100644 index 000000000..3e0266f22 --- /dev/null +++ b/swagger-specs/purviewpolicy/resource-manager/api-set.json @@ -0,0 +1 @@ +{"addition_input_file_paths": [], "input_files": ["Microsoft.Purview/preview/2023-06-01-preview/policy.json"], "name": "package-2023-06-01-preview"} \ No newline at end of file diff --git a/swagger-specs/search/resource-manager/Microsoft.Search/stable/2022-09-01/search.json b/swagger-specs/search/resource-manager/Microsoft.Search/stable/2023-11-01/search.json similarity index 92% rename from swagger-specs/search/resource-manager/Microsoft.Search/stable/2022-09-01/search.json rename to swagger-specs/search/resource-manager/Microsoft.Search/stable/2023-11-01/search.json index 96c4eebdc..aebddfc27 100644 --- a/swagger-specs/search/resource-manager/Microsoft.Search/stable/2022-09-01/search.json +++ b/swagger-specs/search/resource-manager/Microsoft.Search/stable/2023-11-01/search.json @@ -3,7 +3,7 @@ "info": { "title": "SearchManagementClient", "description": "Client that can be used to manage Azure Cognitive Search services and API keys.", - "version": "2022-09-01" + "version": "2023-11-01" }, "host": "management.azure.com", "schemes": [ @@ -384,6 +384,9 @@ }, "SearchCreateOrUpdateServiceWithCmkEnforcement": { "$ref": "./examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json" + }, + "SearchCreateOrUpdateWithSemanticSearch": { + "$ref": "./examples/SearchCreateOrUpdateWithSemanticSearch.json" } }, "description": "Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.", @@ -468,6 +471,9 @@ }, "SearchUpdateServiceWithCmkEnforcement": { "$ref": "./examples/SearchUpdateServiceWithCmkEnforcement.json" + }, + "SearchUpdateServiceWithSemanticSearch": { + "$ref": "./examples/SearchUpdateServiceWithSemanticSearch.json" } }, "description": "Updates an existing search service in the given resource group.", @@ -1245,6 +1251,102 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Usages_ListBySubscription", + "x-ms-examples": { + "GetQuotaUsagesList": { + "$ref": "./examples/GetQuotaUsagesList.json" + } + }, + "description": "Gets a list of all Search quota usages in the given subscription.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the list of all Search quota usages for the given subscription.", + "schema": { + "$ref": "#/definitions/QuotaUsagesListResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "UsageBySubscriptionSku", + "x-ms-examples": { + "GetQuotaUsage": { + "$ref": "./examples/GetQuotaUsage.json" + } + }, + "description": "Gets the quota usage for a search sku in the given subscription.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkuNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the quota usage of a search service sku for the given subscription.", + "schema": { + "$ref": "#/definitions/QuotaUsageResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { @@ -1710,6 +1812,36 @@ "description": "Response containing a list of Private Endpoint connections.", "x-ms-external": true }, + "SemanticSearch": { + "type": "string", + "enum": [ + "disabled", + "free", + "standard" + ], + "x-ms-enum": { + "name": "SearchSemanticSearch", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "disabled", + "description": "Indicates that semantic search is disabled for the search service." + }, + { + "value": "free", + "name": "free", + "description": "Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge. This is the default for newly provisioned search services." + }, + { + "value": "standard", + "name": "standard", + "description": "Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries." + } + ] + }, + "description": "Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations." + }, "SharedPrivateLinkResource": { "properties": { "properties": { @@ -2130,6 +2262,11 @@ }, "description": "The list of private endpoint connections to the Azure Cognitive Search service." }, + "semanticSearch": { + "$ref": "#/definitions/SemanticSearch", + "x-nullable": true, + "description": "Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations." + }, "sharedPrivateLinkResources": { "readOnly": true, "type": "array", @@ -2300,6 +2437,65 @@ "type" ], "description": "Identity for the resource." + }, + "QuotaUsagesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/QuotaUsageResult" + }, + "description": "The quota usages for the SKUs supported by Azure Cognitive Search." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size." + } + }, + "description": "Response containing the quota usage information for all the supported skus of Azure Cognitive Search service.", + "x-ms-external": true + }, + "QuotaUsageResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The resource id of the quota usage sku endpoint for Microsoft.Search provider." + }, + "unit": { + "type": "string", + "description": "The unit of measurement for the search sku." + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The currently used up value for the particular search sku." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The quota limit for the particular search sku." + }, + "name": { + "readOnly": true, + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The sku name supported by Azure Cognitive Search." + }, + "localizedValue": { + "type": "string", + "description": "The localized string value for the sku supported by Azure Cognitive Search." + } + }, + "description": "The name of the sku supported by Azure Cognitive Search." + } + }, + "description": "Describes the quota usage for a particular sku supported by Azure Cognitive Search." } }, "parameters": { @@ -2370,6 +2566,22 @@ "required": true, "type": "string", "description": "The API version to use for each request." + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The unique location name for a Microsoft Azure geographic region.", + "x-ms-parameter-location": "method" + }, + "SkuNameParameter": { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique search service sku name supported by Azure Cognitive Search.", + "x-ms-parameter-location": "method" } } } diff --git a/swagger-specs/search/resource-manager/api-set.json b/swagger-specs/search/resource-manager/api-set.json index 3b0f57cd1..bf9e91597 100644 --- a/swagger-specs/search/resource-manager/api-set.json +++ b/swagger-specs/search/resource-manager/api-set.json @@ -1 +1 @@ -{"addition_input_file_paths": [], "input_files": ["Microsoft.Search/stable/2022-09-01/search.json"], "name": "package-2022-09"} \ No newline at end of file +{"addition_input_file_paths": [], "input_files": ["Microsoft.Search/stable/2023-11-01/search.json"], "name": "package-2023-11"} \ No newline at end of file