Skip to content

Update examples and description for Catalog #16761

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 7 commits into from
Nov 30, 2021
Merged

Update examples and description for Catalog #16761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a861859
IoT Central Public API 1.1-preview Oct Release (#16514)
yang-hai-feng Oct 27, 2021
3c6cc3f
update examples and description
yifan-zhou922 Nov 15, 2021
90651b4
Merge remote-tracking branch 'origin/main' into yifanzhou/update
yifan-zhou922 Nov 16, 2021
86a714b
Update purviewcatalog.json
yifan-zhou922 Nov 16, 2021
a54c2fc
update examples for query
yifan-zhou922 Nov 24, 2021
3ce9e45
update example & parameter name
yifan-zhou922 Nov 24, 2021
098f413
Update purviewcatalog.json
yifan-zhou922 Nov 30, 2021
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
16 changes: 1 addition & 15 deletions .../Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
}
]
},
"limit": 2,
"limit": 10,
"offset": 0,
"facets": [
{
Expand Down Expand Up @@ -77,20 +77,6 @@
"sort": {
"count": "desc"
}
},
{
"facet": "classificationCategory",
"count": 0,
"sort": {
"count": "desc"
}
},
{
"facet": "fileExtension",
"count": 0,
"sort": {
"count": "desc"
}
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion ...re.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"and": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...tics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"and": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...lytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"or": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...lytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"attributeName": "name",
"operator": "eq",
Expand Down
2 changes: 1 addition & 1 deletion ...s.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"classification": "MICROSOFT.PERSONAL.EMAIL",
"includeSubClassifications": true
Expand Down
65 changes: 65 additions & 0 deletions ...ytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"parameters": {
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 10,
"filter": {
"collectionId": "collectionName"
}
},
"api-version": "2021-05-01-preview"
},
"responses": {
"200": {
"body": {
"@search.count": 5,
"value": [
{
"@search.score": 1.0,
"id": "b9638b91-884f-4e5e-98b5-29f6f6f60000",
"qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1",
"name": "exampledata1",
"description": null,
"owner": null,
"entityType": "azure_sql_table",
"classification": [
"MICROSOFT.PERSONAL.NAME",
"MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
"MICROSOFT.PERSONAL.US.PHONE_NUMBER",
"MICROSOFT.PERSONAL.EMAIL"
],
"label": [],
"assetType": [
"Azure SQL Database"
],
"term": [],
"contact": []
},
{
"@search.score": 1.0,
"id": "01aefb9a-61cd-4a02-a572-70f6f6f60000",
"qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2",
"name": "exampledata2",
"description": null,
"owner": null,
"entityType": "azure_sql_dw_table",
"classification": [
"MICROSOFT.GOVERNMENT.CITY_NAME",
"MICROSOFT.GOVERNMENT.US.STATE",
"MICROSOFT.PERSONAL.NAME",
"MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
"MICROSOFT.PERSONAL.EMAIL"
],
"label": [],
"assetType": [
"Azure SQL Data Warehouse"
],
"term": [],
"contact": []
}
]
}
}
}
}
14 changes: 2 additions & 12 deletions ....Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@
}
]
},
"limit": 2,
"limit": 10,
"offset": 0,
"facets": [
{
"facet": "assetType",
"count": 0
"count": 10
},
{
"facet": "classification",
Expand All @@ -28,17 +28,9 @@
"facet": "term",
"count": 10
},
{
"facet": "fileExtension",
"count": 10
},
{
"facet": "label",
"count": 10
},
{
"facet": "classificationCategory",
"count": 10
}
]
},
Expand Down Expand Up @@ -75,7 +67,6 @@
"value": "MICROSOFT.GOVERNMENT.US.STATE"
}
],
"fileExtension": [],
"assetType": [
{
"count": 1476,
Expand Down Expand Up @@ -116,7 +107,6 @@
"value": "Example.Label"
}
],
"classificationCategory": [],
"term": [
{
"count": 1,
Expand Down
2 changes: 1 addition & 1 deletion ...cs.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"and": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...ure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"and": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...re.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"not": {
"classification": "MICROSOFT.SYSTEM.TEMP_FILE"
Expand Down
2 changes: 1 addition & 1 deletion ...alytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
}
]
},
"limit": 2,
"limit": 10,
"offset": 0,
"facets": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...e.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"Endpoint": "{Endpoint}",
"searchRequest": {
"keywords": null,
"limit": 2,
"limit": 10,
"filter": {
"and": [
{
Expand Down
2 changes: 1 addition & 1 deletion ...ure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"parameters": {
"Endpoint": "{Endpoint}",
"guids": [
"guid": [
"784c0f2f-afd2-e26b-f9cb-984f6c2c5021",
"b4ebc8be-cef4-860a-bee9-28cc34cb5caa"
]
Expand Down
13 changes: 8 additions & 5 deletions ...data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
},
"parameters": [
{
"name": "guids",
"name": "guid",
"in": "query",
"description": "An array of GUIDs of entities to create.",
"required": true,
Expand Down Expand Up @@ -2476,6 +2476,9 @@
},
"Discovery_Query_Taxonomy": {
"$ref": "./examples/Discovery_Query_Taxonomy.json"
},
"Discovery_Query_Collection": {
"$ref": "./examples/Discovery_Query_Collection.json"
}
},
"parameters": [
Expand Down Expand Up @@ -5947,7 +5950,7 @@
}
},
"title": "Context",
"description": "A facet list that consists of index fields assetType ,classification, classificationCategory, contactId, fileExtension, label, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets."
"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",
Expand Down Expand Up @@ -6195,7 +6198,7 @@
"offset": {
"type": "integer",
"format": "int32",
"description": "The offset. The default value is 0."
"description": "The offset. The default value is 0. The maximum value is 100000."
},
"limit": {
"type": "integer",
Expand Down Expand Up @@ -6244,12 +6247,12 @@
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of browse items we hope to return."
"description": "The number of browse items we hope to return. The maximum value is 10000."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "The offset. The default value is 0."
"description": "The offset. The default value is 0. The maximum value is 100000."
}
},
"title": "BrowseRequest",
Expand Down