[ADLA - ADLS] - Adding pageable extension for Catalog ACL APIs and re…

…moving childrenNum property (#2353) * Adding paging for ListAcls and ListAclsByDatabase * Although paging is not supported for these operations, the design decision that we took was to provide support at the client side just in case we need to add it from the server side. * Removing default response from Swagger for Acl APIs * Removing childrenNum property from FileStatusProperties * This property is always null as brought up by this issue: Azure/azure-sdk-for-net#3770 * Fixing examples for childrenNum * Fixing oav validate-example errors
Azure · Jan 30, 2018 · d3af35e · d3af35e
1 parent 142af24
commit d3af35e
Show file tree

Hide file tree

Showing 70 changed files with 207 additions and 96 deletions.
diff --git a/.../datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json b/.../datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json
@@ -2553,11 +2553,11 @@
             "schema": {
               "$ref": "#/definitions/AclList"
             }
-          },
-          "default": {
-            "description": "404 - Not found."
           }
         },
+        "x-ms-pageable": {
+          "nextLinkName": "nextLink"
+        },
         "x-ms-odata": "#/definitions/Acl"
       }
     },
@@ -2628,11 +2628,11 @@
             "schema": {
               "$ref": "#/definitions/AclList"
             }
-          },
-          "default": {
-            "description": "404 - Not found."
           }
         },
+        "x-ms-pageable": {
+          "nextLinkName": "nextLink"
+        },
         "x-ms-odata": "#/definitions/Acl"
       }
     },
@@ -2745,32 +2745,25 @@
     }
   },
   "x-ms-paths": {
-    "/catalog/usql/databases/{databaseName}/acl?op=GRANTACE": {
+    "/catalog/usql/acl?op=GRANTACE": {
       "post": {
         "tags": [
           "Catalog"
         ],
-        "operationId": "Catalog_GrantAclToDatabase",
-        "description": "Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog.",
+        "operationId": "Catalog_GrantAcl",
+        "description": "Grants an access control list (ACL) entry to the Data Lake Analytics catalog.",
         "x-ms-examples": {
-          "Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_GrantAclToDatabase.json" }
+          "Grants an access control list (ACL) entry to the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_GrantAcl.json" }
         },
         "parameters": [
-          {
-            "name": "databaseName",
-            "in": "path",
-            "required": true,
-            "type": "string",
-            "description": "The name of the database."
-          },
           {
             "name": "parameters",
             "in": "body",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AclCreateOrUpdateParameters"
             },
-            "description": "Parameters supplied to create or update an access control list (ACL) entry for a database."
+            "description": "Parameters supplied to create or update an access control list (ACL) entry for a Data Lake Analytics catalog."
           },
           {
             "name": "op",
@@ -2788,23 +2781,20 @@
         ],
         "responses": {
           "200": {
-            "description": "Successfully granted the access control list (ACL) entry to the specified database."
-          },
-          "default": {
-            "description": "404 - Not found."
+            "description": "Successfully granted the access control list (ACL) entry to the Data Lake Analytics catalog."
           }
         }
       }
     },
-    "/catalog/usql/databases/{databaseName}/acl?op=REVOKEACE": {
+    "/catalog/usql/databases/{databaseName}/acl?op=GRANTACE": {
       "post": {
         "tags": [
           "Catalog"
         ],
-        "operationId": "Catalog_RevokeAclFromDatabase",
-        "description": "Revokes an access control list (ACL) entry for the database from the Data Lake Analytics catalog.",
+        "operationId": "Catalog_GrantAclToDatabase",
+        "description": "Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog.",
         "x-ms-examples": {
-          "Revokes an access control list (ACL) entry for the database from the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_RevokeAclFromDatabase.json" }
+          "Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_GrantAclToDatabase.json" }
         },
         "parameters": [
           {
@@ -2819,9 +2809,9 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/AclDeleteParameters"
+              "$ref": "#/definitions/AclCreateOrUpdateParameters"
             },
-            "description": "Parameters supplied to delete an access control list (ACL) entry for a database."
+            "description": "Parameters supplied to create or update an access control list (ACL) entry for a database."
           },
           {
             "name": "op",
@@ -2830,7 +2820,7 @@
             "type": "string",
             "description": "The constant value for the operation.",
             "enum": [
-              "REVOKEACE"
+              "GRANTACE"
             ]
           },
           {
@@ -2839,33 +2829,30 @@
         ],
         "responses": {
           "200": {
-            "description": "Successfully revoked the access control list (ACL) entry from the specified database."
-          },
-          "default": {
-            "description": "404 - Not found."
+            "description": "Successfully granted the access control list (ACL) entry to the specified database."
           }
         }
       }
     },
-    "/catalog/usql/acl?op=GRANTACE": {
+    "/catalog/usql/acl?op=REVOKEACE": {
       "post": {
         "tags": [
           "Catalog"
         ],
-        "operationId": "Catalog_GrantAcl",
-        "description": "Grants an access control list (ACL) entry to the Data Lake Analytics catalog.",
+        "operationId": "Catalog_RevokeAcl",
+        "description": "Revokes an access control list (ACL) entry from the Data Lake Analytics catalog.",
         "x-ms-examples": {
-          "Grants an access control list (ACL) entry to the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_GrantAcl.json" }
+          "Revokes an access control list (ACL) entry from the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_RevokeAcl.json" }
         },
         "parameters": [
           {
             "name": "parameters",
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/AclCreateOrUpdateParameters"
+              "$ref": "#/definitions/AclDeleteParameters"
             },
-            "description": "Parameters supplied to create or update an access control list (ACL) entry for a Data Lake Analytics catalog."
+            "description": "Parameters supplied to delete an access control list (ACL) entry from a Data Lake Analytics catalog."
           },
           {
             "name": "op",
@@ -2874,7 +2861,7 @@
             "type": "string",
             "description": "The constant value for the operation.",
             "enum": [
-              "GRANTACE"
+              "REVOKEACE"
             ]
           },
           {
@@ -2883,33 +2870,37 @@
         ],
         "responses": {
           "200": {
-            "description": "Successfully granted the access control list (ACL) entry to the Data Lake Analytics catalog."
-          },
-          "default": {
-            "description": "404 - Not found."
+            "description": "Successfully revoked the access control list (ACL) entry from the Data Lake Analytics catalog."
           }
         }
       }
     },
-    "/catalog/usql/acl?op=REVOKEACE": {
+    "/catalog/usql/databases/{databaseName}/acl?op=REVOKEACE": {
       "post": {
         "tags": [
           "Catalog"
         ],
-        "operationId": "Catalog_RevokeAcl",
-        "description": "Revokes an access control list (ACL) entry from the Data Lake Analytics catalog.",
+        "operationId": "Catalog_RevokeAclFromDatabase",
+        "description": "Revokes an access control list (ACL) entry for the database from the Data Lake Analytics catalog.",
         "x-ms-examples": {
-          "Revokes an access control list (ACL) entry from the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_RevokeAcl.json" }
+          "Revokes an access control list (ACL) entry for the database from the Data Lake Analytics catalog": { "$ref": "./examples/Adla_Catalog_RevokeAclFromDatabase.json" }
         },
         "parameters": [
+          {
+            "name": "databaseName",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The name of the database."
+          },
           {
             "name": "parameters",
             "in": "body",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AclDeleteParameters"
             },
-            "description": "Parameters supplied to delete an access control list (ACL) entry from a Data Lake Analytics catalog."
+            "description": "Parameters supplied to delete an access control list (ACL) entry for a database."
           },
           {
             "name": "op",
@@ -2927,10 +2918,7 @@
         ],
         "responses": {
           "200": {
-            "description": "Successfully revoked the access control list (ACL) entry from the Data Lake Analytics catalog."
-          },
-          "default": {
-            "description": "404 - Not found."
+            "description": "Successfully revoked the access control list (ACL) entry from the specified database."
           }
         }
       }
@@ -3059,6 +3047,11 @@
       "description": "A Data Lake Analytics catalog access control list (ACL) entry."
     },
     "AclList": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/CatalogItemList"
+        }
+      ],
       "properties": {
         "value": {
           "type": "array",

diff --git a/...Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_CreateCredential.json b/...Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_CreateCredential.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "credentialName": "test_credential_name",
         "parameters": {

diff --git a/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_CreateSecret.json b/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_CreateSecret.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "secretName": "test_secret_name",
         "parameters": {

diff --git a/...Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_DeleteAllSecrets.json b/...Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_DeleteAllSecrets.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master"
     },
     "responses": {

diff --git a/...Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_DeleteCredential.json b/...Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_DeleteCredential.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "credentialName": "test_credential_name",
         "parameters": {

diff --git a/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_DeleteSecret.json b/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_DeleteSecret.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "secretName": "test_secret_name"
     },

diff --git a/...lane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetAssembly.json b/...lane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetAssembly.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "assemblyName": "test_assembly_name"
     },

diff --git a/...ne/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetCredential.json b/...ne/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetCredential.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "credentialName": "test_credential_name"
     },

diff --git a/...lane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetDatabase.json b/...lane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetDatabase.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master"
     },
     "responses": {

diff --git a/...soft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetExternalDataSource.json b/...soft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetExternalDataSource.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "externalDataSourceName": "test_external_data_source_name"
     },

diff --git a/...plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetPackage.json b/...plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetPackage.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo",
         "packageName": "test_package_name"

diff --git a/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetProcedure.json b/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetProcedure.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo",
         "procedureName": "test_procedure_name"

diff --git a/...-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetSchema.json b/...-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetSchema.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo"
     },

diff --git a/...-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetSecret.json b/...-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetSecret.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "secretName": "test_secret_name"
     },

diff --git a/...a-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTable.json b/...a-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTable.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo",
         "tableName": "test_table_name"

diff --git a/...icrosoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTablePartition.json b/...icrosoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTablePartition.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo",
         "tableName": "test_table_name",

diff --git a/...icrosoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTableStatistic.json b/...icrosoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTableStatistic.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo",
         "tableName": "test_table_name",

diff --git a/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTableType.json b/...ane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Adla_Catalog_GetTableType.json
@@ -1,6 +1,8 @@
 {
     "parameters": {
         "api-version": "2016-11-01",
+        "accountName": "contosoadla",
+        "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net",
         "databaseName": "master",
         "schemaName": "dbo",
         "tableTypeName": "test_table_type_name"