ADL Updates for errors and new endpoints #304
+4,924
−4,519
There are no files selected for viewing
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 |
|---|---|---|
|
|
@@ -63,3 +63,6 @@ node_modules | |
|
|
||
| #### JetBrains | ||
| .idea | ||
|
|
||
| # ignore code gen virtual env folder | ||
| SdkCodeGen | ||
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
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 |
|---|---|---|
|
|
@@ -192,6 +192,32 @@ | |
| } | ||
| } | ||
| }, | ||
| "/catalog/usql/databases/{databaseName}/secrets": { | ||
| "delete": { | ||
| "tags": [ | ||
| "Catalog" | ||
| ], | ||
| "operationId": "Catalog_DeleteAllSecrets", | ||
| "description": "Deletes all secrets in the specified database", | ||
| "parameters": [ | ||
| { | ||
| "name": "databaseName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the database containing the secret." | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}": { | ||
| "get": { | ||
| "tags": [ | ||
|
|
@@ -835,7 +861,7 @@ | |
| "Catalog" | ||
| ], | ||
| "operationId": "Catalog_GetTableStatistic", | ||
| "description": "Retrieves the specified table statistics from the Data Lake Analytics catalog.", | ||
| "parameters": [ | ||
| { | ||
| "name": "databaseName", | ||
|
|
@@ -885,7 +911,7 @@ | |
| "Catalog" | ||
| ], | ||
| "operationId": "Catalog_ListTableStatistics", | ||
| "description": "Retrieves the list of table statistics from the Data Lake Analytics catalog.", | ||
| "parameters": [ | ||
| { | ||
| "name": "databaseName", | ||
|
|
@@ -976,6 +1002,153 @@ | |
| } | ||
| } | ||
| }, | ||
| "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}": { | ||
| "get": { | ||
| "tags": [ | ||
| "Catalog" | ||
| ], | ||
| "operationId": "Catalog_GetTablePartition", | ||
| "description": "Retrieves the specified table partition from the Data Lake Analytics catalog.", | ||
| "parameters": [ | ||
| { | ||
| "name": "databaseName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the database containing the partition." | ||
| }, | ||
| { | ||
| "name": "schemaName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the schema containing the partition." | ||
| }, | ||
| { | ||
| "name": "tableName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the table containing the partition." | ||
| }, | ||
| { | ||
| "name": "partitionName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the table partition." | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "", | ||
| "schema": { | ||
| "$ref": "#/definitions/USqlTablePartition" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions": { | ||
| "get": { | ||
| "tags": [ | ||
| "Catalog" | ||
| ], | ||
| "operationId": "Catalog_ListTablePartitions", | ||
| "description": "Retrieves the list of table partitions from the Data Lake Analytics catalog.", | ||
| "parameters": [ | ||
| { | ||
| "name": "databaseName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the database containing the partitions." | ||
| }, | ||
| { | ||
| "name": "schemaName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the schema containing the partitions." | ||
| }, | ||
| { | ||
| "name": "tableName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the table containing the partitions." | ||
| }, | ||
| { | ||
| "name": "$filter", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "OData filter. Optional." | ||
| }, | ||
| { | ||
| "name": "$top", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "integer", | ||
| "format": "int32", | ||
| "description": "The number of items to return. Optional." | ||
| }, | ||
| { | ||
| "name": "$skip", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "integer", | ||
| "format": "int32", | ||
| "description": "The number of items to skip over before returning elements. Optional." | ||
| }, | ||
| { | ||
| "name": "$expand", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." | ||
| }, | ||
| { | ||
| "name": "$select", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." | ||
| }, | ||
| { | ||
| "name": "$orderby", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "string", | ||
| "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." | ||
| }, | ||
| { | ||
| "name": "$count", | ||
| "in": "query", | ||
| "required": false, | ||
| "type": "boolean", | ||
| "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
|
There was a problem hiding this comment. Is this a new requirement? by default, anything that is not a 200 response gets generated into a cloudException, which is currently what we want for everything except our filesystem swagger. What should I be putting in the default response if I want to continue to have the current behavior? There was a problem hiding this comment. @amarzavery for example, https://github.com/Azure/azure-rest-api-specs/blob/master/arm-resources/resources/2016-02-01/swagger/resources.json does not contain a single "default" either, since it uses the built in "everything that isn't explicitly specified is a CloudError" model. |
||
| "description": "", | ||
| "schema": { | ||
| "$ref": "#/definitions/USqlTablePartitionList" | ||
| } | ||
| } | ||
| }, | ||
|
There was a problem hiding this comment. Not sure what the question is here. We support x-ms-odata types for one type "USqlType", but that is not at this line. Do I need to include it everywhere? There was a problem hiding this comment. As per the doc the x-ms-odata extension is applied on the operation and not on the type. This will indicate AutoRest that it needs to handle odata parameters in a special way. As this operation has odata parameters and the x-ms-odata extension was missing hence high highlighted it. |
||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| } | ||
| } | ||
| }, | ||
| "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/types": { | ||
| "get": { | ||
| "tags": [ | ||
|
|
@@ -2006,6 +2179,59 @@ | |
| }, | ||
| "description": "A Data Lake Analytics catalog U-SQL view item list." | ||
| }, | ||
| "USqlTablePartition": { | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/CatalogItem" | ||
| } | ||
| ], | ||
| "properties": { | ||
| "databaseName": { | ||
| "type": "string", | ||
| "description": "Gets or sets the name of the database." | ||
| }, | ||
| "schemaName": { | ||
| "type": "string", | ||
| "description": "Gets or sets the name of the schema associated with this table partition and database." | ||
| }, | ||
| "partitionName": { | ||
| "type": "string", | ||
| "x-ms-client-name": "name", | ||
| "description": "Gets or sets the name of the table partition." | ||
| }, | ||
| "indexId": { | ||
| "type": "integer", | ||
| "format": "int32", | ||
| "description": "Gets or sets the index ID for this partition." | ||
| }, | ||
| "label": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "Gets or sets the list of labels associated with this partition." | ||
| } | ||
| }, | ||
| "description": "A Data Lake Analytics catalog U-SQL table partition item." | ||
| }, | ||
| "USqlTablePartitionList": { | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/CatalogItemList" | ||
| } | ||
| ], | ||
| "properties": { | ||
| "value": { | ||
| "type": "array", | ||
| "readOnly": true, | ||
| "items": { | ||
| "$ref": "#/definitions/USqlTablePartition" | ||
| }, | ||
| "description": "Gets the list of table partitions in the database, schema and table combination" | ||
| } | ||
| }, | ||
| "description": "A Data Lake Analytics catalog U-SQL table partition item list." | ||
| }, | ||
| "USqlTableStatistics": { | ||
| "allOf": [ | ||
| { | ||
|
|
||
Oops, something went wrong.
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.
general comment: have default response everyewhere
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.
As of today AutoRest will atleast deserialized code and message into the CloudError object. Any extra properties will not be deserialized since default does not have a schema. Although you will get the raw request and response as properties of the Exception so you can do deserialized it your way.
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.
@amarzavery that makes sense. Our errors actually adhere to the CloudError schema as it is right now, so it makes sense for us to use the default CloudException/CloudError setup. Below is the schema for all of our errors except Filesystem (which I updated). This should be properly deserialized by CloudError, right?
“error”: {
“code”: “string”,
“message”: “string”,
“target”: “optional string”,
“details”: [{
“code”: “string”,
“message”: “string”,
“target”: “optional string”
]},
“innerError”: {
“context”: “string”,
“trace”: “sdf”
}
}
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.
This will get deserialized correctly in node.js as the mapper has it defined.
It looks like this will be deserialized correctly in C# as well (even when the default schema is not specified).
@markcowl @hovsepm - Is my understanding correct?