Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2553,11 +2553,11 @@
"schema": {
"$ref": "#/definitions/AclList"
}
},
"default": {
"description": "404 - Not found."
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "#/definitions/Acl"
}
},
Expand Down Expand Up @@ -2628,11 +2628,11 @@
"schema": {
"$ref": "#/definitions/AclList"
}
},
"default": {
"description": "404 - Not found."
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "#/definitions/Acl"
}
},
Expand Down Expand Up @@ -2745,32 +2745,25 @@
}
},
"x-ms-paths": {
"/catalog/usql/databases/{databaseName}/acl?op=GRANTACE": {
"/catalog/usql/acl?op=GRANTACE": {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[For the record] Looking at the diff, at first glance it may appear that there are breaking changes in the following endpoints defs but not really - they appear so due to re-ordering of the operations in the swagger.

Catalog_GrantAclToDatabase
Catalog_GrantAcl
Catalog_RevokeAclFromDatabase
Catalog_GrantAcl
Catalog_RevokeAcl
Catalog_RevokeAclFromDatabase

@ro-joowan if possible, for future PRs it will be very helpful if we can ensure that PR shows only the changed sections.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anuchandy, Noted :) I should've put that part in a separate commit. Sorry about that!

"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",
Expand All @@ -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."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why we are removing the default from responses section?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anuchandy This was to follow the the rest of the APIs in that file. These ACL APIs were the first ones that I added to this Swagger file. But now as I look at them, I see that default is not really needed (or is redundant) because if it's not 200, we throw with the status code.

}
}
}
},
"/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": [
{
Expand All @@ -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",
Expand All @@ -2830,7 +2820,7 @@
"type": "string",
"description": "The constant value for the operation.",
"enum": [
"REVOKEACE"
"GRANTACE"
]
},
{
Expand All @@ -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",
Expand All @@ -2874,7 +2861,7 @@
"type": "string",
"description": "The constant value for the operation.",
"enum": [
"GRANTACE"
"REVOKEACE"
]
},
{
Expand All @@ -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",
Expand All @@ -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."
}
}
}
Expand Down Expand Up @@ -3059,6 +3047,11 @@
"description": "A Data Lake Analytics catalog access control list (ACL) entry."
},
"AclList": {
"allOf": [
{
"$ref": "#/definitions/CatalogItemList"
}
],
"properties": {
"value": {
"type": "array",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
},
"responses": {
"200": {
},
"404": {
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
},
"responses": {
"200": {
},
"404": {
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,13 @@
"responses": {
"200": {
"body": {
"nextLink":"https://contosoadla.datalakeanalytics.net/catalog/usql/databases/master/schema/dbo/statistics?api-version=2016-11-01&%24skiptoken=<token>",
"value": [{
"aceType": "User",
"principalId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"permission": "Use"
}]
}
},
"404": {
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,13 @@
"responses": {
"200": {
"body": {
"nextLink":"https://contosoadla.datalakeanalytics.net/catalog/usql/databases/master/schema/dbo/statistics?api-version=2016-11-01&%24skiptoken=<token>",
"value": [{
"aceType": "User",
"principalId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"permission": "Use"
}]
}
},
"404": {
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
},
"responses": {
"200": {
},
"404": {
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
},
"responses": {
"200": {
},
"404": {
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"FileStatus": {
"accessTime": 1,
"blockSize": 1,
"childrenNum": 1,
"msExpirationTime": 1,
"group": "test_group",
"length": 1,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"FileStatus": [{
"accessTime": 1,
"blockSize": 1,
"childrenNum": 1,
"msExpirationTime": 1,
"group": "test_group",
"length": 1,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1561,12 +1561,6 @@
"format": "int64",
"description": "the block size for the file."
},
"childrenNum": {
"type": "integer",
"readOnly": true,
"format": "int64",
"description": "the number of children in the directory."
},
"msExpirationTime": {
"x-ms-client-name": "expirationTime",
"type": "integer",
Expand Down