Skip to content

Add collection APIs to new version (2021-09-01) #16010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmazuel merged 1 commit into from
Sep 13, 2021
Merged

Add collection APIs to new version (2021-09-01) #16010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions ...alytics.Purview.Catalog/preview/2021-09-01/examples/CatalogCollection_createOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"parameters": {
"Endpoint": "{Endpoint}",
"collection": "ExampleCollection",
"api-version": "2021-09-01",
"entity": {
"referredEntities": {},
"entity": {
"typeName": "azure_storage_account",
"attributes": {
"name": "exampleaccount",
"qualifiedName": "https://exampleaccount.core.windows.net"
}
}
}
},
"responses": {
"200": {
"body": {
"mutatedEntities": {
"CREATE": [
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "https://exampleaccount.core.windows.net"
},
"lastModifiedTS": "1",
"guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6",
"status": "ACTIVE"
}
]
},
"guidAssignments": {
"-9514774903018162": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6"
}
}
}
}
}
61 changes: 61 additions & 0 deletions ...ics.Purview.Catalog/preview/2021-09-01/examples/CatalogCollection_createOrUpdateBulk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"parameters": {
"Endpoint": "{Endpoint}",
"collection": "ExampleCollection",
"api-version": "2021-09-01",
"entities": {
"referredEntities": {},
"entities": [
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "exampleaccount",
"name": "exampleaccount",
"description": "Example Description"
}
},
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "exampleaccount2",
"name": "exampleaccount2"
}
}
]
}
},
"responses": {
"200": {
"body": {
"mutatedEntities": {
"UPDATE": [
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "exampleaccount"
},
"lastModifiedTS": "2",
"guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
"status": "ACTIVE"
}
],
"CREATE": [
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "exampleaccount2"
},
"lastModifiedTS": "1",
"guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
"status": "ACTIVE"
}
]
},
"guidAssignments": {
"-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
"-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
}
}
}
}
}
45 changes: 45 additions & 0 deletions ...rview.Catalog/preview/2021-09-01/examples/CatalogCollection_moveEntitiesToCollection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"parameters": {
"Endpoint": "{Endpoint}",
"collection": "ExampleNewCollection",
"api-version": "2021-09-01",
"moveEntitiesRequest": {
"entityGuids": [
"321493e3-3fb7-4b3e-9df7-3b69154174c2",
"b2f9c306-cf65-4bb0-878e-cfaafde156b1"
]
}
},
"responses": {
"200": {
"body": {
"mutatedEntities": {
"UPDATE": [
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "exampleaccount"
},
"lastModifiedTS": "3",
"guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
"status": "ACTIVE"
},
{
"typeName": "azure_storage_account",
"attributes": {
"qualifiedName": "exampleaccount2"
},
"lastModifiedTS": "2",
"guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
"status": "ACTIVE"
}
]
},
"guidAssignments": {
"-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
"-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
}
}
}
}
}
155 changes: 155 additions & 0 deletions ...purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3558,6 +3558,141 @@
}
}
}
},
"/collections/{collection}/entity": {
"post": {
"tags": [
"CatalogCollection"
],
"description": "Creates or updates an entity to a collection.\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<int>>, array<map<string, int>>.",
"operationId": "CatalogCollection_createOrUpdate",
"x-ms-examples": {
"CatalogCollection_createOrUpdate": {
"$ref": "./examples/CatalogCollection_createOrUpdate.json"
}
},
"parameters": [
{
"$ref": "#/parameters/collection"
},
{
"$ref": "#/parameters/purviewAPIVersion"
},
{
"in": "body",
"name": "entity",
"description": "Atlas entity with extended information.",
"required": true,
"schema": {
"$ref": "#/definitions/AtlasEntityWithExtInfo"
}
}
],
"responses": {
"200": {
"description": "Created with EntityMutationResponse.",
"schema": {
"$ref": "#/definitions/EntityMutationResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/collections/{collection}/entity/bulk": {
"post": {
"tags": [
"CatalogCollection"
],
"description": "Creates or updates entities in bulk to a collection.\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<int>>, array<map<string, int>>.",
"operationId": "CatalogCollection_createOrUpdateBulk",
"x-ms-examples": {
"CatalogCollection_createOrUpdateBulk": {
"$ref": "./examples/CatalogCollection_createOrUpdateBulk.json"
}
},
"parameters": [
{
"$ref": "#/parameters/collection"
},
{
"$ref": "#/parameters/purviewAPIVersion"
},
{
"in": "body",
"name": "entities",
"description": "Atlas entities with extended information.",
"required": true,
"schema": {
"$ref": "#/definitions/AtlasEntitiesWithExtInfo"
}
}
],
"responses": {
"200": {
"description": "Created with EntityMutationResponse.",
"schema": {
"$ref": "#/definitions/EntityMutationResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/collections/{collection}/entity/moveHere": {
"post": {
"tags": [
"CatalogCollection"
],
"description": "Move existing entities to the target collection.",
"operationId": "CatalogCollection_moveEntitiesToCollection",
"x-ms-examples": {
"CatalogCollection_moveEntitiesToCollection": {
"$ref": "./examples/CatalogCollection_moveEntitiesToCollection.json"
}
},
"parameters": [
{
"$ref": "#/parameters/collection"
},
{
"$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"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -5189,6 +5324,18 @@
"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",
Expand Down Expand Up @@ -6675,6 +6822,14 @@
"modelAsString": true
},
"x-ms-parameter-location": "method"
},
"collection": {
"name": "collection",
"description": "the collection unique name",
"in": "path",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
}
}