-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
Add Browse API to Purview.Catalog #14602
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
35 changes: 35 additions & 0 deletions
35
...tics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_EntityType.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
{ | ||
"parameters": { | ||
"Endpoint": "{Endpoint}", | ||
"browseRequest": { | ||
"entityType": "azure_data_explorer_cluster", | ||
"limit": 10 | ||
}, | ||
"api-version": "2021-05-01-preview" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"@search.count": 1, | ||
"value": [ | ||
{ | ||
"id": "7afe6da2-4275-4096-90af-e40479cf70e2", | ||
"name": "examplecluster.westus", | ||
"qualifiedName": "https://examplecluster.westus.kusto.windows.net", | ||
"entityType": "azure_data_explorer_cluster", | ||
"path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net", | ||
"owner": [ | ||
{ | ||
"id": "12345678-1234-5678-1234-86b7251e0353", | ||
"displayName": "Example DisplayName", | ||
"mail": "example.displayname@microsoft.com", | ||
"contactType": "Owner" | ||
} | ||
], | ||
"isLeaf": false | ||
} | ||
] | ||
} | ||
} | ||
} | ||
} |
67 changes: 67 additions & 0 deletions
67
....Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_Path.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
{ | ||
"parameters": { | ||
"Endpoint": "{Endpoint}", | ||
"browseRequest": { | ||
"path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net", | ||
"limit": 10 | ||
}, | ||
"api-version": "2021-05-01-preview" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"@search.count": 3, | ||
"value": [ | ||
{ | ||
"id": "55656c92-7e29-4831-a243-f95bdcdd397b", | ||
"name": "exampledata", | ||
"qualifiedName": "https://examplecluster.westus.kusto.windows.net/exampledata", | ||
"entityType": "azure_data_explorer_database", | ||
"path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net/azure_data_explorer_database#exampledata", | ||
"owner": [ | ||
{ | ||
"id": "12345678-1234-5678-1234-86b7251e0353", | ||
"displayName": "Example DisplayName", | ||
"mail": "example.displayname@microsoft.com", | ||
"contactType": "Owner" | ||
} | ||
], | ||
"isLeaf": false | ||
}, | ||
{ | ||
"id": "940aa60f-36f6-4dcf-8989-2faa49c74462", | ||
"name": "exampledata2", | ||
"qualifiedName": "https://examplecluster.westus.kusto.windows.net/exampledata2", | ||
"entityType": "azure_data_explorer_database", | ||
"path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net/azure_data_explorer_database#exampledata2", | ||
"owner": [ | ||
{ | ||
"id": "12345678-1234-5678-1234-86b7251e0353", | ||
"displayName": "Example DisplayName", | ||
"mail": "example.displayname@microsoft.com", | ||
"contactType": "Owner" | ||
} | ||
], | ||
"isLeaf": false | ||
}, | ||
{ | ||
"id": "19c4a337-840b-442d-ac9c-3df65bb33d69", | ||
"name": "exampledata3", | ||
"qualifiedName": "https://examplecluster.westus.kusto.windows.net/exampledata3", | ||
"entityType": "azure_data_explorer_database", | ||
"path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net/azure_data_explorer_database#exampledata3", | ||
"owner": [ | ||
{ | ||
"id": "12345678-1234-5678-1234-86b7251e0353", | ||
"displayName": "Example DisplayName", | ||
"mail": "example.displayname@microsoft.com", | ||
"contactType": "Owner" | ||
} | ||
], | ||
"isLeaf": false | ||
} | ||
] | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2193,6 +2193,45 @@ | |
} | ||
} | ||
}, | ||
"/browse": { | ||
"post": { | ||
"tags": [ | ||
"Discovery" | ||
], | ||
"description": "Browse entities by path or entity type.", | ||
"operationId": "Discovery_Browse", | ||
"x-ms-examples": { | ||
"Discovery_Browse_Path": { | ||
"$ref": "./examples/Discovery_Browse_Path.json" | ||
}, | ||
"Discovery_Browse_EntityType": { | ||
"$ref": "./examples/Discovery_Browse_EntityType.json" | ||
} | ||
}, | ||
"parameters": [ | ||
{ | ||
"in": "body", | ||
"name": "browseRequest", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Needs review by archboard There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The API has been reviewed by SDK team. |
||
"description": "An object specifying the browse criteria.", | ||
"required": true, | ||
"schema": { | ||
"$ref": "#/definitions/BrowseRequest" | ||
} | ||
}, | ||
{ | ||
"$ref": "#/parameters/purviewAPIVersion" | ||
} | ||
], | ||
"responses": { | ||
"200": { | ||
"description": "OK. On successful get the entities to browse.", | ||
"schema": { | ||
"$ref": "#/definitions/BrowseResult" | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"/search/autocomplete": { | ||
"post": { | ||
"tags": [ | ||
|
@@ -5367,6 +5406,24 @@ | |
"title": "SuggestResult", | ||
"description": "The result item of the search suggest." | ||
}, | ||
"BrowseResult": { | ||
"type": "object", | ||
"properties": { | ||
"@search.count": { | ||
"type": "integer", | ||
"format": "int32", | ||
"description": "The total number of browse results." | ||
}, | ||
"value": { | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/definitions/BrowseResultValue" | ||
} | ||
} | ||
}, | ||
"title": "BrowseResult", | ||
"description": "The result item of the browse request." | ||
}, | ||
"SuggestResultValue": { | ||
"type": "object", | ||
"properties": { | ||
|
@@ -5442,6 +5499,67 @@ | |
"title": "SuggestResultValue", | ||
"description": "The value item of the search suggest." | ||
}, | ||
"BrowseResultValue": { | ||
"type": "object", | ||
"properties": { | ||
"entityType": { | ||
"type": "string", | ||
"description": "The type name of the record." | ||
}, | ||
"id": { | ||
"type": "string", | ||
"description": "The GUID of the record." | ||
}, | ||
"isLeaf": { | ||
"type": "boolean", | ||
"description": "If the record is a leaf entity." | ||
}, | ||
"name": { | ||
"type": "string", | ||
"description": "The name of the record." | ||
}, | ||
"owner": { | ||
"type": "array", | ||
"description": "The owners of the record.", | ||
"items": { | ||
"$ref": "#/definitions/BrowseResultOwner" | ||
} | ||
}, | ||
"path": { | ||
"type": "string", | ||
"description": "The path of the record." | ||
}, | ||
"qualifiedName": { | ||
"type": "string", | ||
"description": "The qualified name of the record." | ||
} | ||
}, | ||
"title": "BrowseResultValue", | ||
"description": "The value item of the browse result." | ||
}, | ||
"BrowseResultOwner": { | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"type": "string", | ||
"description": "The GUID of the owner." | ||
}, | ||
"displayName": { | ||
"type": "string", | ||
"description": "The display name of the owner." | ||
}, | ||
"mail": { | ||
"type": "string", | ||
"description": "The mail of the owner." | ||
}, | ||
"contactType": { | ||
"type": "string", | ||
"description": "The contact type of the owner. The value will be Owner." | ||
} | ||
}, | ||
"title": "BrowseResultOwner", | ||
"description": "The value item of the browse owner." | ||
}, | ||
"SearchResult": { | ||
"type": "object", | ||
"properties": { | ||
|
@@ -5830,6 +5948,31 @@ | |
"title": "SearchRequest", | ||
"description": "The search query of advanced search request." | ||
}, | ||
"BrowseRequest": { | ||
"type": "object", | ||
"properties": { | ||
"entityType": { | ||
"type": "string", | ||
"description": "The entity type to browse as the root level entry point." | ||
}, | ||
"path": { | ||
"type": "string", | ||
"description": "The path to browse the next level child entities." | ||
}, | ||
"limit": { | ||
"type": "integer", | ||
"format": "int32", | ||
"description": "The number of browse items we hope to return." | ||
}, | ||
"offset": { | ||
"type": "integer", | ||
"format": "int32", | ||
"description": "The offset. The default value is 0." | ||
} | ||
}, | ||
"title": "BrowseRequest", | ||
"description": "The criteria of browse request." | ||
}, | ||
"SuggestRequest": { | ||
"type": "object", | ||
"properties": { | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs review by archboard
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The API has been reviewed by SDK team.