Update examples and description for Catalog (#16761)

yifan-zhou922 · yang-hai-feng · web-flow · commit 635059f740b4 · 2021-11-30T10:06:23.000-08:00
* IoT Central Public API 1.1-preview Oct Release (#16514) * Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo * update examples and description * Update purviewcatalog.json * update examples for query * update example & parameter name * Update purviewcatalog.json Co-authored-by: Johnson Yang <hayang@microsoft.com>
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json
@@ -40,7 +40,7 @@
           }
         ]
       },
-      "limit": 2,
+      "limit": 10,
       "offset": 0,
       "facets": [
         {
@@ -77,20 +77,6 @@
           "sort": {
             "count": "desc"
           }
-        },
-        {
-          "facet": "classificationCategory",
-          "count": 0,
-          "sort": {
-            "count": "desc"
-          }
-        },
-        {
-          "facet": "fileExtension",
-          "count": 0,
-          "sort": {
-            "count": "desc"
-          }
         }
       ]
     },
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "and": [
           {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "and": [
           {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "or": [
           {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "attributeName": "name",
         "operator": "eq",
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "classification": "MICROSOFT.PERSONAL.EMAIL",
         "includeSubClassifications": true
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Collection.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Collection.json
@@ -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": []
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json
@@ -13,12 +13,12 @@
           }
         ]
       },
-      "limit": 2,
+      "limit": 10,
       "offset": 0,
       "facets": [
         {
           "facet": "assetType",
-          "count": 0
+          "count": 10
         },
         {
           "facet": "classification",
@@ -28,17 +28,9 @@
           "facet": "term",
           "count": 10
         },
-        {
-          "facet": "fileExtension",
-          "count": 10
-        },
         {
           "facet": "label",
           "count": 10
-        },
-        {
-          "facet": "classificationCategory",
-          "count": 10
         }
       ]
     },
@@ -75,7 +67,6 @@
               "value": "MICROSOFT.GOVERNMENT.US.STATE"
             }
           ],
-          "fileExtension": [],
           "assetType": [
             {
               "count": 1476,
@@ -116,7 +107,6 @@
               "value": "Example.Label"
             }
           ],
-          "classificationCategory": [],
           "term": [
             {
               "count": 1,
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "and": [
           {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "and": [
           {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "not": {
           "classification": "MICROSOFT.SYSTEM.TEMP_FILE"
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json
@@ -34,7 +34,7 @@
           }
         ]
       },
-      "limit": 2,
+      "limit": 10,
       "offset": 0,
       "facets": [
         {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "searchRequest": {
       "keywords": null,
-      "limit": 2,
+      "limit": 10,
       "filter": {
         "and": [
           {
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "Endpoint": "{Endpoint}",
-    "guids": [
+    "guid": [
       "784c0f2f-afd2-e26b-f9cb-984f6c2c5021",
       "b4ebc8be-cef4-860a-bee9-28cc34cb5caa"
     ]
diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json
@@ -99,7 +99,7 @@
         },
         "parameters": [
           {
-            "name": "guids",
+            "name": "guid",
             "in": "query",
             "description": "An array of GUIDs of entities to create.",
             "required": true,
@@ -2476,6 +2476,9 @@
           },
           "Discovery_Query_Taxonomy": {
             "$ref": "./examples/Discovery_Query_Taxonomy.json"
+          },
+          "Discovery_Query_Collection": {
+            "$ref": "./examples/Discovery_Query_Collection.json"
           }
         },
         "parameters": [
@@ -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",
@@ -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",
@@ -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",

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`}`
`41`	`41`	`]`
`42`	`42`	`},`
`43`		`- "limit": 2,`
	`43`	`+ "limit": 10,`
`44`	`44`	`"offset": 0,`
`45`	`45`	`"facets": [`
`46`	`46`	`{`
`@@ -77,20 +77,6 @@`
`77`	`77`	`"sort": {`
`78`	`78`	`"count": "desc"`
`79`	`79`	`}`
`80`		`- },`
`81`		`- {`
`82`		`- "facet": "classificationCategory",`
`83`		`- "count": 0,`
`84`		`- "sort": {`
`85`		`- "count": "desc"`
`86`		`- }`
`87`		`- },`
`88`		`- {`
`89`		`- "facet": "fileExtension",`
`90`		`- "count": 0,`
`91`		`- "sort": {`
`92`		`- "count": "desc"`
`93`		`- }`
`94`	`80`	`}`
`95`	`81`	`]`
`96`	`82`	`},`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"Endpoint": "{Endpoint}",`
`4`	`4`	`"searchRequest": {`
`5`	`5`	`"keywords": null,`
`6`		`- "limit": 2,`
	`6`	`+ "limit": 10,`
`7`	`7`	`"filter": {`
`8`	`8`	`"and": [`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,12 +13,12 @@`
`13`	`13`	`}`
`14`	`14`	`]`
`15`	`15`	`},`
`16`		`- "limit": 2,`
	`16`	`+ "limit": 10,`
`17`	`17`	`"offset": 0,`
`18`	`18`	`"facets": [`
`19`	`19`	`{`
`20`	`20`	`"facet": "assetType",`
`21`		`- "count": 0`
	`21`	`+ "count": 10`
`22`	`22`	`},`
`23`	`23`	`{`
`24`	`24`	`"facet": "classification",`
`@@ -28,17 +28,9 @@`
`28`	`28`	`"facet": "term",`
`29`	`29`	`"count": 10`
`30`	`30`	`},`
`31`		`- {`
`32`		`- "facet": "fileExtension",`
`33`		`- "count": 10`
`34`		`- },`
`35`	`31`	`{`
`36`	`32`	`"facet": "label",`
`37`	`33`	`"count": 10`
`38`		`- },`
`39`		`- {`
`40`		`- "facet": "classificationCategory",`
`41`		`- "count": 10`
`42`	`34`	`}`
`43`	`35`	`]`
`44`	`36`	`},`
`@@ -75,7 +67,6 @@`
`75`	`67`	`"value": "MICROSOFT.GOVERNMENT.US.STATE"`
`76`	`68`	`}`
`77`	`69`	`],`
`78`		`- "fileExtension": [],`
`79`	`70`	`"assetType": [`
`80`	`71`	`{`
`81`	`72`	`"count": 1476,`
`@@ -116,7 +107,6 @@`
`116`	`107`	`"value": "Example.Label"`
`117`	`108`	`}`
`118`	`109`	`],`
`119`		`- "classificationCategory": [],`
`120`	`110`	`"term": [`
`121`	`111`	`{`
`122`	`112`	`"count": 1,`