From 76e231deadf588d1bff0a382db9b96db22a81f29 Mon Sep 17 00:00:00 2001 From: Sam Hurd Date: Tue, 14 Jan 2020 14:04:05 -0500 Subject: [PATCH 01/21] adding swagger for tables dataplane --- .../2018-10-10/examples/TableCreate.json | 21 + .../2018-10-10/examples/TableDelete.json | 10 + .../examples/TableDeleteEntity.json | 12 + .../preview/2018-10-10/examples/TableGet.json | 22 + .../examples/TableInsertEntity.json | 46 + .../examples/TableQueryEntities.json | 29 + ...leQueryEntitiesWithPartitionAndRowKey.json | 30 + .../examples/TableSetServiceProperties.json | 12 + .../examples/TableUpdateEntity.json | 26 + .../preview/2018-10-10/table.json | 1502 +++++++++++++++++ .../2019-02-02/examples/TableCreate.json | 21 + .../2019-02-02/examples/TableDelete.json | 10 + .../examples/TableDeleteEntity.json | 12 + .../preview/2019-02-02/examples/TableGet.json | 22 + .../examples/TableInsertEntity.json | 46 + .../examples/TableQueryEntities.json | 29 + ...leQueryEntitiesWithPartitionAndRowKey.json | 30 + .../examples/TableSetServiceProperties.json | 12 + .../examples/TableUpdateEntity.json | 26 + .../preview/2019-02-02/table.json | 1502 +++++++++++++++++ .../cosmos-db/data-plane/readme.go.md | 36 + specification/cosmos-db/data-plane/readme.md | 294 ++++ .../cosmos-db/data-plane/readme.nodejs.md | 14 + .../cosmos-db/data-plane/readme.typescript.md | 12 + 24 files changed, 3776 insertions(+) create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDelete.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json create mode 100644 specification/cosmos-db/data-plane/readme.go.md create mode 100644 specification/cosmos-db/data-plane/readme.md create mode 100644 specification/cosmos-db/data-plane/readme.nodejs.md create mode 100644 specification/cosmos-db/data-plane/readme.typescript.md diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json new file mode 100644 index 000000000000..794eaae98dba --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "tableProperties": { + "TableName": "mytable" + } + }, + "responses": { + "201": { + "body": { + "odata.metadata": "https://myaccount.table.core.windows.net/$metadata#Tables/@Element", + "odata.type": " myaccount.Tables", + "odata.id": "https://myaccount.table.core.windows.net/Tables('mytable')", + "odata.editLink": "Tables('mytable')", + "TableName": "mytable" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json new file mode 100644 index 000000000000..a3cc9c4dfc4a --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "table": "mytable" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json new file mode 100644 index 000000000000..15d65dabf66c --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "mypartitionkey", + "rowKey": "myrowkey" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json new file mode 100644 index 000000000000..d0375630180a --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "$top": 1, + "url": "myaccount.table.core.windows.net" + }, + "responses": { + "200": { + "body": { + "odata.metadata": "https://myaccount.table.core.windows.net/$metadata#Tables", + "value": [ + { + "odata.type": "myaccount.Tables", + "odata.id": "https://myaccount.table.core.windows.net/Tables('mytable')", + "odata.editLink": "Tables('mytable')", + "TableName": "mytable" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json new file mode 100644 index 000000000000..6bdb8b18999d --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "table": "Customer", + "url": "myaccount.table.core.windows.net", + "tableEntityProperties": { + "Address": "Mountain View", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": true, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey" + } + }, + "responses": { + "200": { + "body": { + "odata.metadata": "https://myaccount.table.core.windows.net/Customer/$metadata#Customers/@Element", + "odata.type": "myaccount.Customers", + "odata.id": " https://myaccount.table.core.windows.net/Customers(PartitionKey='mypartitionkey',RowKey='myrowkey')", + "odata.etag": "W/\"0x5B168C7B6E589D2\"", + "odata.editLink": "Customers(PartitionKey='mypartitionkey',RowKey='myrowkey')", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey", + "Timestamp@odata.type": "Edm.DateTime", + "Timestamp": "2013-08-22T01:12:06.2608595Z", + "Address": "Mountain View", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": true, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255" + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json new file mode 100644 index 000000000000..7799d042a06e --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "$top": 1, + "table": "Customer" + }, + "responses": { + "200": { + "body": { + "odata.metadata": " https://myaccount.table.core.windows.net/metadata#Customers", + "value": [ + { + "PartitionKey": "Customer", + "RowKey": "Name", + "odata.type": "myaccount.Customers", + "odata.id": "https://myaccount.table.core.windows.net/Customers(PartitionKey=Customer',RowKey='Name')", + "odata.etag": "W/\"0x5B168C7B6E589D2\"", + "odata.editLink": "Customers(PartitionKey=Customer',RowKey='Name')", + "Timestamp@odata.type": "Edm.DateTime", + "Timestamp": "2013-08-22T00:20:16.3134645Z", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-10-01T15:25:05.2852025Z" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json new file mode 100644 index 000000000000..a62972f57bba --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "Customer", + "rowKey": "Name" + }, + "responses": { + "200": { + "body": { + "odata.metadata": " https://myaccount.table.core.windows.net/metadata#Customers", + "value": [ + { + "odata.type": "myaccount.Customers", + "odata.id": "https://myaccount.table.core.windows.net/Customers(PartitionKey=Customer',RowKey='Name')", + "odata.etag": "W/\"0x5B168C7B6E589D2\"", + "odata.editLink": "Customers(PartitionKey=Customer',RowKey='Name')", + "PartitionKey": "Customer", + "RowKey": "Name", + "Timestamp@odata.type": "Edm.DateTime", + "Timestamp": "2013-08-22T00:20:16.3134645Z", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-10-01T15:25:05.2852025Z" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json new file mode 100644 index 000000000000..255114c29651 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "restype": "service", + "comp": "properties", + "storageServiceProperties": "\"1.0\"truetruetruetrue\"1\"\"1.0\"truetruetrue\"1.0\"" + }, + "responses": { + "202": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json new file mode 100644 index 000000000000..321d3c98e3d6 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "x-ms-version": "2018-10-10", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "mypartitionkey", + "rowKey": "myrowkey", + "tableEntityProperties": { + "Address": "Santa Clara", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": false, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json new file mode 100644 index 000000000000..b900187ec232 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json @@ -0,0 +1,1502 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Table Storage", + "version": "2018-10-10", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "table_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to set the storage service properties" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ], + "description": "Required query string to set the storage service properties" + } + ] + }, + "/?restype=service&comp=stats": { + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to get storage service stats" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ], + "description": "Required query string to get storage service stats" + } + ] + }, + "/Tables": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_Query", + "x-ms-examples": { + "TableGet": { + "$ref": "./examples/TableGet.json" + } + }, + "description": "Queries tables under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Success, table query completed.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableQueryResponse" + } + } + } + }, + "post": { + "tags": [ + "table" + ], + "operationId": "Table_Create", + "x-ms-examples": { + "TableCreate": { + "$ref": "./examples/TableCreate.json" + } + }, + "description": "Creates a new table under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/TableProperties" + } + ], + "responses": { + "201": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/TableResponse" + } + }, + "204": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/Tables('{table}')": { + "delete": { + "tags": [ + "table" + ], + "operationId": "Table_Delete", + "x-ms-examples": { + "TableDelete": { + "$ref": "./examples/TableDelete.json" + } + }, + "description": "Operation permanently deletes the specified table", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{table}?comp=acl": { + "get": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_GetAccessPolicy", + "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_SetAccessPolicy", + "description": "sets stored access policies for the table that may be used with Shared Access Signatures", + "parameters": [ + { + "$ref": "#/parameters/TableAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ], + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + } + ] + }, + "/{table}()": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntities", + "x-ms-examples": { + "TableQueryEntities": { + "$ref": "./examples/TableQueryEntities.json" + } + }, + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", + "x-ms-examples": { + "TableQueryEntitiesWithPartitionAndRowKey": { + "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" + } + }, + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "table" + ], + "operationId": "Table_UpdateEntity", + "x-ms-examples": { + "TableUpdateEntity": { + "$ref": "./examples/TableUpdateEntity.json" + } + }, + "description": "Update entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "table" + ], + "operationId": "Table_DeleteEntity", + "x-ms-examples": { + "TableDeleteEntity": { + "$ref": "./examples/TableDeleteEntity.json" + } + }, + "description": "Deletes the specified entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{table}": { + "post": { + "tags": [ + "table" + ], + "operationId": "Table_InsertEntity", + "x-ms-examples": { + "TableInsertEntity": { + "$ref": "./examples/TableInsertEntity.json" + } + }, + "description": "Insert entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/TableEntityProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + } + }, + "definitions": { + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + } + } + }, + "StorageServiceProperties": { + "description": "Storage Service Properties.", + "type": "object", + "properties": { + "Logging": { + "description": "Azure Analytics Logging settings", + "$ref": "#/definitions/Logging" + }, + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for queues", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "a summary of request statistics grouped by API in minute aggregates for queues", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule", + "xml": { + "name": "CorsRule" + } + }, + "xml": { + "wrapped": true + } + } + } + }, + "Logging": { + "description": "Azure Analytics Logging settings.", + "type": "object", + "required": [ + "Version", + "Delete", + "Read", + "Write", + "RetentionPolicy" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Delete": { + "description": "Indicates whether all delete requests should be logged.", + "type": "boolean" + }, + "Read": { + "description": "Indicates whether all read requests should be logged.", + "type": "boolean" + }, + "Write": { + "description": "Indicates whether all write requests should be logged.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "Metrics": { + "description": "", + "required": [ + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the Queue service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "the request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "RetentionPolicy": { + "description": "the retention policy", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the storage service", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "type": "integer", + "minimum": 1 + } + } + }, + "StorageServiceStats": { + "description": "Stats for the storage service.", + "type": "object", + "properties": { + "GeoReplication": { + "description": "Geo-Replication information for the Secondary Storage Service", + "$ref": "#/definitions/GeoReplication" + } + } + }, + "GeoReplication": { + "type": "object", + "required": [ + "Status", + "LastSyncTime" + ], + "properties": { + "Status": { + "description": "The status of the secondary location", + "type": "string", + "enum": [ + "live", + "bootstrap", + "unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatusType", + "modelAsString": true + } + }, + "LastSyncTime": { + "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "TableProperties": { + "description": "The properties for creating a table.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table to create.", + "type": "string" + } + } + }, + "TableResponse": { + "description": "The response for a single table.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TableResponseProperties" + } + ] + }, + "TableQueryResponse": { + "description": "The properties for the table query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of tables.", + "type": "array", + "items": { + "$ref": "#/definitions/TableResponseProperties" + } + } + } + }, + "TableResponseProperties": { + "description": "The properties for the table response.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table.", + "type": "string" + }, + "odata.type": { + "description": "The odata type of the table.", + "type": "string" + }, + "odata.id": { + "description": "The id of the table.", + "type": "string" + }, + "odata.editLink": { + "description": "The edit link of the table.", + "type": "string" + } + } + }, + "SignedIdentifier": { + "description": "signed identifier", + "type": "object", + "required": [ + "Id", + "AccessPolicy" + ], + "properties": { + "Id": { + "type": "string", + "description": "a unique id" + }, + "AccessPolicy": { + "description": "The access policy", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "a collection of signed identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "AccessPolicy": { + "type": "object", + "required": [ + "Start", + "Expiry", + "Permission" + ], + "description": "An Access policy", + "properties": { + "Start": { + "description": "the date-time the policy is active", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "the date-time the policy expires", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "the permissions for the acl policy", + "type": "string" + } + } + }, + "TableEntityQueryResponse": { + "description": "The properties for the table entity query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of table entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TableEntityProperties" + } + } + } + }, + "TableEntityProperties": { + "description": "The other properties of the table entity", + "type": "object", + "additionalProperties": true + } + }, + "parameters": { + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "description": "The URL of the service account or table that is the targe of the desired operation.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StorageServiceProperties": { + "name": "storageServiceProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method", + "description": "The StorageService properties." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations." + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2018-10-10" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "TableProperties": { + "name": "tableProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableProperties" + }, + "x-ms-parameter-location": "method", + "description": "The Table properties." + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Select" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "TableAcl": { + "name": "tableAcl", + "in": "body", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method", + "description": "the acls for the table" + }, + "TableEntityProperties": { + "name": "tableEntityProperties", + "in": "body", + "schema": { + "$ref": "#/definitions/TableEntityProperties" + }, + "x-ms-parameter-location": "method", + "description": "The properties for the table entity" + }, + "tableNameParameter": { + "name": "table", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the table" + }, + "partitionKeyParameter": { + "name": "partitionKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The partition key of the entity" + }, + "rowKeyParameter": { + "name": "rowKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The row key of the entity" + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json new file mode 100644 index 000000000000..eb310a291138 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "tableProperties": { + "TableName": "mytable" + } + }, + "responses": { + "201": { + "body": { + "odata.metadata": "https://myaccount.table.core.windows.net/$metadata#Tables/@Element", + "odata.type": " myaccount.Tables", + "odata.id": "https://myaccount.table.core.windows.net/Tables('mytable')", + "odata.editLink": "Tables('mytable')", + "TableName": "mytable" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDelete.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDelete.json new file mode 100644 index 000000000000..0cc1f4bb05c7 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDelete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "table": "mytable" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json new file mode 100644 index 000000000000..dbc8259c5f96 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "mypartitionkey", + "rowKey": "myrowkey" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json new file mode 100644 index 000000000000..f0204695f478 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "$top": 1, + "url": "myaccount.table.core.windows.net" + }, + "responses": { + "200": { + "body": { + "odata.metadata": "https://myaccount.table.core.windows.net/$metadata#Tables", + "value": [ + { + "odata.type": "myaccount.Tables", + "odata.id": "https://myaccount.table.core.windows.net/Tables('mytable')", + "odata.editLink": "Tables('mytable')", + "TableName": "mytable" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json new file mode 100644 index 000000000000..35c9db594bc4 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "table": "Customer", + "url": "myaccount.table.core.windows.net", + "tableEntityProperties": { + "Address": "Mountain View", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": true, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey" + } + }, + "responses": { + "200": { + "body": { + "odata.metadata": "https://myaccount.table.core.windows.net/Customer/$metadata#Customers/@Element", + "odata.type": "myaccount.Customers", + "odata.id": " https://myaccount.table.core.windows.net/Customers(PartitionKey='mypartitionkey',RowKey='myrowkey')", + "odata.etag": "W/\"0x5B168C7B6E589D2\"", + "odata.editLink": "Customers(PartitionKey='mypartitionkey',RowKey='myrowkey')", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey", + "Timestamp@odata.type": "Edm.DateTime", + "Timestamp": "2013-08-22T01:12:06.2608595Z", + "Address": "Mountain View", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": true, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255" + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json new file mode 100644 index 000000000000..a511f6304b78 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "$top": 1, + "table": "Customer" + }, + "responses": { + "200": { + "body": { + "odata.metadata": " https://myaccount.table.core.windows.net/metadata#Customers", + "value": [ + { + "PartitionKey": "Customer", + "RowKey": "Name", + "odata.type": "myaccount.Customers", + "odata.id": "https://myaccount.table.core.windows.net/Customers(PartitionKey=Customer',RowKey='Name')", + "odata.etag": "W/\"0x5B168C7B6E589D2\"", + "odata.editLink": "Customers(PartitionKey=Customer',RowKey='Name')", + "Timestamp@odata.type": "Edm.DateTime", + "Timestamp": "2013-08-22T00:20:16.3134645Z", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-10-01T15:25:05.2852025Z" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json new file mode 100644 index 000000000000..539142b76846 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "Customer", + "rowKey": "Name" + }, + "responses": { + "200": { + "body": { + "odata.metadata": " https://myaccount.table.core.windows.net/metadata#Customers", + "value": [ + { + "odata.type": "myaccount.Customers", + "odata.id": "https://myaccount.table.core.windows.net/Customers(PartitionKey=Customer',RowKey='Name')", + "odata.etag": "W/\"0x5B168C7B6E589D2\"", + "odata.editLink": "Customers(PartitionKey=Customer',RowKey='Name')", + "PartitionKey": "Customer", + "RowKey": "Name", + "Timestamp@odata.type": "Edm.DateTime", + "Timestamp": "2013-08-22T00:20:16.3134645Z", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-10-01T15:25:05.2852025Z" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json new file mode 100644 index 000000000000..0284ec850c0c --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "restype": "service", + "comp": "properties", + "storageServiceProperties": "\"1.0\"truetruetruetrue\"1\"\"1.0\"truetruetrue\"1.0\"" + }, + "responses": { + "202": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json new file mode 100644 index 000000000000..4b8573f8123d --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "mypartitionkey", + "rowKey": "myrowkey", + "tableEntityProperties": { + "Address": "Santa Clara", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": false, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json new file mode 100644 index 000000000000..4e0fc73010e3 --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -0,0 +1,1502 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Table Storage", + "version": "2019-02-02", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "table_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to set the storage service properties" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ], + "description": "Required query string to set the storage service properties" + } + ] + }, + "/?restype=service&comp=stats": { + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to get storage service stats" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ], + "description": "Required query string to get storage service stats" + } + ] + }, + "/Tables": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_Query", + "x-ms-examples": { + "TableGet": { + "$ref": "./examples/TableGet.json" + } + }, + "description": "Queries tables under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Success, table query completed.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableQueryResponse" + } + } + } + }, + "post": { + "tags": [ + "table" + ], + "operationId": "Table_Create", + "x-ms-examples": { + "TableCreate": { + "$ref": "./examples/TableCreate.json" + } + }, + "description": "Creates a new table under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/TableProperties" + } + ], + "responses": { + "201": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/TableResponse" + } + }, + "204": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/Tables('{table}')": { + "delete": { + "tags": [ + "table" + ], + "operationId": "Table_Delete", + "x-ms-examples": { + "TableDelete": { + "$ref": "./examples/TableDelete.json" + } + }, + "description": "Operation permanently deletes the specified table", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{table}?comp=acl": { + "get": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_GetAccessPolicy", + "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_SetAccessPolicy", + "description": "sets stored access policies for the table that may be used with Shared Access Signatures", + "parameters": [ + { + "$ref": "#/parameters/TableAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ], + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + } + ] + }, + "/{table}()": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntities", + "x-ms-examples": { + "TableQueryEntities": { + "$ref": "./examples/TableQueryEntities.json" + } + }, + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", + "x-ms-examples": { + "TableQueryEntitiesWithPartitionAndRowKey": { + "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" + } + }, + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "table" + ], + "operationId": "Table_UpdateEntity", + "x-ms-examples": { + "TableUpdateEntity": { + "$ref": "./examples/TableUpdateEntity.json" + } + }, + "description": "Update entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "table" + ], + "operationId": "Table_DeleteEntity", + "x-ms-examples": { + "TableDeleteEntity": { + "$ref": "./examples/TableDeleteEntity.json" + } + }, + "description": "Deletes the specified entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/{table}": { + "post": { + "tags": [ + "table" + ], + "operationId": "Table_InsertEntity", + "x-ms-examples": { + "TableInsertEntity": { + "$ref": "./examples/TableInsertEntity.json" + } + }, + "description": "Insert entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/TableEntityProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + } + }, + "definitions": { + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + } + } + }, + "StorageServiceProperties": { + "description": "Storage Service Properties.", + "type": "object", + "properties": { + "Logging": { + "description": "Azure Analytics Logging settings", + "$ref": "#/definitions/Logging" + }, + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for queues", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "a summary of request statistics grouped by API in minute aggregates for queues", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule", + "xml": { + "name": "CorsRule" + } + }, + "xml": { + "wrapped": true + } + } + } + }, + "Logging": { + "description": "Azure Analytics Logging settings.", + "type": "object", + "required": [ + "Version", + "Delete", + "Read", + "Write", + "RetentionPolicy" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Delete": { + "description": "Indicates whether all delete requests should be logged.", + "type": "boolean" + }, + "Read": { + "description": "Indicates whether all read requests should be logged.", + "type": "boolean" + }, + "Write": { + "description": "Indicates whether all write requests should be logged.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "Metrics": { + "description": "", + "required": [ + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the Queue service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "the request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "RetentionPolicy": { + "description": "the retention policy", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the storage service", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "type": "integer", + "minimum": 1 + } + } + }, + "StorageServiceStats": { + "description": "Stats for the storage service.", + "type": "object", + "properties": { + "GeoReplication": { + "description": "Geo-Replication information for the Secondary Storage Service", + "$ref": "#/definitions/GeoReplication" + } + } + }, + "GeoReplication": { + "type": "object", + "required": [ + "Status", + "LastSyncTime" + ], + "properties": { + "Status": { + "description": "The status of the secondary location", + "type": "string", + "enum": [ + "live", + "bootstrap", + "unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatusType", + "modelAsString": true + } + }, + "LastSyncTime": { + "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "TableProperties": { + "description": "The properties for creating a table.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table to create.", + "type": "string" + } + } + }, + "TableResponse": { + "description": "The response for a single table.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TableResponseProperties" + } + ] + }, + "TableQueryResponse": { + "description": "The properties for the table query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of tables.", + "type": "array", + "items": { + "$ref": "#/definitions/TableResponseProperties" + } + } + } + }, + "TableResponseProperties": { + "description": "The properties for the table response.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table.", + "type": "string" + }, + "odata.type": { + "description": "The odata type of the table.", + "type": "string" + }, + "odata.id": { + "description": "The id of the table.", + "type": "string" + }, + "odata.editLink": { + "description": "The edit link of the table.", + "type": "string" + } + } + }, + "SignedIdentifier": { + "description": "signed identifier", + "type": "object", + "required": [ + "Id", + "AccessPolicy" + ], + "properties": { + "Id": { + "type": "string", + "description": "a unique id" + }, + "AccessPolicy": { + "description": "The access policy", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "a collection of signed identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "AccessPolicy": { + "type": "object", + "required": [ + "Start", + "Expiry", + "Permission" + ], + "description": "An Access policy", + "properties": { + "Start": { + "description": "the date-time the policy is active", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "the date-time the policy expires", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "the permissions for the acl policy", + "type": "string" + } + } + }, + "TableEntityQueryResponse": { + "description": "The properties for the table entity query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of table entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TableEntityProperties" + } + } + } + }, + "TableEntityProperties": { + "description": "The other properties of the table entity", + "type": "object", + "additionalProperties": true + } + }, + "parameters": { + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "description": "The URL of the service account or table that is the targe of the desired operation.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StorageServiceProperties": { + "name": "storageServiceProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method", + "description": "The StorageService properties." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations." + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2019-02-02" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "TableProperties": { + "name": "tableProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableProperties" + }, + "x-ms-parameter-location": "method", + "description": "The Table properties." + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Select" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "TableAcl": { + "name": "tableAcl", + "in": "body", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method", + "description": "the acls for the table" + }, + "TableEntityProperties": { + "name": "tableEntityProperties", + "in": "body", + "schema": { + "$ref": "#/definitions/TableEntityProperties" + }, + "x-ms-parameter-location": "method", + "description": "The properties for the table entity" + }, + "tableNameParameter": { + "name": "table", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the table" + }, + "partitionKeyParameter": { + "name": "partitionKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The partition key of the entity" + }, + "rowKeyParameter": { + "name": "rowKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The row key of the entity" + } + } +} diff --git a/specification/cosmos-db/data-plane/readme.go.md b/specification/cosmos-db/data-plane/readme.go.md new file mode 100644 index 000000000000..b5e151cb8a59 --- /dev/null +++ b/specification/cosmos-db/data-plane/readme.go.md @@ -0,0 +1,36 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: storagetables + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2019-02 + - tag: package-2018-10 +``` + +### Tag: package-2019-02 and go + +These settings apply only when `--tag=package-2019-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-02' && $(go) +output-folder: $(go-sdk-folder)/services/storage/tables/2019-02-02/$(namespace) +``` + +### Tag: package-2018-10 and go + +These settings apply only when `--tag=package-2018-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-10' && $(go) +output-folder: $(go-sdk-folder)/services/preview/storage/tables/2018-10-10/$(namespace) +``` \ No newline at end of file diff --git a/specification/cosmos-db/data-plane/readme.md b/specification/cosmos-db/data-plane/readme.md new file mode 100644 index 000000000000..822fb36acd7e --- /dev/null +++ b/specification/cosmos-db/data-plane/readme.md @@ -0,0 +1,294 @@ +# Table Storage Dataplane + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Tables Storage. + + + +--- +## Getting Started +To build the SDK for Tables Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Tables Storage API. + +``` yaml +azure-validator: true +openapi-type: data-plane +tag: package-2019-02 +``` + +### Tag: package-2019-02 + +These settings apply only when `--tag=package-2019-02` is specified on the command line. + +``` yaml $(tag) == 'package-2019-02' +input-file: +- Microsoft.TablesStorage/preview/2019-02-02/table.json +``` + +### Tag: package-2018-10 + +These settings apply only when `--tag=package-2018-10` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10' +input-file: +- Microsoft.TablesStorage/preview/2018-10-10/table.json +``` + +--- +# Suppressions + +``` yaml +directive: + - suppress: D5001 + where: $.paths["/?restype=service&comp=properties"].put + reason: The path only supports XML input/outputm which is not supported + - suppress: D5001 + where: $.paths["/?restype=service&comp=properties"].get + reason: The path only supports XML input/outputm which is not supported + - suppress: D5001 + where: $.paths["/?restype=service&comp=stats"].get + reason: The path only supports XML input/outputm which is not supported + - suppress: D5001 + where: $.paths["/{table}?comp=acl"].get + reason: The path only supports XML input/outputm which is not supported + - suppress: D5001 + where: $.paths["/{table}?comp=acl"].put + reason: The path only supports XML input/outputm which is not supported + - suppress: R3016 + where: $.definitions.StorageError.properties.Message + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.StorageServiceProperties.properties.Logging + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.StorageServiceProperties.properties.HourMetrics + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.StorageServiceProperties.properties.MinuteMetrics + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.StorageServiceProperties.properties.Cors + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Logging.properties.Version + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Logging.properties.Delete + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Logging.properties.Read + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Logging.properties.Write + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Logging.properties.RetentionPolicy + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Metrics.properties.Version + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Metrics.properties.Enabled + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Metrics.properties.IncludeAPIs + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.Metrics.properties.RetentionPolicy + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.CorsRule.properties.AllowedOrigins + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.CorsRule.properties.AllowedMethods + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.CorsRule.properties.AllowedHeaders + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.CorsRule.properties.ExposedHeaders + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.CorsRule.properties.MaxAgeInSeconds + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.RetentionPolicy.properties.Enabled + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.RetentionPolicy.properties.Days + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.StorageServiceStats.properties.GeoReplication + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.GeoReplication.properties.Status + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.GeoReplication.properties.LastSyncTime + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableProperties.properties.TableName + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableResponse.properties["odata.metadata"] + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableQueryResponse.properties["odata.metadata"] + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableResponseProperties.properties.TableName + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableResponseProperties.properties["odata.type"] + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableResponseProperties.properties["odata.id"] + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableResponseProperties.properties["odata.editLink"] + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.SignedIdentifier.properties.Id + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.SignedIdentifier.properties.AccessPolicy + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.AccessPolicy.properties.Start + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.AccessPolicy.properties.Expiry + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.AccessPolicy.properties.Permission + reason: Response from service is not camel case + - suppress: R3016 + where: $.definitions.TableEntityQueryResponse.properties["odata.metadata"] + reason: Response from service is not camel case +``` + +--- +# Code Generation + + +## Swagger to SDK + +Swagger to SDK has been intentionally disabled for this spec. + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Storage.Tables + output-folder: $(csharp-sdks-folder)/Storage/Tables/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.media + package-name: azure-tables-storage + clear-output-folder: true + no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-2019-02 + - tag: package-2018-10 +``` + +### Tag: package-2019-02 and python + +These settings apply only when `--tag=package-2019-02 --python` is specified on the command line. + +``` yaml $(tag) == 'package-2019-02' && $(python) +python: + namespace: azure.tables.storage.v2019_02_02 + output-folder: $(python-sdks-folder)/azure-tables-storage/azure/tables/storage/v2019_02_02 +``` + +### Tag: package-2018-10 and python + +These settings apply only when `--tag=package-2018-10 --python` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10' && $(python) +python: + namespace: azure.tables.storage.v2018_10_10 + output-folder: $(python-sdks-folder)/azure-tables-storage/azure/tables/storage/v2018_10_10 +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.storage.tables + license-header: MICROSOFT_MIT_NO_CODEGEN + output-folder: $(azure-libraries-for-java-folder)/azure-storage-tables +``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.TablesStorage/preview/2019-02-02/table.json + - $(this-folder)/Microsoft.TablesStorage/preview/2018-06-17/table.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` \ No newline at end of file diff --git a/specification/cosmos-db/data-plane/readme.nodejs.md b/specification/cosmos-db/data-plane/readme.nodejs.md new file mode 100644 index 000000000000..2e137439952a --- /dev/null +++ b/specification/cosmos-db/data-plane/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-storage-tables + output-folder: $(node-sdks-folder)/lib/services/storageTables + generate-license-txt: false + generate-package-json: false + generate-readme-md: false +``` \ No newline at end of file diff --git a/specification/cosmos-db/data-plane/readme.typescript.md b/specification/cosmos-db/data-plane/readme.typescript.md new file mode 100644 index 000000000000..29266ce43bf5 --- /dev/null +++ b/specification/cosmos-db/data-plane/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/storage-tables" + output-folder: "$(typescript-sdks-folder)/sdk/storage/storage-tables" + generate-metadata: true +``` \ No newline at end of file From 0a9e013d1ca1e6085be51092936cf2099e0845ce Mon Sep 17 00:00:00 2001 From: Sam Hurd Date: Wed, 15 Jan 2020 18:29:10 -0500 Subject: [PATCH 02/21] updating produces/consumes, adding format parameter and adding DataServiceVersion header --- .../2018-10-10/examples/TableCreate.json | 1 + .../examples/TableDeleteEntity.json | 1 + .../preview/2018-10-10/examples/TableGet.json | 1 + .../examples/TableInsertEntity.json | 1 + .../examples/TableQueryEntities.json | 1 + ...leQueryEntitiesWithPartitionAndRowKey.json | 1 + .../examples/TableSetServiceProperties.json | 12 --- .../examples/TableUpdateEntity.json | 1 + .../preview/2018-10-10/table.json | 74 ++++++++++++++++++- .../2019-02-02/examples/TableCreate.json | 1 + .../examples/TableDeleteEntity.json | 1 + .../preview/2019-02-02/examples/TableGet.json | 1 + .../examples/TableInsertEntity.json | 1 + .../examples/TableQueryEntities.json | 1 + ...leQueryEntitiesWithPartitionAndRowKey.json | 1 + .../examples/TableSetServiceProperties.json | 12 --- .../examples/TableUpdateEntity.json | 1 + .../preview/2019-02-02/table.json | 74 ++++++++++++++++++- 18 files changed, 158 insertions(+), 28 deletions(-) delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json index 794eaae98dba..d4f34cfccdbe 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "tableProperties": { "TableName": "mytable" diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json index 15d65dabf66c..8ea39e236b20 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "mypartitionkey", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json index d0375630180a..218af3fd4b87 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "$top": 1, "url": "myaccount.table.core.windows.net" }, diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json index 6bdb8b18999d..a5f6a814ba79 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "table": "Customer", "url": "myaccount.table.core.windows.net", "tableEntityProperties": { diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json index 7799d042a06e..0dbdb835a44b 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "$top": 1, "table": "Customer" diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json index a62972f57bba..12dcb075ec0d 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "Customer", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json deleted file mode 100644 index 255114c29651..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableSetServiceProperties.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "url": "myaccount.table.core.windows.net", - "restype": "service", - "comp": "properties", - "storageServiceProperties": "\"1.0\"truetruetruetrue\"1\"\"1.0\"truetruetrue\"1.0\"" - }, - "responses": { - "202": {} - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json index 321d3c98e3d6..d7853c3e6e27 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2018-10-10", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "mypartitionkey", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json index b900187ec232..874fffeb58f3 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json @@ -29,10 +29,10 @@ "https" ], "consumes": [ - "application/json" + "application/json;odata=fullmetadata" ], "produces": [ - "application/json" + "application/json;odata=fullmetadata" ], "paths": { "/?restype=service&comp=properties": { @@ -290,6 +290,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/topParameter" }, @@ -353,6 +359,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/TableProperties" } @@ -664,6 +676,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/topParameter" }, @@ -747,6 +765,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/selectParameter" }, @@ -831,6 +855,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/TableEntityProperties" }, @@ -905,6 +935,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/tableNameParameter" }, @@ -978,6 +1014,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/TableEntityProperties" }, @@ -1408,6 +1450,17 @@ "x-ms-parameter-location": "method", "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, + "DataServiceVersionParameter": { + "name": "DataServiceVersion", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the data service version", + "x-ms-parameter-location": "method", + "enum": [ + "3.0" + ] + }, "TableProperties": { "name": "tableProperties", "in": "body", @@ -1418,6 +1471,23 @@ "x-ms-parameter-location": "method", "description": "The Table properties." }, + "formatParameter": { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the media type for the response", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Format", + "enum": [ + "application/json;odata=nometadata", + "application/json;odata=minimalmetadata", + "application/json;odata=fullmetadata" + ] + }, "topParameter": { "name": "$top", "in": "query", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json index eb310a291138..803e06fd5d20 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "tableProperties": { "TableName": "mytable" diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json index dbc8259c5f96..fa4580e4ea8b 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "mypartitionkey", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json index f0204695f478..018859152f5a 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "$top": 1, "url": "myaccount.table.core.windows.net" }, diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json index 35c9db594bc4..7d8410a9dbf3 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "table": "Customer", "url": "myaccount.table.core.windows.net", "tableEntityProperties": { diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json index a511f6304b78..2daab5a9feb0 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "$top": 1, "table": "Customer" diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json index 539142b76846..94896182a26b 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "Customer", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json deleted file mode 100644 index 0284ec850c0c..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableSetServiceProperties.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2019-02-02", - "url": "myaccount.table.core.windows.net", - "restype": "service", - "comp": "properties", - "storageServiceProperties": "\"1.0\"truetruetruetrue\"1\"\"1.0\"truetruetrue\"1.0\"" - }, - "responses": { - "202": {} - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json index 4b8573f8123d..c070ff644a6c 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json @@ -1,6 +1,7 @@ { "parameters": { "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "mypartitionkey", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 4e0fc73010e3..bea0bc0b555b 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -29,10 +29,10 @@ "https" ], "consumes": [ - "application/json" + "application/json;odata=fullmetadata" ], "produces": [ - "application/json" + "application/json;odata=fullmetadata" ], "paths": { "/?restype=service&comp=properties": { @@ -290,6 +290,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/topParameter" }, @@ -353,6 +359,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/TableProperties" } @@ -664,6 +676,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/topParameter" }, @@ -747,6 +765,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/selectParameter" }, @@ -831,6 +855,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/TableEntityProperties" }, @@ -905,6 +935,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/tableNameParameter" }, @@ -978,6 +1014,12 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/TableEntityProperties" }, @@ -1408,6 +1450,17 @@ "x-ms-parameter-location": "method", "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." }, + "DataServiceVersionParameter": { + "name": "DataServiceVersion", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the data service version", + "x-ms-parameter-location": "method", + "enum": [ + "3.0" + ] + }, "TableProperties": { "name": "tableProperties", "in": "body", @@ -1418,6 +1471,23 @@ "x-ms-parameter-location": "method", "description": "The Table properties." }, + "formatParameter": { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the media type for the response", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Format", + "enum": [ + "application/json;odata=nometadata", + "application/json;odata=minimalmetadata", + "application/json;odata=fullmetadata" + ] + }, "topParameter": { "name": "$top", "in": "query", From 1975603c9eb0a511a572712266d5eaeeeca66f94 Mon Sep 17 00:00:00 2001 From: Sam Hurd Date: Fri, 17 Jan 2020 14:57:17 -0500 Subject: [PATCH 03/21] update swagger so that query parameters do not appear in x-ms-paths --- .../preview/2018-10-10/table.json | 737 +++++++++--------- .../preview/2019-02-02/table.json | 733 ++++++++--------- specification/cosmos-db/data-plane/readme.md | 16 +- 3 files changed, 751 insertions(+), 735 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json index 874fffeb58f3..4638ef8de3ec 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure Table Storage", - "version": "2018-10-10", + "version": "2019-10-10", "x-ms-code-generation-settings": { "header": "MIT", "strictSpecAdherence": false @@ -35,36 +35,44 @@ "application/json;odata=fullmetadata" ], "paths": { - "/?restype=service&comp=properties": { - "put": { + "/Tables": { + "get": { "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "table" ], - "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "operationId": "Table_Query", + "x-ms-examples": { + "TableGet": { + "$ref": "./examples/TableGet.json" + } + }, + "description": "Queries tables under the given account.", "parameters": [ { - "$ref": "#/parameters/StorageServiceProperties" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/Timeout" + "$ref": "#/parameters/ClientRequestId" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataServiceVersionParameter" }, { - "$ref": "#/parameters/ClientRequestId" + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" } ], "responses": { - "202": { - "description": "Success (Accepted)", + "200": { + "description": "Success, table query completed.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -79,50 +87,55 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableQueryResponse" } } } }, - "get": { + "post": { "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "table" ], - "operationId": "Service_GetProperties", - "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "operationId": "Table_Create", + "x-ms-examples": { + "TableCreate": { + "$ref": "./examples/TableCreate.json" + } + }, + "description": "Creates a new table under the given account.", "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableProperties" } ], "responses": { - "200": { - "description": "Success.", + "201": { + "description": "Success, table created.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -137,11 +150,41 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } }, "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "$ref": "#/definitions/TableResponse" + } + }, + "204": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, "default": { @@ -157,57 +200,34 @@ } } } - }, - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to set the storage service properties" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ], - "description": "Required query string to set the storage service properties" - } - ] + } }, - "/?restype=service&comp=stats": { - "get": { + "/Tables('{table}')": { + "delete": { "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "table" ], - "operationId": "Service_GetStatistics", - "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "operationId": "Table_Delete", + "x-ms-examples": { + "TableDelete": { + "$ref": "./examples/TableDelete.json" + } + }, + "description": "Operation permanently deletes the specified table", "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" } ], "responses": { - "200": { - "description": "Success.", + "204": { + "description": "No Content", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -222,16 +242,13 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, "Date": { "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } - }, - "schema": { - "$ref": "#/definitions/StorageServiceStats" } }, "default": { @@ -247,43 +264,24 @@ } } } - }, - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to get storage service stats" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "stats" - ], - "description": "Required query string to get storage service stats" - } - ] + } }, - "/Tables": { + "/{table}()": { "get": { "tags": [ "table" ], - "operationId": "Table_Query", + "operationId": "Table_QueryEntities", "x-ms-examples": { - "TableGet": { - "$ref": "./examples/TableGet.json" + "TableQueryEntities": { + "$ref": "./examples/TableQueryEntities.json" } }, - "description": "Queries tables under the given account.", + "description": "Queries entities in a table.", "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -304,11 +302,14 @@ }, { "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" } ], "responses": { "200": { - "description": "Success, table query completed.", + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -336,23 +337,40 @@ } }, "schema": { - "$ref": "#/definitions/TableQueryResponse" + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } } } - }, - "post": { + } + }, + "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { + "get": { "tags": [ "table" ], - "operationId": "Table_Create", + "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", "x-ms-examples": { - "TableCreate": { - "$ref": "./examples/TableCreate.json" + "TableQueryEntitiesWithPartitionAndRowKey": { + "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" } }, - "description": "Creates a new table under the given account.", + "description": "Queries entities in a table.", "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -366,12 +384,24 @@ "$ref": "#/parameters/formatParameter" }, { - "$ref": "#/parameters/TableProperties" + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "201": { - "description": "Success, table created.", + "200": { + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -392,35 +422,14 @@ "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/TableResponse" - } - }, - "204": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "Date": { + "x-ms-continuation-NextTableName": { "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "This header contains the continuation token value." } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" } }, "default": { @@ -436,34 +445,50 @@ } } } - } - }, - "/Tables('{table}')": { - "delete": { + }, + "put": { "tags": [ "table" ], - "operationId": "Table_Delete", + "operationId": "Table_UpdateEntity", "x-ms-examples": { - "TableDelete": { - "$ref": "./examples/TableDelete.json" + "TableUpdateEntity": { + "$ref": "./examples/TableUpdateEntity.json" } }, - "description": "Operation permanently deletes the specified table", + "description": "Update entity in a table.", "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, { "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -500,21 +525,18 @@ } } } - } - }, - "/{table}?comp=acl": { - "get": { + }, + "delete": { "tags": [ "table" ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_GetAccessPolicy", - "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "operationId": "Table_DeleteEntity", + "x-ms-examples": { + "TableDeleteEntity": { + "$ref": "./examples/TableDeleteEntity.json" + } + }, + "description": "Deletes the specified entity in a table.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -525,12 +547,24 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "200": { + "204": { "description": "Success.", "headers": { "x-ms-client-request-id": { @@ -553,9 +587,6 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } - }, - "schema": { - "$ref": "#/definitions/SignedIdentifiers" } }, "default": { @@ -571,23 +602,21 @@ } } } - }, - "put": { + } + }, + "/{table}": { + "post": { "tags": [ "table" ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_SetAccessPolicy", - "description": "sets stored access policies for the table that may be used with Shared Access Signatures", + "operationId": "Table_InsertEntity", + "x-ms-examples": { + "TableInsertEntity": { + "$ref": "./examples/TableInsertEntity.json" + } + }, + "description": "Insert entity in a table.", "parameters": [ - { - "$ref": "#/parameters/TableAcl" - }, { "$ref": "#/parameters/Timeout" }, @@ -597,13 +626,22 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, { "$ref": "#/parameters/tableNameParameter" } ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -625,6 +663,9 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } + }, + "schema": { + "$ref": "#/definitions/TableEntityProperties" } }, "default": { @@ -641,58 +682,33 @@ } } }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "acl" - ], - "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" - } - ] - }, - "/{table}()": { "get": { "tags": [ "table" ], - "operationId": "Table_QueryEntities", - "x-ms-examples": { - "TableQueryEntities": { - "$ref": "./examples/TableQueryEntities.json" - } - }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_GetAccessPolicy", + "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "parameters": [ { - "$ref": "#/parameters/formatParameter" + "$ref": "#/parameters/Timeout" }, { - "$ref": "#/parameters/topParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/selectParameter" + "$ref": "#/parameters/ClientRequestId" }, { - "$ref": "#/parameters/filterParameter" + "$ref": "#/parameters/tableNameParameter" }, { - "$ref": "#/parameters/tableNameParameter" + "$ref": "#/parameters/compAclParameter" } ], "responses": { @@ -718,14 +734,10 @@ "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." } }, "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" + "$ref": "#/definitions/SignedIdentifiers" } }, "default": { @@ -741,21 +753,23 @@ } } } - } - }, - "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { - "get": { + }, + "put": { "tags": [ "table" ], - "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", - "x-ms-examples": { - "TableQueryEntitiesWithPartitionAndRowKey": { - "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" - } - }, - "description": "Queries entities in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_SetAccessPolicy", + "description": "sets stored access policies for the table that may be used with Shared Access Signatures", "parameters": [ + { + "$ref": "#/parameters/TableAcl" + }, { "$ref": "#/parameters/Timeout" }, @@ -765,31 +779,16 @@ { "$ref": "#/parameters/ClientRequestId" }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, { "$ref": "#/parameters/tableNameParameter" }, { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" + "$ref": "#/parameters/compAclParameter" } ], "responses": { - "200": { - "description": "Success.", + "204": { + "description": "No Content", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -810,14 +809,7 @@ "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." } - }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" } }, "default": { @@ -833,19 +825,49 @@ } } } - }, + } + } + }, + "x-ms-paths": { + "/?ServiceProperties": { + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to set the storage service properties" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ], + "description": "Required query string to set the storage service properties" + } + ], "put": { "tags": [ - "table" + "service" ], - "operationId": "Table_UpdateEntity", - "x-ms-examples": { - "TableUpdateEntity": { - "$ref": "./examples/TableUpdateEntity.json" - } - }, - "description": "Update entity in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, { "$ref": "#/parameters/Timeout" }, @@ -854,29 +876,11 @@ }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "200": { - "description": "Success.", + "202": { + "description": "Success (Accepted)", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -891,12 +895,7 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." } } }, @@ -914,17 +913,18 @@ } } }, - "delete": { + "get": { "tags": [ - "table" + "service" ], - "operationId": "Table_DeleteEntity", - "x-ms-examples": { - "TableDeleteEntity": { - "$ref": "./examples/TableDeleteEntity.json" - } - }, - "description": "Deletes the specified entity in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -934,25 +934,10 @@ }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "204": { + "200": { "description": "Success.", "headers": { "x-ms-client-request-id": { @@ -968,13 +953,11 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" } }, "default": { @@ -992,18 +975,41 @@ } } }, - "/{table}": { - "post": { + "/?ServiceStats": { + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to get storage service stats" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ], + "description": "Required query string to get storage service stats" + } + ], + "get": { "tags": [ - "table" + "service" ], - "operationId": "Table_InsertEntity", - "x-ms-examples": { - "TableInsertEntity": { - "$ref": "./examples/TableInsertEntity.json" - } - }, - "description": "Insert entity in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -1013,18 +1019,6 @@ }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" } ], "responses": { @@ -1044,7 +1038,7 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, "Date": { "type": "string", @@ -1053,7 +1047,7 @@ } }, "schema": { - "$ref": "#/definitions/TableEntityProperties" + "$ref": "#/definitions/StorageServiceStats" } }, "default": { @@ -1438,7 +1432,7 @@ "type": "string", "description": "Specifies the version of the operation to use for this request.", "enum": [ - "2018-10-10" + "2019-10-10" ] }, "ClientRequestId": { @@ -1526,6 +1520,17 @@ }, "x-ms-client-name": "Filter" }, + "compAclParameter": { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ], + "x-ms-parameter-location": "method", + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + }, "TableAcl": { "name": "tableAcl", "in": "body", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index bea0bc0b555b..f8faba850f82 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -35,36 +35,44 @@ "application/json;odata=fullmetadata" ], "paths": { - "/?restype=service&comp=properties": { - "put": { + "/Tables": { + "get": { "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "table" ], - "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "operationId": "Table_Query", + "x-ms-examples": { + "TableGet": { + "$ref": "./examples/TableGet.json" + } + }, + "description": "Queries tables under the given account.", "parameters": [ { - "$ref": "#/parameters/StorageServiceProperties" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/Timeout" + "$ref": "#/parameters/ClientRequestId" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/DataServiceVersionParameter" }, { - "$ref": "#/parameters/ClientRequestId" + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" } ], "responses": { - "202": { - "description": "Success (Accepted)", + "200": { + "description": "Success, table query completed.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -79,50 +87,55 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableQueryResponse" } } } }, - "get": { + "post": { "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "table" ], - "operationId": "Service_GetProperties", - "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "operationId": "Table_Create", + "x-ms-examples": { + "TableCreate": { + "$ref": "./examples/TableCreate.json" + } + }, + "description": "Creates a new table under the given account.", "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableProperties" } ], "responses": { - "200": { - "description": "Success.", + "201": { + "description": "Success, table created.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -137,11 +150,41 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } }, "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "$ref": "#/definitions/TableResponse" + } + }, + "204": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, "default": { @@ -157,57 +200,34 @@ } } } - }, - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to set the storage service properties" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ], - "description": "Required query string to set the storage service properties" - } - ] + } }, - "/?restype=service&comp=stats": { - "get": { + "/Tables('{table}')": { + "delete": { "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "table" ], - "operationId": "Service_GetStatistics", - "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "operationId": "Table_Delete", + "x-ms-examples": { + "TableDelete": { + "$ref": "./examples/TableDelete.json" + } + }, + "description": "Operation permanently deletes the specified table", "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" } ], "responses": { - "200": { - "description": "Success.", + "204": { + "description": "No Content", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -222,16 +242,13 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, "Date": { "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } - }, - "schema": { - "$ref": "#/definitions/StorageServiceStats" } }, "default": { @@ -247,43 +264,24 @@ } } } - }, - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to get storage service stats" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "stats" - ], - "description": "Required query string to get storage service stats" - } - ] + } }, - "/Tables": { + "/{table}()": { "get": { "tags": [ "table" ], - "operationId": "Table_Query", + "operationId": "Table_QueryEntities", "x-ms-examples": { - "TableGet": { - "$ref": "./examples/TableGet.json" + "TableQueryEntities": { + "$ref": "./examples/TableQueryEntities.json" } }, - "description": "Queries tables under the given account.", + "description": "Queries entities in a table.", "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -304,11 +302,14 @@ }, { "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" } ], "responses": { "200": { - "description": "Success, table query completed.", + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -336,23 +337,40 @@ } }, "schema": { - "$ref": "#/definitions/TableQueryResponse" + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } } } - }, - "post": { + } + }, + "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { + "get": { "tags": [ "table" ], - "operationId": "Table_Create", + "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", "x-ms-examples": { - "TableCreate": { - "$ref": "./examples/TableCreate.json" + "TableQueryEntitiesWithPartitionAndRowKey": { + "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" } }, - "description": "Creates a new table under the given account.", + "description": "Queries entities in a table.", "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -366,12 +384,24 @@ "$ref": "#/parameters/formatParameter" }, { - "$ref": "#/parameters/TableProperties" + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "201": { - "description": "Success, table created.", + "200": { + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -392,35 +422,14 @@ "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/TableResponse" - } - }, - "204": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "Date": { + "x-ms-continuation-NextTableName": { "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "This header contains the continuation token value." } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" } }, "default": { @@ -436,34 +445,50 @@ } } } - } - }, - "/Tables('{table}')": { - "delete": { + }, + "put": { "tags": [ "table" ], - "operationId": "Table_Delete", + "operationId": "Table_UpdateEntity", "x-ms-examples": { - "TableDelete": { - "$ref": "./examples/TableDelete.json" + "TableUpdateEntity": { + "$ref": "./examples/TableUpdateEntity.json" } }, - "description": "Operation permanently deletes the specified table", + "description": "Update entity in a table.", "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, { "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -500,21 +525,18 @@ } } } - } - }, - "/{table}?comp=acl": { - "get": { + }, + "delete": { "tags": [ "table" ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_GetAccessPolicy", - "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "operationId": "Table_DeleteEntity", + "x-ms-examples": { + "TableDeleteEntity": { + "$ref": "./examples/TableDeleteEntity.json" + } + }, + "description": "Deletes the specified entity in a table.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -525,12 +547,24 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, { "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "200": { + "204": { "description": "Success.", "headers": { "x-ms-client-request-id": { @@ -553,9 +587,6 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } - }, - "schema": { - "$ref": "#/definitions/SignedIdentifiers" } }, "default": { @@ -571,23 +602,21 @@ } } } - }, - "put": { + } + }, + "/{table}": { + "post": { "tags": [ "table" ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_SetAccessPolicy", - "description": "sets stored access policies for the table that may be used with Shared Access Signatures", + "operationId": "Table_InsertEntity", + "x-ms-examples": { + "TableInsertEntity": { + "$ref": "./examples/TableInsertEntity.json" + } + }, + "description": "Insert entity in a table.", "parameters": [ - { - "$ref": "#/parameters/TableAcl" - }, { "$ref": "#/parameters/Timeout" }, @@ -597,13 +626,22 @@ { "$ref": "#/parameters/ClientRequestId" }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, { "$ref": "#/parameters/tableNameParameter" } ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "Success.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -625,6 +663,9 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } + }, + "schema": { + "$ref": "#/definitions/TableEntityProperties" } }, "default": { @@ -641,58 +682,33 @@ } } }, - "parameters": [ - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "acl" - ], - "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" - } - ] - }, - "/{table}()": { "get": { "tags": [ "table" ], - "operationId": "Table_QueryEntities", - "x-ms-examples": { - "TableQueryEntities": { - "$ref": "./examples/TableQueryEntities.json" - } - }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_GetAccessPolicy", + "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "parameters": [ { - "$ref": "#/parameters/formatParameter" + "$ref": "#/parameters/Timeout" }, { - "$ref": "#/parameters/topParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/selectParameter" + "$ref": "#/parameters/ClientRequestId" }, { - "$ref": "#/parameters/filterParameter" + "$ref": "#/parameters/tableNameParameter" }, { - "$ref": "#/parameters/tableNameParameter" + "$ref": "#/parameters/compAclParameter" } ], "responses": { @@ -718,14 +734,10 @@ "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." } }, "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" + "$ref": "#/definitions/SignedIdentifiers" } }, "default": { @@ -741,21 +753,23 @@ } } } - } - }, - "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { - "get": { + }, + "put": { "tags": [ "table" ], - "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", - "x-ms-examples": { - "TableQueryEntitiesWithPartitionAndRowKey": { - "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" - } - }, - "description": "Queries entities in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_SetAccessPolicy", + "description": "sets stored access policies for the table that may be used with Shared Access Signatures", "parameters": [ + { + "$ref": "#/parameters/TableAcl" + }, { "$ref": "#/parameters/Timeout" }, @@ -765,31 +779,16 @@ { "$ref": "#/parameters/ClientRequestId" }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, { "$ref": "#/parameters/tableNameParameter" }, { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" + "$ref": "#/parameters/compAclParameter" } ], "responses": { - "200": { - "description": "Success.", + "204": { + "description": "No Content", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -810,14 +809,7 @@ "type": "string", "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." } - }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" } }, "default": { @@ -833,19 +825,49 @@ } } } - }, + } + } + }, + "x-ms-paths": { + "/?ServiceProperties": { + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to set the storage service properties" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ], + "description": "Required query string to set the storage service properties" + } + ], "put": { "tags": [ - "table" + "service" ], - "operationId": "Table_UpdateEntity", - "x-ms-examples": { - "TableUpdateEntity": { - "$ref": "./examples/TableUpdateEntity.json" - } - }, - "description": "Update entity in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, { "$ref": "#/parameters/Timeout" }, @@ -854,29 +876,11 @@ }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "200": { - "description": "Success.", + "202": { + "description": "Success (Accepted)", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -891,12 +895,7 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." } } }, @@ -914,17 +913,18 @@ } } }, - "delete": { + "get": { "tags": [ - "table" + "service" ], - "operationId": "Table_DeleteEntity", - "x-ms-examples": { - "TableDeleteEntity": { - "$ref": "./examples/TableDeleteEntity.json" - } - }, - "description": "Deletes the specified entity in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -934,25 +934,10 @@ }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" } ], "responses": { - "204": { + "200": { "description": "Success.", "headers": { "x-ms-client-request-id": { @@ -968,13 +953,11 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" } }, "default": { @@ -992,18 +975,41 @@ } } }, - "/{table}": { - "post": { + "/?ServiceStats": { + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to get storage service stats" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ], + "description": "Required query string to get storage service stats" + } + ], + "get": { "tags": [ - "table" + "service" ], - "operationId": "Table_InsertEntity", - "x-ms-examples": { - "TableInsertEntity": { - "$ref": "./examples/TableInsertEntity.json" - } - }, - "description": "Insert entity in a table.", + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -1013,18 +1019,6 @@ }, { "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" } ], "responses": { @@ -1044,7 +1038,7 @@ "x-ms-version": { "x-ms-client-name": "Version", "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, "Date": { "type": "string", @@ -1053,7 +1047,7 @@ } }, "schema": { - "$ref": "#/definitions/TableEntityProperties" + "$ref": "#/definitions/StorageServiceStats" } }, "default": { @@ -1526,6 +1520,17 @@ }, "x-ms-client-name": "Filter" }, + "compAclParameter": { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ], + "x-ms-parameter-location": "method", + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + }, "TableAcl": { "name": "tableAcl", "in": "body", diff --git a/specification/cosmos-db/data-plane/readme.md b/specification/cosmos-db/data-plane/readme.md index 822fb36acd7e..5fd0522acbda 100644 --- a/specification/cosmos-db/data-plane/readme.md +++ b/specification/cosmos-db/data-plane/readme.md @@ -54,19 +54,19 @@ input-file: ``` yaml directive: - suppress: D5001 - where: $.paths["/?restype=service&comp=properties"].put + where: $["x-ms-paths"]["/?ServiceProperties"].put reason: The path only supports XML input/outputm which is not supported - suppress: D5001 - where: $.paths["/?restype=service&comp=properties"].get + where: $["x-ms-paths"]["/?ServiceProperties"].get reason: The path only supports XML input/outputm which is not supported - suppress: D5001 - where: $.paths["/?restype=service&comp=stats"].get + where: $["x-ms-paths"]["/?ServiceStats"].get reason: The path only supports XML input/outputm which is not supported - suppress: D5001 - where: $.paths["/{table}?comp=acl"].get + where: $.paths["/{table}"].get reason: The path only supports XML input/outputm which is not supported - suppress: D5001 - where: $.paths["/{table}?comp=acl"].put + where: $.paths["/{table}"].put reason: The path only supports XML input/outputm which is not supported - suppress: R3016 where: $.definitions.StorageError.properties.Message @@ -179,6 +179,12 @@ directive: - suppress: R3016 where: $.definitions.TableEntityQueryResponse.properties["odata.metadata"] reason: Response from service is not camel case + - suppress: R2058 + where: $["x-ms-paths"]["/?ServiceStats"] + reason: Cannot provide operation in "paths" + - suppress: R2058 + where: $["x-ms-paths"]["/?ServiceProperties"] + reason: Cannot provide operation in "paths" ``` --- From 5546ae032ac106956336827068bb60246d7623ca Mon Sep 17 00:00:00 2001 From: Sam Hurd Date: Fri, 17 Jan 2020 15:04:40 -0500 Subject: [PATCH 04/21] add new custom words, fix incorrect api version --- custom-words.txt | 3 +++ .../Microsoft.TablesStorage/preview/2018-10-10/table.json | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 196478d40f1e..3b814d758421 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -542,6 +542,7 @@ Français frontdoor fsaction Fulfilment +fullmetadata Fulltext fullyqualified galician @@ -944,6 +945,7 @@ nodeconfiguration nodecounts Nodeploy nodrm +nometadata nonadmin NONCLUSTERED nonincreasing @@ -1208,6 +1210,7 @@ resourcetype Responsys restoreheartbeat Restproxy +restype resumable resync resynchronization diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json index 4638ef8de3ec..780db478d42e 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure Table Storage", - "version": "2019-10-10", + "version": "2018-10-10", "x-ms-code-generation-settings": { "header": "MIT", "strictSpecAdherence": false @@ -1432,7 +1432,7 @@ "type": "string", "description": "Specifies the version of the operation to use for this request.", "enum": [ - "2019-10-10" + "2018-10-10" ] }, "ClientRequestId": { From f5cb6fb416ae0a06329599db9dc17c8fdd7f95c7 Mon Sep 17 00:00:00 2001 From: Sam Hurd Date: Thu, 13 Feb 2020 16:14:42 -0500 Subject: [PATCH 05/21] making suggested changes to continuation header, response status codes --- .../examples/TableInsertEntity.json | 2 +- .../examples/TableUpdateEntity.json | 2 +- .../preview/2018-10-10/table.json | 24 +++++++++++------ .../examples/TableInsertEntity.json | 2 +- .../examples/TableUpdateEntity.json | 2 +- .../preview/2019-02-02/table.json | 24 +++++++++++------ specification/cosmos-db/data-plane/readme.md | 26 ------------------- 7 files changed, 36 insertions(+), 46 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json index a5f6a814ba79..52bec3cd6161 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json @@ -20,7 +20,7 @@ } }, "responses": { - "200": { + "201": { "body": { "odata.metadata": "https://myaccount.table.core.windows.net/Customer/$metadata#Customers/@Element", "odata.type": "myaccount.Customers", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json index d7853c3e6e27..2a898f51fd21 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json @@ -22,6 +22,6 @@ } }, "responses": { - "200": {} + "204": {} } } diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json index 780db478d42e..04bb78ab1484 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json @@ -29,10 +29,10 @@ "https" ], "consumes": [ - "application/json;odata=fullmetadata" + "application/json;odata=nometadata" ], "produces": [ - "application/json;odata=fullmetadata" + "application/json;odata=nometadata" ], "paths": { "/Tables": { @@ -331,9 +331,13 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" }, - "x-ms-continuation-NextTableName": { + "x-ms-continuation-NextPartitionKey": { "type": "string", - "description": "This header contains the continuation token value." + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." } }, "schema": { @@ -423,9 +427,13 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" }, - "x-ms-continuation-NextTableName": { + "x-ms-continuation-NextPartitionKey": { "type": "string", - "description": "This header contains the continuation token value." + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." } }, "schema": { @@ -487,7 +495,7 @@ } ], "responses": { - "200": { + "204": { "description": "Success.", "headers": { "x-ms-client-request-id": { @@ -640,7 +648,7 @@ } ], "responses": { - "200": { + "201": { "description": "Success.", "headers": { "x-ms-client-request-id": { diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json index 7d8410a9dbf3..c29a9bb05738 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json @@ -20,7 +20,7 @@ } }, "responses": { - "200": { + "201": { "body": { "odata.metadata": "https://myaccount.table.core.windows.net/Customer/$metadata#Customers/@Element", "odata.type": "myaccount.Customers", diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json index c070ff644a6c..24e71afe72fa 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json @@ -22,6 +22,6 @@ } }, "responses": { - "200": {} + "204": {} } } diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index f8faba850f82..7261a0366ca9 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -29,10 +29,10 @@ "https" ], "consumes": [ - "application/json;odata=fullmetadata" + "application/json;odata=nometadata" ], "produces": [ - "application/json;odata=fullmetadata" + "application/json;odata=nometadata" ], "paths": { "/Tables": { @@ -331,9 +331,13 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" }, - "x-ms-continuation-NextTableName": { + "x-ms-continuation-NextPartitionKey": { "type": "string", - "description": "This header contains the continuation token value." + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." } }, "schema": { @@ -423,9 +427,13 @@ "format": "date-time-rfc1123", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" }, - "x-ms-continuation-NextTableName": { + "x-ms-continuation-NextPartitionKey": { "type": "string", - "description": "This header contains the continuation token value." + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." } }, "schema": { @@ -487,7 +495,7 @@ } ], "responses": { - "200": { + "204": { "description": "Success.", "headers": { "x-ms-client-request-id": { @@ -640,7 +648,7 @@ } ], "responses": { - "200": { + "201": { "description": "Success.", "headers": { "x-ms-client-request-id": { diff --git a/specification/cosmos-db/data-plane/readme.md b/specification/cosmos-db/data-plane/readme.md index 5fd0522acbda..4e5de5dea0c2 100644 --- a/specification/cosmos-db/data-plane/readme.md +++ b/specification/cosmos-db/data-plane/readme.md @@ -218,7 +218,6 @@ Please also specify `--python-sdks-folder= Date: Mon, 4 May 2020 17:55:54 -0700 Subject: [PATCH 06/21] Updates to tables spec --- .../preview/2019-02-02/table.json | 3179 +++++++++-------- 1 file changed, 1764 insertions(+), 1415 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 7261a0366ca9..c4b1daac5a9e 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -1,1585 +1,1934 @@ { - "swagger": "2.0", - "info": { - "title": "Azure Table Storage", - "version": "2019-02-02", - "x-ms-code-generation-settings": { - "header": "MIT", - "strictSpecAdherence": false - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{url}", - "useSchemePrefix": false, - "positionInOperation": "first", - "parameters": [ - { - "$ref": "#/parameters/Url" + "swagger": "2.0", + "info": { + "title": "Azure Table Storage", + "version": "2019-02-02", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false } - ] - }, - "securityDefinitions": { - "table_shared_key": { - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json;odata=nometadata" - ], - "produces": [ - "application/json;odata=nometadata" - ], - "paths": { - "/Tables": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_Query", - "x-ms-examples": { - "TableGet": { - "$ref": "./examples/TableGet.json" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "table_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json;odata=nometadata" + ], + "produces": [ + "application/json;odata=minimalmetadata" + ], + "paths": { + "/Tables": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_Query", + "x-ms-examples": { + "TableGet": { + "$ref": "./examples/TableGet.json" + } + }, + "description": "Queries tables under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "name": "NextTableName", + "in": "query", + "required": false, + "type": "string", + "format": "string", + "description": "A table query continuation token from a previous call.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "NextTableName" + } + ], + "responses": { + "200": { + "description": "Success, table query completed.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } + }, + "schema": { + "$ref": "#/definitions/TableQueryResponse" + } + } } }, - "description": "Queries tables under the given account.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/selectParameter" + "post": { + "tags": [ + "table" + ], + "operationId": "Table_Create", + "x-ms-examples": { + "TableCreate": { + "$ref": "./examples/TableCreate.json" + } }, - { - "$ref": "#/parameters/filterParameter" - } - ], - "responses": { - "200": { - "description": "Success, table query completed.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "Creates a new table under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableProperties" + }, + { + "$ref": "#/parameters/PreferParameter" + } + ], + "responses": { + "201": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + } }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." + "schema": { + "$ref": "#/definitions/TableResponse" + } + }, + "204": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + } } }, - "schema": { - "$ref": "#/definitions/TableQueryResponse" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } } }, - "post": { - "tags": [ - "table" - ], - "operationId": "Table_Create", - "x-ms-examples": { - "TableCreate": { - "$ref": "./examples/TableCreate.json" - } - }, - "description": "Creates a new table under the given account.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" + "/Tables('{table}')": { + "delete": { + "tags": [ + "table" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "operationId": "Table_Delete", + "x-ms-examples": { + "TableDelete": { + "$ref": "./examples/TableDelete.json" + } }, - { - "$ref": "#/parameters/TableProperties" - } - ], - "responses": { - "201": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + "description": "Operation permanently deletes the specified table", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" }, - "schema": { - "$ref": "#/definitions/TableResponse" + { + "$ref": "#/parameters/tableNameParameter" } - }, - "204": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "schema": { + "$ref": "#/definitions/StorageError" } } + } + } + }, + "/{table}()": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntities", + "x-ms-examples": { + "TableQueryEntities": { + "$ref": "./examples/TableQueryEntities.json" + } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "name": "NextPartitionKey", + "in": "query", + "required": false, + "type": "string", + "format": "string", + "description": "An entity query continuation token from a previous call.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "NextPartitionKey" + }, + { + "name": "NextRowKey", + "in": "query", + "required": false, + "type": "string", + "format": "string", + "description": "An entity query continuation token from a previous call.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "NextRowKey" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextPartitionKey": { + "type": "string", + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." + } + }, + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } } - } - }, - "/Tables('{table}')": { - "delete": { - "tags": [ - "table" - ], - "operationId": "Table_Delete", - "x-ms-examples": { - "TableDelete": { - "$ref": "./examples/TableDelete.json" - } - }, - "description": "Operation permanently deletes the specified table", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" + }, + "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", + "x-ms-examples": { + "TableQueryEntitiesWithPartitionAndRowKey": { + "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" + } }, - { - "$ref": "#/parameters/tableNameParameter" - } - ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextPartitionKey": { + "type": "string", + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." + } }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "schema": { + "$ref": "#/definitions/StorageError" } } + } + }, + "put": { + "tags": [ + "table" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "operationId": "Table_UpdateEntity", + "x-ms-examples": { + "TableUpdateEntity": { + "$ref": "./examples/TableUpdateEntity.json" + } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "description": "Update entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "format": "string", + "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "IfMatch" + } + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } - } - } - }, - "/{table}()": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_QueryEntities", - "x-ms-examples": { - "TableQueryEntities": { - "$ref": "./examples/TableQueryEntities.json" - } }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" + "patch": { + "tags": [ + "table" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "operationId": "Table_MergeEntity", + "x-ms-examples": { + "TableMergeEntity": { + "$ref": "./examples/TableMergeEntity.json" + } }, - { - "$ref": "#/parameters/tableNameParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextPartitionKey": { - "type": "string", - "description": "This header contains the continuation token value for partition key." - }, - "x-ms-continuation-NextRowKey": { - "type": "string", - "description": "This header contains the continuation token value for row key." - } + "description": "Merge entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "format": "string", + "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "IfMatch" } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } - } - } - }, - "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", - "x-ms-examples": { - "TableQueryEntitiesWithPartitionAndRowKey": { - "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" - } }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" + "delete": { + "tags": [ + "table" + ], + "operationId": "Table_DeleteEntity", + "x-ms-examples": { + "TableDeleteEntity": { + "$ref": "./examples/TableDeleteEntity.json" + } }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextPartitionKey": { - "type": "string", - "description": "This header contains the continuation token value for partition key." - }, - "x-ms-continuation-NextRowKey": { - "type": "string", - "description": "This header contains the continuation token value for row key." - } + "description": "Deletes the specified entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "format": "string", + "description": "Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).", + "x-ms-parameter-location": "method", + "x-ms-client-name": "IfMatch" } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } } }, - "put": { - "tags": [ - "table" - ], - "operationId": "Table_UpdateEntity", - "x-ms-examples": { - "TableUpdateEntity": { - "$ref": "./examples/TableUpdateEntity.json" - } - }, - "description": "Update entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" + "/{table}": { + "post": { + "tags": [ + "table" + ], + "operationId": "Table_InsertEntity", + "x-ms-examples": { + "TableInsertEntity": { + "$ref": "./examples/TableInsertEntity.json" + } }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "description": "Insert entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/PreferParameter" + } + ], + "responses": { + "201": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + }, + "Content-Type": { + "type": "string", + "format": "string", + "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." + } }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "schema": { + "$ref": "#/definitions/TableEntityProperties" } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + }, + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + }, + "Content-Type": { + "type": "string", + "format": "string", + "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." + } + }, + "schema": { + "$ref": "#/definitions/TableEntityProperties" } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } - } - }, - "delete": { - "tags": [ - "table" - ], - "operationId": "Table_DeleteEntity", - "x-ms-examples": { - "TableDeleteEntity": { - "$ref": "./examples/TableDeleteEntity.json" - } }, - "description": "Deletes the specified entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + "get": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_GetAccessPolicy", + "description": "Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/compAclParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "schema": { + "$ref": "#/definitions/StorageError" } } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + } + }, + "put": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_SetAccessPolicy", + "description": "sets stored access policies for the table that may be used with Shared Access Signatures", + "parameters": [ + { + "$ref": "#/parameters/TableAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/compAclParameter" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } } } }, - "/{table}": { - "post": { - "tags": [ - "table" - ], - "operationId": "Table_InsertEntity", - "x-ms-examples": { - "TableInsertEntity": { - "$ref": "./examples/TableInsertEntity.json" - } - }, - "description": "Insert entity in a table.", + "x-ms-paths": { + "/?ServiceProperties": { "parameters": [ { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to set the storage service properties" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ], + "description": "Required query string to set the storage service properties" } ], - "responses": { - "201": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "put": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + }, + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" }, - "schema": { - "$ref": "#/definitions/TableEntityProperties" + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" } }, - "schema": { - "$ref": "#/definitions/StorageError" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } } }, - "get": { - "tags": [ - "table" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_GetAccessPolicy", - "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", + "/?ServiceStats": { "parameters": [ { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/compAclParameter" + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to get storage service stats" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ], + "description": "Required query string to get storage service stats" } ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "schema": { + "$ref": "#/definitions/StorageServiceStats" } }, - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } + } + } + } + } + }, + "definitions": { + "StorageError": { + "type": "object", + "xml": {}, + "properties": { + "Message": { + "type": "string", + "xml":{ + "name": "Message" + } + } + } + }, + "StorageServiceProperties": { + "description": "Storage Service Properties.", + "type": "object", + "properties": { + "Logging": { + "description": "Azure Analytics Logging settings", + "$ref": "#/definitions/Logging" + }, + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for tables", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "A summary of request statistics grouped by API in minute aggregates for tables.", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" }, - "schema": { - "$ref": "#/definitions/StorageError" + "xml": { + "wrapped": true, + "name": "Cors" } } } }, - "put": { - "tags": [ - "table" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "Logging": { + "xml": { + "name": "Logging" + }, + "description": "Azure Analytics Logging settings.", + "type": "object", + "required": [ + "Version", + "Delete", + "Read", + "Write", + "RetentionPolicy" ], - "operationId": "Table_SetAccessPolicy", - "description": "sets stored access policies for the table that may be used with Shared Access Signatures", - "parameters": [ - { - "$ref": "#/parameters/TableAcl" - }, - { - "$ref": "#/parameters/Timeout" + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string", + "xml": { + "name": "Version" + } }, - { - "$ref": "#/parameters/ApiVersionParameter" + "Delete": { + "description": "Indicates whether all delete requests should be logged.", + "type": "boolean", + "xml": { + "name": "Delete" + } }, - { - "$ref": "#/parameters/ClientRequestId" + "Read": { + "description": "Indicates whether all read requests should be logged.", + "type": "boolean", + "xml": { + "name": "Read" + } }, - { - "$ref": "#/parameters/tableNameParameter" + "Write": { + "description": "Indicates whether all write requests should be logged.", + "type": "boolean", + "xml": { + "name": "Write" + } }, - { - "$ref": "#/parameters/compAclParameter" + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" } + } + }, + "Metrics": { + "xml": {}, + "description": "", + "required": [ + "Enabled" ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string", + "xml": { + "name": "Version" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" + "Enabled": { + "description": "Indicates whether metrics are enabled for the Table service.", + "type": "boolean", + "xml": { + "name": "Enabled" } + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean", + "xml": { + "name": "IncludeAPIs" + } + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" } } - } - } - }, - "x-ms-paths": { - "/?ServiceProperties": { - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to set the storage service properties" + }, + "CorsRule": { + "xml": { + "name": "CorsRule" }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ], - "description": "Required query string to set the storage service properties" - } - ], - "put": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" ], - "produces": [ - "application/xml" - ], - "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", - "parameters": [ - { - "$ref": "#/parameters/StorageServiceProperties" + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string", + "xml": { + "name": "AllowedOrigins" + } }, - { - "$ref": "#/parameters/Timeout" + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string", + "xml": { + "name": "AllowedMethods" + } }, - { - "$ref": "#/parameters/ApiVersionParameter" + "AllowedHeaders": { + "description": "the request headers that the origin domain may specify on the CORS request.", + "type": "string", + "xml": { + "name": "AllowedHeaders" + } }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "202": { - "description": "Success (Accepted)", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "type": "string", + "xml": { + "name": "ExposedHeaders" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0, + "xml": { + "name": "MaxAgeInSeconds" } } } }, - "get": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" + "RetentionPolicy": { + "xml": { + "name": "RetentionPolicy" + }, + "description": "the retention policy", + "type": "object", + "required": [ + "Enabled" ], - "operationId": "Service_GetProperties", - "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the storage service", + "type": "boolean", + "xml": { + "name": "Enabled" + } }, - { - "$ref": "#/parameters/ClientRequestId" + "Days": { + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "type": "integer", + "minimum": 1, + "xml": { + "name": "Days" + } + } + } + }, + "StorageServiceStats": { + "xml": {}, + "description": "Stats for the storage service.", + "type": "object", + "properties": { + "GeoReplication": { + "description": "Geo-Replication information for the Secondary Storage Service", + "$ref": "#/definitions/GeoReplication" } + } + }, + "GeoReplication": { + "xml": { + "name": "GeoReplication" + }, + "type": "object", + "required": [ + "Status", + "LastSyncTime" ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } + "properties": { + "Status": { + "description": "The status of the secondary location", + "type": "string", + "enum": [ + "live", + "bootstrap", + "unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatusType", + "modelAsString": true }, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "xml": { + "name": "Status" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" + "LastSyncTime": { + "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", + "type": "string", + "format": "date-time-rfc1123", + "xml": { + "name": "LastSyncTime" } } } - } - }, - "/?ServiceStats": { - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to get storage service stats" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "stats" - ], - "description": "Required query string to get storage service stats" + }, + "TableProperties": { + "description": "The properties for creating a table.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table to create.", + "type": "string" + } } - ], - "get": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_GetStatistics", - "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, + }, + "TableResponse": { + "description": "The response for a single table.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + } + }, + "allOf": [ { - "$ref": "#/parameters/ClientRequestId" + "$ref": "#/definitions/TableResponseProperties" } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/StorageServiceStats" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" + ] + }, + "TableQueryResponse": { + "description": "The properties for the table query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of tables.", + "type": "array", + "items": { + "$ref": "#/definitions/TableResponseProperties" } } } - } - } - }, - "definitions": { - "StorageError": { - "type": "object", - "properties": { - "Message": { - "type": "string" + }, + "TableResponseProperties": { + "description": "The properties for the table response.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table.", + "type": "string" + }, + "odata.type": { + "description": "The odata type of the table.", + "type": "string" + }, + "odata.id": { + "description": "The id of the table.", + "type": "string" + }, + "odata.editLink": { + "description": "The edit link of the table.", + "type": "string" + } } - } - }, - "StorageServiceProperties": { - "description": "Storage Service Properties.", - "type": "object", - "properties": { - "Logging": { - "description": "Azure Analytics Logging settings", - "$ref": "#/definitions/Logging" - }, - "HourMetrics": { - "description": "A summary of request statistics grouped by API in hourly aggregates for queues", - "$ref": "#/definitions/Metrics" - }, - "MinuteMetrics": { - "description": "a summary of request statistics grouped by API in minute aggregates for queues", - "$ref": "#/definitions/Metrics" + }, + "SignedIdentifier": { + "xml": { + "name": "SignedIdentifier" }, - "Cors": { - "description": "The set of CORS rules.", - "type": "array", - "items": { - "$ref": "#/definitions/CorsRule", + "description": "signed identifier", + "type": "object", + "required": [ + "Id", + "AccessPolicy" + ], + "properties": { + "Id": { + "type": "string", + "description": "a unique id", "xml": { - "name": "CorsRule" + "name": "Id" } }, - "xml": { - "wrapped": true + "AccessPolicy": { + "description": "The access policy", + "$ref": "#/definitions/AccessPolicy" } } - } - }, - "Logging": { - "description": "Azure Analytics Logging settings.", - "type": "object", - "required": [ - "Version", - "Delete", - "Read", - "Write", - "RetentionPolicy" - ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string" - }, - "Delete": { - "description": "Indicates whether all delete requests should be logged.", - "type": "boolean" - }, - "Read": { - "description": "Indicates whether all read requests should be logged.", - "type": "boolean" - }, - "Write": { - "description": "Indicates whether all write requests should be logged.", - "type": "boolean" - }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" - } - } - }, - "Metrics": { - "description": "", - "required": [ - "Enabled" - ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string" - }, - "Enabled": { - "description": "Indicates whether metrics are enabled for the Queue service.", - "type": "boolean" - }, - "IncludeAPIs": { - "description": "Indicates whether metrics should generate summary statistics for called API operations.", - "type": "boolean" - }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" - } - } - }, - "CorsRule": { - "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", - "type": "object", - "required": [ - "AllowedOrigins", - "AllowedMethods", - "AllowedHeaders", - "ExposedHeaders", - "MaxAgeInSeconds" - ], - "properties": { - "AllowedOrigins": { - "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", - "type": "string" - }, - "AllowedMethods": { - "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", - "type": "string" - }, - "AllowedHeaders": { - "description": "the request headers that the origin domain may specify on the CORS request.", - "type": "string" - }, - "ExposedHeaders": { - "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", - "type": "string" - }, - "MaxAgeInSeconds": { - "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", - "type": "integer", - "minimum": 0 - } - } - }, - "RetentionPolicy": { - "description": "the retention policy", - "type": "object", - "required": [ - "Enabled" - ], - "properties": { - "Enabled": { - "description": "Indicates whether a retention policy is enabled for the storage service", - "type": "boolean" - }, - "Days": { - "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", - "type": "integer", - "minimum": 1 - } - } - }, - "StorageServiceStats": { - "description": "Stats for the storage service.", - "type": "object", - "properties": { - "GeoReplication": { - "description": "Geo-Replication information for the Secondary Storage Service", - "$ref": "#/definitions/GeoReplication" - } - } - }, - "GeoReplication": { - "type": "object", - "required": [ - "Status", - "LastSyncTime" - ], - "properties": { - "Status": { - "description": "The status of the secondary location", - "type": "string", - "enum": [ - "live", - "bootstrap", - "unavailable" - ], - "x-ms-enum": { - "name": "GeoReplicationStatusType", - "modelAsString": true + }, + "SignedIdentifiers": { + "description": "a collection of signed identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" } }, - "LastSyncTime": { - "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", - "type": "string", - "format": "date-time-rfc1123" - } - } - }, - "TableProperties": { - "description": "The properties for creating a table.", - "type": "object", - "properties": { - "TableName": { - "description": "The name of the table to create.", - "type": "string" - } - } - }, - "TableResponse": { - "description": "The response for a single table.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" } }, - "allOf": [ - { - "$ref": "#/definitions/TableResponseProperties" + "AccessPolicy": { + "xml": {"name": "AccessPolicy"}, + "type": "object", + "required": [ + "Start", + "Expiry", + "Permission" + ], + "description": "An Access policy", + "properties": { + "Start": { + "description": "the date-time the policy is active", + "type": "string", + "format": "date-time", + "xml": { + "name": "Start" + } + }, + "Expiry": { + "description": "the date-time the policy expires", + "type": "string", + "format": "date-time", + "xml": { + "name": "Expiry" + } + }, + "Permission": { + "description": "the permissions for the acl policy", + "type": "string", + "xml": { + "name": "Permission" + } + } } - ] - }, - "TableQueryResponse": { - "description": "The properties for the table query response.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" - }, - "value": { - "description": "List of tables.", - "type": "array", - "items": { - "$ref": "#/definitions/TableResponseProperties" + }, + "TableEntityQueryResponse": { + "description": "The properties for the table entity query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of table entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TableEntityProperties" + } } } + }, + "TableEntityProperties": { + "description": "The other properties of the table entity", + "type": "object", + "additionalProperties": true } }, - "TableResponseProperties": { - "description": "The properties for the table response.", - "type": "object", - "properties": { - "TableName": { - "description": "The name of the table.", - "type": "string" - }, - "odata.type": { - "description": "The odata type of the table.", - "type": "string" + "parameters": { + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "description": "The URL of the service account or table that is the targe of the desired operation.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StorageServiceProperties": { + "name": "storageServiceProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" }, - "odata.id": { - "description": "The id of the table.", - "type": "string" + "x-ms-parameter-location": "method", + "description": "The StorageService properties." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The timeout parameter is expressed in seconds." + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2019-02-02" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "DataServiceVersionParameter": { + "name": "DataServiceVersion", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the data service version", + "x-ms-parameter-location": "method", + "enum": [ + "3.0" + ] + }, + "TableProperties": { + "name": "tableProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableProperties" }, - "odata.editLink": { - "description": "The edit link of the table.", - "type": "string" - } - } - }, - "SignedIdentifier": { - "description": "signed identifier", - "type": "object", - "required": [ - "Id", - "AccessPolicy" - ], - "properties": { - "Id": { - "type": "string", - "description": "a unique id" + "x-ms-parameter-location": "method", + "description": "The Table properties." + }, + "formatParameter": { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the media type for the response", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "AccessPolicy": { - "description": "The access policy", - "$ref": "#/definitions/AccessPolicy" - } - } - }, - "SignedIdentifiers": { - "description": "a collection of signed identifiers", - "type": "array", - "items": { - "$ref": "#/definitions/SignedIdentifier", - "xml": { - "name": "SignedIdentifier" + "x-ms-client-name": "Format", + "enum": [ + "application/json;odata=nometadata", + "application/json;odata=minimalmetadata", + "application/json;odata=fullmetadata" + ], + "x-ms-enum": { + "name": "OdataMetadataFormat", + "modelAsString": true } }, - "xml": { - "wrapped": true, - "name": "SignedIdentifiers" - } - }, - "AccessPolicy": { - "type": "object", - "required": [ - "Start", - "Expiry", - "Permission" - ], - "description": "An Access policy", - "properties": { - "Start": { - "description": "the date-time the policy is active", - "type": "string", - "format": "date-time" + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "Expiry": { - "description": "the date-time the policy expires", - "type": "string", - "format": "date-time" - }, - "Permission": { - "description": "the permissions for the acl policy", - "type": "string" - } - } - }, - "TableEntityQueryResponse": { - "description": "The properties for the table entity query response.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" + "x-ms-client-name": "Top" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "value": { - "description": "List of table entities.", - "type": "array", - "items": { - "$ref": "#/definitions/TableEntityProperties" - } - } - } - }, - "TableEntityProperties": { - "description": "The other properties of the table entity", - "type": "object", - "additionalProperties": true - } - }, - "parameters": { - "Url": { - "name": "url", - "x-ms-parameter-location": "client", - "description": "The URL of the service account or table that is the targe of the desired operation.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "StorageServiceProperties": { - "name": "storageServiceProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "x-ms-client-name": "Select" }, - "x-ms-parameter-location": "method", - "description": "The StorageService properties." - }, - "Timeout": { - "name": "timeout", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "x-ms-parameter-location": "method", - "description": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations." - }, - "ApiVersionParameter": { - "name": "x-ms-version", - "x-ms-parameter-location": "client", - "x-ms-client-name": "version", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the version of the operation to use for this request.", - "enum": [ - "2019-02-02" - ] - }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "requestId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." - }, - "DataServiceVersionParameter": { - "name": "DataServiceVersion", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the data service version", - "x-ms-parameter-location": "method", - "enum": [ - "3.0" - ] - }, - "TableProperties": { - "name": "tableProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TableProperties" + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" }, - "x-ms-parameter-location": "method", - "description": "The Table properties." - }, - "formatParameter": { - "name": "$format", - "in": "query", - "required": false, - "type": "string", - "description": "Specifies the media type for the response", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "PreferParameter": { + "name": "Prefer", + "in": "header", + "required": false, + "type": "string", + "description": "Specifies whether the response should include the inserted entity in the payload. Possible values are return-no-content and return-content.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "ResponsePreference", + "enum": [ + "return-no-content", + "return-content" + ], + "x-ms-enum": { + "name": "ResponseFormat", + "modelAsString": true + } }, - "x-ms-client-name": "Format", - "enum": [ - "application/json;odata=nometadata", - "application/json;odata=minimalmetadata", - "application/json;odata=fullmetadata" - ] - }, - "topParameter": { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "Maximum number of records to return.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "compAclParameter": { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ], + "x-ms-parameter-location": "method", + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" }, - "x-ms-client-name": "Top" - }, - "selectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "TableAcl": { + "name": "tableAcl", + "in": "body", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method", + "description": "the acls for the table" }, - "x-ms-client-name": "Select" - }, - "filterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "TableEntityProperties": { + "name": "tableEntityProperties", + "in": "body", + "schema": { + "$ref": "#/definitions/TableEntityProperties" + }, + "x-ms-parameter-location": "method", + "description": "The properties for the table entity" }, - "x-ms-client-name": "Filter" - }, - "compAclParameter": { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "acl" - ], - "x-ms-parameter-location": "method", - "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" - }, - "TableAcl": { - "name": "tableAcl", - "in": "body", - "schema": { - "$ref": "#/definitions/SignedIdentifiers" + "tableNameParameter": { + "name": "table", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the table" }, - "x-ms-parameter-location": "method", - "description": "the acls for the table" - }, - "TableEntityProperties": { - "name": "tableEntityProperties", - "in": "body", - "schema": { - "$ref": "#/definitions/TableEntityProperties" + "partitionKeyParameter": { + "name": "partitionKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The partition key of the entity" }, - "x-ms-parameter-location": "method", - "description": "The properties for the table entity" - }, - "tableNameParameter": { - "name": "table", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The name of the table" - }, - "partitionKeyParameter": { - "name": "partitionKey", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The partition key of the entity" - }, - "rowKeyParameter": { - "name": "rowKey", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The row key of the entity" + "rowKeyParameter": { + "name": "rowKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The row key of the entity" + } } } -} + From ad4d117c4e64edaec84253e89f31d13216885271 Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 07:58:50 -0700 Subject: [PATCH 07/21] Fixed indentation --- .../preview/2019-02-02/table.json | 3505 ++++++++--------- 1 file changed, 1752 insertions(+), 1753 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index c4b1daac5a9e..6642aa85d99e 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -1,1934 +1,1933 @@ { - "swagger": "2.0", - "info": { - "title": "Azure Table Storage", - "version": "2019-02-02", - "x-ms-code-generation-settings": { - "header": "MIT", - "strictSpecAdherence": false - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{url}", - "useSchemePrefix": false, - "positionInOperation": "first", - "parameters": [ - { - "$ref": "#/parameters/Url" - } - ] - }, - "securityDefinitions": { - "table_shared_key": { - "type": "apiKey", - "name": "Authorization", - "in": "header" + "swagger": "2.0", + "info": { + "title": "Azure Table Storage", + "version": "2019-02-02", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" } - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json;odata=nometadata" - ], - "produces": [ - "application/json;odata=minimalmetadata" - ], - "paths": { - "/Tables": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_Query", - "x-ms-examples": { - "TableGet": { - "$ref": "./examples/TableGet.json" - } + ] + }, + "securityDefinitions": { + "table_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json;odata=nometadata" + ], + "produces": [ + "application/json;odata=minimalmetadata" + ], + "paths": { + "/Tables": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_Query", + "x-ms-examples": { + "TableGet": { + "$ref": "./examples/TableGet.json" + } + }, + "description": "Queries tables under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" }, - "description": "Queries tables under the given account.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/selectParameter" + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "name": "NextTableName", + "in": "query", + "required": false, + "type": "string", + "format": "string", + "description": "A table query continuation token from a previous call.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "NextTableName" + } + ], + "responses": { + "200": { + "description": "Success, table query completed.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextTableName": { + "type": "string", + "description": "This header contains the continuation token value." + } }, - { - "$ref": "#/parameters/filterParameter" + "schema": { + "$ref": "#/definitions/TableQueryResponse" + } + } + } + }, + "post": { + "tags": [ + "table" + ], + "operationId": "Table_Create", + "x-ms-examples": { + "TableCreate": { + "$ref": "./examples/TableCreate.json" + } + }, + "description": "Creates a new table under the given account.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableProperties" + }, + { + "$ref": "#/parameters/PreferParameter" + } + ], + "responses": { + "201": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + } }, - { - "name": "NextTableName", - "in": "query", - "required": false, - "type": "string", - "format": "string", - "description": "A table query continuation token from a previous call.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "NextTableName" + "schema": { + "$ref": "#/definitions/TableResponse" } - ], - "responses": { - "200": { - "description": "Success, table query completed.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." - } + }, + "204": { + "description": "Success, table created.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "schema": { - "$ref": "#/definitions/TableQueryResponse" + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." } } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + } + }, + "/Tables('{table}')": { + "delete": { + "tags": [ + "table" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "operationId": "Table_Delete", + "x-ms-examples": { + "TableDelete": { + "$ref": "./examples/TableDelete.json" } }, - "post": { - "tags": [ - "table" - ], - "operationId": "Table_Create", - "x-ms-examples": { - "TableCreate": { - "$ref": "./examples/TableCreate.json" + "description": "Operation permanently deletes the specified table", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, - "description": "Creates a new table under the given account.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableProperties" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - { - "$ref": "#/parameters/PreferParameter" + "schema": { + "$ref": "#/definitions/StorageError" } - ], - "responses": { - "201": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "Preference-Applied": { - "type": "string", - "format": "string", - "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." - } + } + } + } + }, + "/{table}()": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntities", + "x-ms-examples": { + "TableQueryEntities": { + "$ref": "./examples/TableQueryEntities.json" + } + }, + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "name": "NextPartitionKey", + "in": "query", + "required": false, + "type": "string", + "format": "string", + "description": "An entity query continuation token from a previous call.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "NextPartitionKey" + }, + { + "name": "NextRowKey", + "in": "query", + "required": false, + "type": "string", + "format": "string", + "description": "An entity query continuation token from a previous call.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "NextRowKey" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "schema": { - "$ref": "#/definitions/TableResponse" + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextPartitionKey": { + "type": "string", + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." } }, - "204": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "Preference-Applied": { - "type": "string", - "format": "string", - "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." - } + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } } - }, - "/Tables('{table}')": { - "delete": { - "tags": [ - "table" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "operationId": "Table_Delete", - "x-ms-examples": { - "TableDelete": { - "$ref": "./examples/TableDelete.json" - } + } + }, + "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { + "get": { + "tags": [ + "table" + ], + "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", + "x-ms-examples": { + "TableQueryEntitiesWithPartitionAndRowKey": { + "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" + } + }, + "description": "Queries entities in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" }, - "description": "Operation permanently deletes the specified table", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "x-ms-continuation-NextPartitionKey": { + "type": "string", + "description": "This header contains the continuation token value for partition key." + }, + "x-ms-continuation-NextRowKey": { + "type": "string", + "description": "This header contains the continuation token value for row key." + } }, - { - "$ref": "#/parameters/tableNameParameter" + "schema": { + "$ref": "#/definitions/TableEntityQueryResponse" } - ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } } }, - "/{table}()": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_QueryEntities", - "x-ms-examples": { - "TableQueryEntities": { - "$ref": "./examples/TableQueryEntities.json" + "put": { + "tags": [ + "table" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "operationId": "Table_UpdateEntity", + "x-ms-examples": { + "TableUpdateEntity": { + "$ref": "./examples/TableUpdateEntity.json" + } + }, + "description": "Update entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "format": "string", + "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "IfMatch" + } + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "name": "NextPartitionKey", - "in": "query", - "required": false, - "type": "string", - "format": "string", - "description": "An entity query continuation token from a previous call.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "NextPartitionKey" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } }, - { - "name": "NextRowKey", - "in": "query", - "required": false, - "type": "string", - "format": "string", - "description": "An entity query continuation token from a previous call.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "NextRowKey" + "schema": { + "$ref": "#/definitions/StorageError" } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextPartitionKey": { - "type": "string", - "description": "This header contains the continuation token value for partition key." - }, - "x-ms-continuation-NextRowKey": { - "type": "string", - "description": "This header contains the continuation token value for row key." - } + } + } + }, + "patch": { + "tags": [ + "table" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "operationId": "Table_MergeEntity", + "x-ms-examples": { + "TableMergeEntity": { + "$ref": "./examples/TableMergeEntity.json" + } + }, + "description": "Merge entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "format": "string", + "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "IfMatch" + } + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } } }, - "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", - "x-ms-examples": { - "TableQueryEntitiesWithPartitionAndRowKey": { - "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" - } + "delete": { + "tags": [ + "table" + ], + "operationId": "Table_DeleteEntity", + "x-ms-examples": { + "TableDeleteEntity": { + "$ref": "./examples/TableDeleteEntity.json" + } + }, + "description": "Deletes the specified entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "ETag": { - "type": "string", - "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextPartitionKey": { - "type": "string", - "description": "This header contains the continuation token value for partition key." - }, - "x-ms-continuation-NextRowKey": { - "type": "string", - "description": "This header contains the continuation token value for row key." - } + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/partitionKeyParameter" + }, + { + "$ref": "#/parameters/rowKeyParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "format": "string", + "description": "Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).", + "x-ms-parameter-location": "method", + "x-ms-client-name": "IfMatch" + } + ], + "responses": { + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "schema": { - "$ref": "#/definitions/StorageError" + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } } - } - }, - "put": { - "tags": [ - "table" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "operationId": "Table_UpdateEntity", - "x-ms-examples": { - "TableUpdateEntity": { - "$ref": "./examples/TableUpdateEntity.json" - } }, - "description": "Update entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "format": "string", - "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "IfMatch" - } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "ETag": { - "type": "string", - "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } + } + } + }, + "/{table}": { + "post": { + "tags": [ + "table" + ], + "operationId": "Table_InsertEntity", + "x-ms-examples": { + "TableInsertEntity": { + "$ref": "./examples/TableInsertEntity.json" + } }, - "patch": { - "tags": [ - "table" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "operationId": "Table_MergeEntity", - "x-ms-examples": { - "TableMergeEntity": { - "$ref": "./examples/TableMergeEntity.json" - } + "description": "Insert entity in a table.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" }, - "description": "Merge entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "format": "string", - "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "IfMatch" - } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "ETag": { - "type": "string", - "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DataServiceVersionParameter" + }, + { + "$ref": "#/parameters/formatParameter" + }, + { + "$ref": "#/parameters/TableEntityProperties" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/PreferParameter" + } + ], + "responses": { + "201": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" }, - "schema": { - "$ref": "#/definitions/StorageError" + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + }, + "Content-Type": { + "type": "string", + "format": "string", + "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." } - } - } - }, - "delete": { - "tags": [ - "table" - ], - "operationId": "Table_DeleteEntity", - "x-ms-examples": { - "TableDeleteEntity": { - "$ref": "./examples/TableDeleteEntity.json" + }, + "schema": { + "$ref": "#/definitions/TableEntityProperties" } }, - "description": "Deletes the specified entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" + "204": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "ETag": { + "type": "string", + "format": "string", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + }, + "Preference-Applied": { + "type": "string", + "format": "string", + "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." + }, + "Content-Type": { + "type": "string", + "format": "string", + "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." + } }, - { - "name": "If-Match", - "in": "header", - "required": true, - "type": "string", - "format": "string", - "description": "Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).", - "x-ms-parameter-location": "method", - "x-ms-client-name": "IfMatch" + "schema": { + "$ref": "#/definitions/TableEntityProperties" } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } } }, - "/{table}": { - "post": { - "tags": [ - "table" - ], - "operationId": "Table_InsertEntity", - "x-ms-examples": { - "TableInsertEntity": { - "$ref": "./examples/TableInsertEntity.json" - } + "get": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_GetAccessPolicy", + "description": "Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" }, - "description": "Insert entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/PreferParameter" - } - ], - "responses": { - "201": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "ETag": { - "type": "string", - "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "Preference-Applied": { - "type": "string", - "format": "string", - "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." - }, - "Content-Type": { - "type": "string", - "format": "string", - "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." - } - }, - "schema": { - "$ref": "#/definitions/TableEntityProperties" - } - }, - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "ETag": { - "type": "string", - "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "Preference-Applied": { - "type": "string", - "format": "string", - "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." - }, - "Content-Type": { - "type": "string", - "format": "string", - "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." - } - }, - "schema": { - "$ref": "#/definitions/TableEntityProperties" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/compAclParameter" } - }, - "get": { - "tags": [ - "table" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_GetAccessPolicy", - "description": "Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/compAclParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." }, - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." }, - "schema": { - "$ref": "#/definitions/StorageError" + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" } - } - } - }, - "put": { - "tags": [ - "table" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_SetAccessPolicy", - "description": "sets stored access policies for the table that may be used with Shared Access Signatures", - "parameters": [ - { - "$ref": "#/parameters/TableAcl" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/compAclParameter" + "schema": { + "$ref": "#/definitions/SignedIdentifiers" } - ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } } - } - }, - "x-ms-paths": { - "/?ServiceProperties": { + }, + "put": { + "tags": [ + "table" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Table_SetAccessPolicy", + "description": "sets stored access policies for the table that may be used with Shared Access Signatures", "parameters": [ { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to set the storage service properties" + "$ref": "#/parameters/TableAcl" }, { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ], - "description": "Required query string to set the storage service properties" + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "#/parameters/compAclParameter" } ], - "put": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", - "parameters": [ - { - "$ref": "#/parameters/StorageServiceProperties" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" + "responses": { + "204": { + "description": "No Content", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } } - ], - "responses": { - "202": { - "description": "Success (Accepted)", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } - }, - "get": { - "tags": [ + } + } + } + }, + "x-ms-paths": { + "/?ServiceProperties": { + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ "service" ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_GetProperties", - "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } + "description": "Required query string to set the storage service properties" + }, + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } + "description": "Required query string to set the storage service properties" + } + ], + "put": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." }, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } + "schema": { + "$ref": "#/definitions/StorageError" } } } }, - "/?ServiceStats": { + "get": { + "tags": [ + "service" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetProperties", + "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", "parameters": [ { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to get storage service stats" + "$ref": "#/parameters/Timeout" }, { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "stats" - ], - "description": "Required query string to get storage service stats" + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" } ], - "get": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_GetStatistics", - "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." }, - "schema": { - "$ref": "#/definitions/StorageServiceStats" + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." } }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" } + }, + "schema": { + "$ref": "#/definitions/StorageError" } } } } }, - "definitions": { - "StorageError": { - "type": "object", - "xml": {}, - "properties": { - "Message": { - "type": "string", - "xml":{ - "name": "Message" - } - } - } - }, - "StorageServiceProperties": { - "description": "Storage Service Properties.", - "type": "object", - "properties": { - "Logging": { - "description": "Azure Analytics Logging settings", - "$ref": "#/definitions/Logging" - }, - "HourMetrics": { - "description": "A summary of request statistics grouped by API in hourly aggregates for tables", - "$ref": "#/definitions/Metrics" - }, - "MinuteMetrics": { - "description": "A summary of request statistics grouped by API in minute aggregates for tables.", - "$ref": "#/definitions/Metrics" - }, - "Cors": { - "description": "The set of CORS rules.", - "type": "array", - "items": { - "$ref": "#/definitions/CorsRule" - }, - "xml": { - "wrapped": true, - "name": "Cors" - } - } - } - }, - "Logging": { - "xml": { - "name": "Logging" + "/?ServiceStats": { + "parameters": [ + { + "name": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ], + "description": "Required query string to get storage service stats" }, - "description": "Azure Analytics Logging settings.", - "type": "object", - "required": [ - "Version", - "Delete", - "Read", - "Write", - "RetentionPolicy" + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ], + "description": "Required query string to get storage service stats" + } + ], + "get": { + "tags": [ + "service" ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string", - "xml": { - "name": "Version" - } - }, - "Delete": { - "description": "Indicates whether all delete requests should be logged.", - "type": "boolean", - "xml": { - "name": "Delete" - } - }, - "Read": { - "description": "Indicates whether all read requests should be logged.", - "type": "boolean", - "xml": { - "name": "Read" - } + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "operationId": "Service_GetStatistics", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" }, - "Write": { - "description": "Indicates whether all write requests should be logged.", - "type": "boolean", - "xml": { - "name": "Write" - } + { + "$ref": "#/parameters/ApiVersionParameter" }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" + { + "$ref": "#/parameters/ClientRequestId" } - } - }, - "Metrics": { - "xml": {}, - "description": "", - "required": [ - "Enabled" ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string", - "xml": { - "name": "Version" - } - }, - "Enabled": { - "description": "Indicates whether metrics are enabled for the Table service.", - "type": "boolean", - "xml": { - "name": "Enabled" + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceStats" } }, - "IncludeAPIs": { - "description": "Indicates whether metrics should generate summary statistics for called API operations.", - "type": "boolean", - "xml": { - "name": "IncludeAPIs" + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } - }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" } } - }, - "CorsRule": { - "xml": { - "name": "CorsRule" - }, - "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", - "type": "object", - "required": [ - "AllowedOrigins", - "AllowedMethods", - "AllowedHeaders", - "ExposedHeaders", - "MaxAgeInSeconds" - ], - "properties": { - "AllowedOrigins": { - "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", - "type": "string", - "xml": { - "name": "AllowedOrigins" - } - }, - "AllowedMethods": { - "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", - "type": "string", - "xml": { - "name": "AllowedMethods" - } - }, - "AllowedHeaders": { - "description": "the request headers that the origin domain may specify on the CORS request.", - "type": "string", - "xml": { - "name": "AllowedHeaders" - } - }, - "ExposedHeaders": { - "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", - "type": "string", - "xml": { - "name": "ExposedHeaders" - } - }, - "MaxAgeInSeconds": { - "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", - "type": "integer", - "minimum": 0, - "xml": { - "name": "MaxAgeInSeconds" - } + } + } + }, + "definitions": { + "StorageError": { + "type": "object", + "xml": {}, + "properties": { + "Message": { + "type": "string", + "xml":{ + "name": "Message" } } - }, - "RetentionPolicy": { - "xml": { - "name": "RetentionPolicy" + } + }, + "StorageServiceProperties": { + "description": "Storage Service Properties.", + "type": "object", + "properties": { + "Logging": { + "description": "Azure Analytics Logging settings", + "$ref": "#/definitions/Logging" }, - "description": "the retention policy", - "type": "object", - "required": [ - "Enabled" - ], - "properties": { - "Enabled": { - "description": "Indicates whether a retention policy is enabled for the storage service", - "type": "boolean", - "xml": { - "name": "Enabled" - } + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for tables", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "A summary of request statistics grouped by API in minute aggregates for tables.", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" }, - "Days": { - "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", - "type": "integer", - "minimum": 1, - "xml": { - "name": "Days" - } + "xml": { + "wrapped": true, + "name": "Cors" } } + } + }, + "Logging": { + "xml": { + "name": "Logging" }, - "StorageServiceStats": { - "xml": {}, - "description": "Stats for the storage service.", - "type": "object", - "properties": { - "GeoReplication": { - "description": "Geo-Replication information for the Secondary Storage Service", - "$ref": "#/definitions/GeoReplication" + "description": "Azure Analytics Logging settings.", + "type": "object", + "required": [ + "Version", + "Delete", + "Read", + "Write", + "RetentionPolicy" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string", + "xml": { + "name": "Version" } - } - }, - "GeoReplication": { - "xml": { - "name": "GeoReplication" }, - "type": "object", - "required": [ - "Status", - "LastSyncTime" - ], - "properties": { - "Status": { - "description": "The status of the secondary location", - "type": "string", - "enum": [ - "live", - "bootstrap", - "unavailable" - ], - "x-ms-enum": { - "name": "GeoReplicationStatusType", - "modelAsString": true - }, - "xml": { - "name": "Status" - } - }, - "LastSyncTime": { - "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", - "type": "string", - "format": "date-time-rfc1123", - "xml": { - "name": "LastSyncTime" - } + "Delete": { + "description": "Indicates whether all delete requests should be logged.", + "type": "boolean", + "xml": { + "name": "Delete" } - } - }, - "TableProperties": { - "description": "The properties for creating a table.", - "type": "object", - "properties": { - "TableName": { - "description": "The name of the table to create.", - "type": "string" + }, + "Read": { + "description": "Indicates whether all read requests should be logged.", + "type": "boolean", + "xml": { + "name": "Read" + } + }, + "Write": { + "description": "Indicates whether all write requests should be logged.", + "type": "boolean", + "xml": { + "name": "Write" } + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" } - }, - "TableResponse": { - "description": "The response for a single table.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" + } + }, + "Metrics": { + "xml": {}, + "description": "", + "required": [ + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string", + "xml": { + "name": "Version" } }, - "allOf": [ - { - "$ref": "#/definitions/TableResponseProperties" + "Enabled": { + "description": "Indicates whether metrics are enabled for the Table service.", + "type": "boolean", + "xml": { + "name": "Enabled" } - ] - }, - "TableQueryResponse": { - "description": "The properties for the table query response.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" - }, - "value": { - "description": "List of tables.", - "type": "array", - "items": { - "$ref": "#/definitions/TableResponseProperties" - } + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean", + "xml": { + "name": "IncludeAPIs" } + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" } + } + }, + "CorsRule": { + "xml": { + "name": "CorsRule" }, - "TableResponseProperties": { - "description": "The properties for the table response.", - "type": "object", - "properties": { - "TableName": { - "description": "The name of the table.", - "type": "string" - }, - "odata.type": { - "description": "The odata type of the table.", - "type": "string" - }, - "odata.id": { - "description": "The id of the table.", - "type": "string" - }, - "odata.editLink": { - "description": "The edit link of the table.", - "type": "string" + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string", + "xml": { + "name": "AllowedOrigins" } - } - }, - "SignedIdentifier": { - "xml": { - "name": "SignedIdentifier" }, - "description": "signed identifier", - "type": "object", - "required": [ - "Id", - "AccessPolicy" - ], - "properties": { - "Id": { - "type": "string", - "description": "a unique id", - "xml": { - "name": "Id" - } - }, - "AccessPolicy": { - "description": "The access policy", - "$ref": "#/definitions/AccessPolicy" + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string", + "xml": { + "name": "AllowedMethods" + } + }, + "AllowedHeaders": { + "description": "the request headers that the origin domain may specify on the CORS request.", + "type": "string", + "xml": { + "name": "AllowedHeaders" + } + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "type": "string", + "xml": { + "name": "ExposedHeaders" + } + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0, + "xml": { + "name": "MaxAgeInSeconds" } } + } + }, + "RetentionPolicy": { + "xml": { + "name": "RetentionPolicy" }, - "SignedIdentifiers": { - "description": "a collection of signed identifiers", - "type": "array", - "items": { - "$ref": "#/definitions/SignedIdentifier", + "description": "the retention policy", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the storage service", + "type": "boolean", "xml": { - "name": "SignedIdentifier" + "name": "Enabled" } }, - "xml": { - "wrapped": true, - "name": "SignedIdentifiers" + "Days": { + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "type": "integer", + "minimum": 1, + "xml": { + "name": "Days" + } + } + } + }, + "StorageServiceStats": { + "xml": {}, + "description": "Stats for the storage service.", + "type": "object", + "properties": { + "GeoReplication": { + "description": "Geo-Replication information for the Secondary Storage Service", + "$ref": "#/definitions/GeoReplication" } + } + }, + "GeoReplication": { + "xml": { + "name": "GeoReplication" }, - "AccessPolicy": { - "xml": {"name": "AccessPolicy"}, - "type": "object", - "required": [ - "Start", - "Expiry", - "Permission" - ], - "description": "An Access policy", - "properties": { - "Start": { - "description": "the date-time the policy is active", - "type": "string", - "format": "date-time", - "xml": { - "name": "Start" - } - }, - "Expiry": { - "description": "the date-time the policy expires", - "type": "string", - "format": "date-time", - "xml": { - "name": "Expiry" - } + "type": "object", + "required": [ + "Status", + "LastSyncTime" + ], + "properties": { + "Status": { + "description": "The status of the secondary location", + "type": "string", + "enum": [ + "live", + "bootstrap", + "unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatusType", + "modelAsString": true }, - "Permission": { - "description": "the permissions for the acl policy", - "type": "string", - "xml": { - "name": "Permission" - } + "xml": { + "name": "Status" } + }, + "LastSyncTime": { + "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", + "type": "string", + "format": "date-time-rfc1123", + "xml": { + "name": "LastSyncTime" + } + } + } + }, + "TableProperties": { + "description": "The properties for creating a table.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table to create.", + "type": "string" + } + } + }, + "TableResponse": { + "description": "The response for a single table.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" } }, - "TableEntityQueryResponse": { - "description": "The properties for the table entity query response.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" - }, - "value": { - "description": "List of table entities.", - "type": "array", - "items": { - "$ref": "#/definitions/TableEntityProperties" - } + "allOf": [ + { + "$ref": "#/definitions/TableResponseProperties" + } + ] + }, + "TableQueryResponse": { + "description": "The properties for the table query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of tables.", + "type": "array", + "items": { + "$ref": "#/definitions/TableResponseProperties" } } - }, - "TableEntityProperties": { - "description": "The other properties of the table entity", - "type": "object", - "additionalProperties": true } }, - "parameters": { - "Url": { - "name": "url", - "x-ms-parameter-location": "client", - "description": "The URL of the service account or table that is the targe of the desired operation.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "StorageServiceProperties": { - "name": "storageServiceProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "TableResponseProperties": { + "description": "The properties for the table response.", + "type": "object", + "properties": { + "TableName": { + "description": "The name of the table.", + "type": "string" }, - "x-ms-parameter-location": "method", - "description": "The StorageService properties." - }, - "Timeout": { - "name": "timeout", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "x-ms-parameter-location": "method", - "description": "The timeout parameter is expressed in seconds." - }, - "ApiVersionParameter": { - "name": "x-ms-version", - "x-ms-parameter-location": "client", - "x-ms-client-name": "version", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the version of the operation to use for this request.", - "enum": [ - "2019-02-02" - ] - }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "requestId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." - }, - "DataServiceVersionParameter": { - "name": "DataServiceVersion", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the data service version", - "x-ms-parameter-location": "method", - "enum": [ - "3.0" - ] - }, - "TableProperties": { - "name": "tableProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TableProperties" + "odata.type": { + "description": "The odata type of the table.", + "type": "string" }, - "x-ms-parameter-location": "method", - "description": "The Table properties." - }, - "formatParameter": { - "name": "$format", - "in": "query", - "required": false, - "type": "string", - "description": "Specifies the media type for the response", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "odata.id": { + "description": "The id of the table.", + "type": "string" }, - "x-ms-client-name": "Format", - "enum": [ - "application/json;odata=nometadata", - "application/json;odata=minimalmetadata", - "application/json;odata=fullmetadata" - ], - "x-ms-enum": { - "name": "OdataMetadataFormat", - "modelAsString": true + "odata.editLink": { + "description": "The edit link of the table.", + "type": "string" } + } + }, + "SignedIdentifier": { + "xml": { + "name": "SignedIdentifier" }, - "topParameter": { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "Maximum number of records to return.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "description": "signed identifier", + "type": "object", + "required": [ + "Id", + "AccessPolicy" + ], + "properties": { + "Id": { + "type": "string", + "description": "a unique id", + "xml": { + "name": "Id" + } }, - "x-ms-client-name": "Top" + "AccessPolicy": { + "description": "The access policy", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "a collection of signed identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } }, - "selectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "AccessPolicy": { + "xml": {"name": "AccessPolicy"}, + "type": "object", + "required": [ + "Start", + "Expiry", + "Permission" + ], + "description": "An Access policy", + "properties": { + "Start": { + "description": "the date-time the policy is active", + "type": "string", + "format": "date-time", + "xml": { + "name": "Start" + } }, - "x-ms-client-name": "Select" - }, - "filterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" + "Expiry": { + "description": "the date-time the policy expires", + "type": "string", + "format": "date-time", + "xml": { + "name": "Expiry" + } }, - "x-ms-client-name": "Filter" - }, - "PreferParameter": { - "name": "Prefer", - "in": "header", - "required": false, - "type": "string", - "description": "Specifies whether the response should include the inserted entity in the payload. Possible values are return-no-content and return-content.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "ResponsePreference", - "enum": [ - "return-no-content", - "return-content" - ], - "x-ms-enum": { - "name": "ResponseFormat", - "modelAsString": true + "Permission": { + "description": "the permissions for the acl policy", + "type": "string", + "xml": { + "name": "Permission" + } + } + } + }, + "TableEntityQueryResponse": { + "description": "The properties for the table entity query response.", + "type": "object", + "properties": { + "odata.metadata": { + "description": "The metadata response of the table.", + "type": "string" + }, + "value": { + "description": "List of table entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TableEntityProperties" + } } + } + }, + "TableEntityProperties": { + "description": "The other properties of the table entity", + "type": "object", + "additionalProperties": true + } + }, + "parameters": { + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "description": "The URL of the service account or table that is the targe of the desired operation.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StorageServiceProperties": { + "name": "storageServiceProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" }, - "compAclParameter": { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "acl" - ], - "x-ms-parameter-location": "method", - "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + "x-ms-parameter-location": "method", + "description": "The StorageService properties." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The timeout parameter is expressed in seconds." + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-parameter-location": "client", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2019-02-02" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "DataServiceVersionParameter": { + "name": "DataServiceVersion", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the data service version", + "x-ms-parameter-location": "method", + "enum": [ + "3.0" + ] + }, + "TableProperties": { + "name": "tableProperties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableProperties" }, - "TableAcl": { - "name": "tableAcl", - "in": "body", - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - }, - "x-ms-parameter-location": "method", - "description": "the acls for the table" + "x-ms-parameter-location": "method", + "description": "The Table properties." + }, + "formatParameter": { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the media type for the response", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "TableEntityProperties": { - "name": "tableEntityProperties", - "in": "body", - "schema": { - "$ref": "#/definitions/TableEntityProperties" - }, - "x-ms-parameter-location": "method", - "description": "The properties for the table entity" + "x-ms-client-name": "Format", + "enum": [ + "application/json;odata=nometadata", + "application/json;odata=minimalmetadata", + "application/json;odata=fullmetadata" + ], + "x-ms-enum": { + "name": "OdataMetadataFormat", + "modelAsString": true + } + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "tableNameParameter": { - "name": "table", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The name of the table" + "x-ms-client-name": "Top" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "partitionKeyParameter": { - "name": "partitionKey", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The partition key of the entity" + "x-ms-client-name": "Select" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" }, - "rowKeyParameter": { - "name": "rowKey", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The row key of the entity" + "x-ms-client-name": "Filter" + }, + "PreferParameter": { + "name": "Prefer", + "in": "header", + "required": false, + "type": "string", + "description": "Specifies whether the response should include the inserted entity in the payload. Possible values are return-no-content and return-content.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "ResponsePreference", + "enum": [ + "return-no-content", + "return-content" + ], + "x-ms-enum": { + "name": "ResponseFormat", + "modelAsString": true } + }, + "compAclParameter": { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ], + "x-ms-parameter-location": "method", + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + }, + "TableAcl": { + "name": "tableAcl", + "in": "body", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method", + "description": "the acls for the table" + }, + "TableEntityProperties": { + "name": "tableEntityProperties", + "in": "body", + "schema": { + "$ref": "#/definitions/TableEntityProperties" + }, + "x-ms-parameter-location": "method", + "description": "The properties for the table entity" + }, + "tableNameParameter": { + "name": "table", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the table" + }, + "partitionKeyParameter": { + "name": "partitionKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The partition key of the entity" + }, + "rowKeyParameter": { + "name": "rowKey", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The row key of the entity" } } - +} From 0e564c748b66c59bb18942e4a0a629ded8a8e908 Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 08:59:28 -0700 Subject: [PATCH 08/21] Removed storage references --- .../preview/2019-02-02/table.json | 76 ++++++++++--------- 1 file changed, 39 insertions(+), 37 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 6642aa85d99e..e2992cf055fc 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Azure Table Storage", + "title": "Azure Table", "version": "2019-02-02", "x-ms-code-generation-settings": { "header": "MIT", @@ -219,7 +219,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -289,7 +289,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -402,7 +402,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -503,7 +503,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -604,7 +604,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -705,7 +705,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -792,7 +792,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -932,7 +932,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -1004,7 +1004,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -1076,7 +1076,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -1094,7 +1094,7 @@ "enum": [ "service" ], - "description": "Required query string to set the storage service properties" + "description": "Required query string to set the service properties" }, { "name": "comp", @@ -1104,7 +1104,7 @@ "enum": [ "properties" ], - "description": "Required query string to set the storage service properties" + "description": "Required query string to set the service properties" } ], "put": { @@ -1118,10 +1118,10 @@ "application/xml" ], "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", + "description": "Sets properties for an account's Table service endpoint, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules", "parameters": [ { - "$ref": "#/parameters/StorageServiceProperties" + "$ref": "#/parameters/TableServiceProperties" }, { "$ref": "#/parameters/Timeout" @@ -1163,7 +1163,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -1179,7 +1179,7 @@ "application/xml" ], "operationId": "Service_GetProperties", - "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "description": "gets the properties of an account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -1212,7 +1212,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "$ref": "#/definitions/TableServiceProperties" } }, "default": { @@ -1224,7 +1224,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -1240,7 +1240,7 @@ "enum": [ "service" ], - "description": "Required query string to get storage service stats" + "description": "Required query string to get service stats" }, { "name": "comp", @@ -1250,7 +1250,7 @@ "enum": [ "stats" ], - "description": "Required query string to get storage service stats" + "description": "Required query string to get service stats" } ], "get": { @@ -1302,7 +1302,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageServiceStats" + "$ref": "#/definitions/TableServiceStats" } }, "default": { @@ -1314,7 +1314,7 @@ } }, "schema": { - "$ref": "#/definitions/StorageError" + "$ref": "#/definitions/TableServiceError" } } } @@ -1322,11 +1322,13 @@ } }, "definitions": { - "StorageError": { + "TableServiceError": { + "description": "Table Service error.", "type": "object", "xml": {}, "properties": { "Message": { + "description": "The error message.", "type": "string", "xml":{ "name": "Message" @@ -1334,8 +1336,8 @@ } } }, - "StorageServiceProperties": { - "description": "Storage Service Properties.", + "TableServiceProperties": { + "description": "Table Service Properties.", "type": "object", "properties": { "Logging": { @@ -1378,7 +1380,7 @@ ], "properties": { "Version": { - "description": "The version of Storage Analytics to configure.", + "description": "The version of Analytics to configure.", "type": "string", "xml": { "name": "Version" @@ -1418,7 +1420,7 @@ ], "properties": { "Version": { - "description": "The version of Storage Analytics to configure.", + "description": "The version of Analytics to configure.", "type": "string", "xml": { "name": "Version" @@ -1458,7 +1460,7 @@ ], "properties": { "AllowedOrigins": { - "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "description": "The origin domains that are permitted to make a request against the service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", "type": "string", "xml": { "name": "AllowedOrigins" @@ -1506,7 +1508,7 @@ ], "properties": { "Enabled": { - "description": "Indicates whether a retention policy is enabled for the storage service", + "description": "Indicates whether a retention policy is enabled for the service", "type": "boolean", "xml": { "name": "Enabled" @@ -1522,9 +1524,9 @@ } } }, - "StorageServiceStats": { + "TableServiceStats": { "xml": {}, - "description": "Stats for the storage service.", + "description": "Stats for the service.", "type": "object", "properties": { "GeoReplication": { @@ -1739,15 +1741,15 @@ "in": "path", "x-ms-skip-url-encoding": true }, - "StorageServiceProperties": { - "name": "storageServiceProperties", + "TableServiceProperties": { + "name": "tableServiceProperties", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/StorageServiceProperties" + "$ref": "#/definitions/TableServiceProperties" }, "x-ms-parameter-location": "method", - "description": "The StorageService properties." + "description": "The Table Service properties." }, "Timeout": { "name": "timeout", @@ -1777,7 +1779,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when analytics logging is enabled." }, "DataServiceVersionParameter": { "name": "DataServiceVersion", From 0fbf6cde53d0a767cff439a33dd0e0d36569c3cf Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 14:16:50 -0700 Subject: [PATCH 09/21] Grammar --- .../preview/2019-02-02/table.json | 106 +++++++++--------- 1 file changed, 53 insertions(+), 53 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index e2992cf055fc..3abfbe59176f 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -102,7 +102,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "x-ms-continuation-NextTableName": { "type": "string", @@ -168,7 +168,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "Preference-Applied": { "type": "string", @@ -201,7 +201,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "Preference-Applied": { "type": "string", @@ -242,7 +242,7 @@ "$ref": "./examples/TableDelete.json" } }, - "description": "Operation permanently deletes the specified table", + "description": "Operation permanently deletes the specified table.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -276,7 +276,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." } } }, @@ -378,7 +378,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "x-ms-continuation-NextPartitionKey": { "type": "string", @@ -474,7 +474,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { "type": "string", @@ -586,12 +586,12 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { "type": "string", "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." } } }, @@ -687,12 +687,12 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { "type": "string", "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." } } }, @@ -779,7 +779,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." } } }, @@ -858,12 +858,12 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { "type": "string", "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." }, "Preference-Applied": { "type": "string", @@ -901,12 +901,12 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." }, "ETag": { "type": "string", "format": "string", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." }, "Preference-Applied": { "type": "string", @@ -988,7 +988,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." } }, "schema": { @@ -1020,7 +1020,7 @@ "application/xml" ], "operationId": "Table_SetAccessPolicy", - "description": "sets stored access policies for the table that may be used with Shared Access Signatures", + "description": "Sets stored access policies for the table that may be used with Shared Access Signatures.", "parameters": [ { "$ref": "#/parameters/TableAcl" @@ -1063,7 +1063,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." } } }, @@ -1094,7 +1094,7 @@ "enum": [ "service" ], - "description": "Required query string to set the service properties" + "description": "Required query string to set the service properties." }, { "name": "comp", @@ -1104,7 +1104,7 @@ "enum": [ "properties" ], - "description": "Required query string to set the service properties" + "description": "Required query string to set the service properties." } ], "put": { @@ -1118,7 +1118,7 @@ "application/xml" ], "operationId": "Service_SetProperties", - "description": "Sets properties for an account's Table service endpoint, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules", + "description": "Sets properties for an account's Table service endpoint, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.", "parameters": [ { "$ref": "#/parameters/TableServiceProperties" @@ -1179,7 +1179,7 @@ "application/xml" ], "operationId": "Service_GetProperties", - "description": "gets the properties of an account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "description": "Gets the properties of an account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.", "parameters": [ { "$ref": "#/parameters/Timeout" @@ -1240,7 +1240,7 @@ "enum": [ "service" ], - "description": "Required query string to get service stats" + "description": "Required query string to get service stats." }, { "name": "comp", @@ -1250,7 +1250,7 @@ "enum": [ "stats" ], - "description": "Required query string to get service stats" + "description": "Required query string to get service stats." } ], "get": { @@ -1298,7 +1298,7 @@ "Date": { "type": "string", "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated." } }, "schema": { @@ -1341,11 +1341,11 @@ "type": "object", "properties": { "Logging": { - "description": "Azure Analytics Logging settings", + "description": "Azure Analytics Logging settings.", "$ref": "#/definitions/Logging" }, "HourMetrics": { - "description": "A summary of request statistics grouped by API in hourly aggregates for tables", + "description": "A summary of request statistics grouped by API in hourly aggregates for tables.", "$ref": "#/definitions/Metrics" }, "MinuteMetrics": { @@ -1449,7 +1449,7 @@ "xml": { "name": "CorsRule" }, - "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.", "type": "object", "required": [ "AllowedOrigins", @@ -1474,14 +1474,14 @@ } }, "AllowedHeaders": { - "description": "the request headers that the origin domain may specify on the CORS request.", + "description": "The request headers that the origin domain may specify on the CORS request.", "type": "string", "xml": { "name": "AllowedHeaders" } }, "ExposedHeaders": { - "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", "type": "string", "xml": { "name": "ExposedHeaders" @@ -1501,21 +1501,21 @@ "xml": { "name": "RetentionPolicy" }, - "description": "the retention policy", + "description": "The retention policy.", "type": "object", "required": [ "Enabled" ], "properties": { "Enabled": { - "description": "Indicates whether a retention policy is enabled for the service", + "description": "Indicates whether a retention policy is enabled for the service.", "type": "boolean", "xml": { "name": "Enabled" } }, "Days": { - "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", + "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted.", "type": "integer", "minimum": 1, "xml": { @@ -1530,7 +1530,7 @@ "type": "object", "properties": { "GeoReplication": { - "description": "Geo-Replication information for the Secondary Storage Service", + "description": "Geo-Replication information for the Secondary Storage Service.", "$ref": "#/definitions/GeoReplication" } } @@ -1546,7 +1546,7 @@ ], "properties": { "Status": { - "description": "The status of the secondary location", + "description": "The status of the secondary location.", "type": "string", "enum": [ "live", @@ -1639,7 +1639,7 @@ "xml": { "name": "SignedIdentifier" }, - "description": "signed identifier", + "description": "A signed identifier.", "type": "object", "required": [ "Id", @@ -1648,19 +1648,19 @@ "properties": { "Id": { "type": "string", - "description": "a unique id", + "description": "A unique id.", "xml": { "name": "Id" } }, "AccessPolicy": { - "description": "The access policy", + "description": "The access policy.", "$ref": "#/definitions/AccessPolicy" } } }, "SignedIdentifiers": { - "description": "a collection of signed identifiers", + "description": "A collection of signed identifiers.", "type": "array", "items": { "$ref": "#/definitions/SignedIdentifier", @@ -1681,10 +1681,10 @@ "Expiry", "Permission" ], - "description": "An Access policy", + "description": "An Access policy.", "properties": { "Start": { - "description": "the date-time the policy is active", + "description": "The start datetime from which the policy is active.", "type": "string", "format": "date-time", "xml": { @@ -1692,7 +1692,7 @@ } }, "Expiry": { - "description": "the date-time the policy expires", + "description": "The datetime that the policy expires.", "type": "string", "format": "date-time", "xml": { @@ -1700,7 +1700,7 @@ } }, "Permission": { - "description": "the permissions for the acl policy", + "description": "The permissions for the acl policy.", "type": "string", "xml": { "name": "Permission" @@ -1726,7 +1726,7 @@ } }, "TableEntityProperties": { - "description": "The other properties of the table entity", + "description": "The other properties of the table entity.", "type": "object", "additionalProperties": true } @@ -1786,7 +1786,7 @@ "in": "header", "required": true, "type": "string", - "description": "Specifies the data service version", + "description": "Specifies the data service version.", "x-ms-parameter-location": "method", "enum": [ "3.0" @@ -1807,7 +1807,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the media type for the response", + "description": "Specifies the media type for the response.", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -1887,7 +1887,7 @@ "acl" ], "x-ms-parameter-location": "method", - "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" + "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures." }, "TableAcl": { "name": "tableAcl", @@ -1896,7 +1896,7 @@ "$ref": "#/definitions/SignedIdentifiers" }, "x-ms-parameter-location": "method", - "description": "the acls for the table" + "description": "The acls for the table." }, "TableEntityProperties": { "name": "tableEntityProperties", @@ -1905,7 +1905,7 @@ "$ref": "#/definitions/TableEntityProperties" }, "x-ms-parameter-location": "method", - "description": "The properties for the table entity" + "description": "The properties for the table entity." }, "tableNameParameter": { "name": "table", @@ -1913,7 +1913,7 @@ "required": true, "type": "string", "x-ms-parameter-location": "method", - "description": "The name of the table" + "description": "The name of the table." }, "partitionKeyParameter": { "name": "partitionKey", @@ -1921,7 +1921,7 @@ "required": true, "type": "string", "x-ms-parameter-location": "method", - "description": "The partition key of the entity" + "description": "The partition key of the entity." }, "rowKeyParameter": { "name": "rowKey", @@ -1929,7 +1929,7 @@ "required": true, "type": "string", "x-ms-parameter-location": "method", - "description": "The row key of the entity" + "description": "The row key of the entity." } } } From dd4f3e921561db6d9b2c80836a034accbc8900b4 Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 14:20:27 -0700 Subject: [PATCH 10/21] Improved match condition description --- .../Microsoft.TablesStorage/preview/2019-02-02/table.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 3abfbe59176f..323eafa5a4b6 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -559,7 +559,7 @@ "required": false, "type": "string", "format": "string", - "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", + "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found.", "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" } @@ -660,7 +660,7 @@ "required": false, "type": "string", "format": "string", - "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update.", + "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a merge will be performed if an existing entity is found.", "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" } From 548fac3a90a55bb2f8b8e9c694200b10121d28d3 Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 15:41:30 -0700 Subject: [PATCH 11/21] Remove format statements --- .../preview/2019-02-02/table.json | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 323eafa5a4b6..9f7f73f9d0b2 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -74,7 +74,6 @@ "in": "query", "required": false, "type": "string", - "format": "string", "description": "A table query continuation token from a previous call.", "x-ms-parameter-location": "method", "x-ms-client-name": "NextTableName" @@ -172,7 +171,6 @@ }, "Preference-Applied": { "type": "string", - "format": "string", "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." } }, @@ -205,7 +203,6 @@ }, "Preference-Applied": { "type": "string", - "format": "string", "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." } } @@ -340,7 +337,6 @@ "in": "query", "required": false, "type": "string", - "format": "string", "description": "An entity query continuation token from a previous call.", "x-ms-parameter-location": "method", "x-ms-client-name": "NextPartitionKey" @@ -350,7 +346,6 @@ "in": "query", "required": false, "type": "string", - "format": "string", "description": "An entity query continuation token from a previous call.", "x-ms-parameter-location": "method", "x-ms-client-name": "NextRowKey" @@ -478,7 +473,6 @@ }, "ETag": { "type": "string", - "format": "string", "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" }, "x-ms-continuation-NextPartitionKey": { @@ -558,7 +552,6 @@ "in": "header", "required": false, "type": "string", - "format": "string", "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found.", "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" @@ -590,7 +583,6 @@ }, "ETag": { "type": "string", - "format": "string", "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." } } @@ -659,7 +651,6 @@ "in": "header", "required": false, "type": "string", - "format": "string", "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a merge will be performed if an existing entity is found.", "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" @@ -691,7 +682,6 @@ }, "ETag": { "type": "string", - "format": "string", "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." } } @@ -751,7 +741,6 @@ "in": "header", "required": true, "type": "string", - "format": "string", "description": "Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).", "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" @@ -862,17 +851,14 @@ }, "ETag": { "type": "string", - "format": "string", "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." }, "Preference-Applied": { "type": "string", - "format": "string", "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." }, "Content-Type": { "type": "string", - "format": "string", "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." } }, @@ -905,17 +891,14 @@ }, "ETag": { "type": "string", - "format": "string", "description": "UTC date/time value generated by the service that indicates the time at which the entity was last updated." }, "Preference-Applied": { "type": "string", - "format": "string", "description": "Indicates whether the Prefer request header was honored. If the response does not include this header, then the Prefer header was not honored. If this header is returned, its value will either be return-content or return-no-content." }, "Content-Type": { "type": "string", - "format": "string", "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." } }, From 1839712c19877fca0a7a66ea08d0db2617b9cab4 Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 15:48:14 -0700 Subject: [PATCH 12/21] Removed excess tags --- .../preview/2019-02-02/table.json | 9 --------- 1 file changed, 9 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 9f7f73f9d0b2..f6abd5bc82fe 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -75,8 +75,6 @@ "required": false, "type": "string", "description": "A table query continuation token from a previous call.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "NextTableName" } ], "responses": { @@ -338,8 +336,6 @@ "required": false, "type": "string", "description": "An entity query continuation token from a previous call.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "NextPartitionKey" }, { "name": "NextRowKey", @@ -347,8 +343,6 @@ "required": false, "type": "string", "description": "An entity query continuation token from a previous call.", - "x-ms-parameter-location": "method", - "x-ms-client-name": "NextRowKey" } ], "responses": { @@ -553,7 +547,6 @@ "required": false, "type": "string", "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a replace will be performed if an existing entity is found.", - "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" } ], @@ -652,7 +645,6 @@ "required": false, "type": "string", "description": "Match condition for an entity to be updated. If specified and a matching entity is not found, an error will be raised. To force an unconditional update, set to the wildcard character (*). If not specified, an insert will be performed when no existing entity is found to update and a merge will be performed if an existing entity is found.", - "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" } ], @@ -742,7 +734,6 @@ "required": true, "type": "string", "description": "Match condition for an entity to be deleted. If specified and a matching entity is not found, an error will be raised. To force an unconditional delete, set to the wildcard character (*).", - "x-ms-parameter-location": "method", "x-ms-client-name": "IfMatch" } ], From 51974def161aa73c6b47b7caa6a99b7f5234f46c Mon Sep 17 00:00:00 2001 From: annatisch Date: Tue, 5 May 2020 15:54:21 -0700 Subject: [PATCH 13/21] Fix extra commas --- .../Microsoft.TablesStorage/preview/2019-02-02/table.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index f6abd5bc82fe..4554480c41ed 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -74,7 +74,7 @@ "in": "query", "required": false, "type": "string", - "description": "A table query continuation token from a previous call.", + "description": "A table query continuation token from a previous call." } ], "responses": { @@ -335,14 +335,14 @@ "in": "query", "required": false, "type": "string", - "description": "An entity query continuation token from a previous call.", + "description": "An entity query continuation token from a previous call." }, { "name": "NextRowKey", "in": "query", "required": false, "type": "string", - "description": "An entity query continuation token from a previous call.", + "description": "An entity query continuation token from a previous call." } ], "responses": { From 3842a38ba61c2dd716d16386c211891cb28e8e15 Mon Sep 17 00:00:00 2001 From: annatisch Date: Wed, 6 May 2020 14:24:29 -0700 Subject: [PATCH 14/21] Added missing example --- .../2019-02-02/examples/TableMergeEntity.json | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableMergeEntity.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableMergeEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableMergeEntity.json new file mode 100644 index 000000000000..24e71afe72fa --- /dev/null +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableMergeEntity.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "x-ms-version": "2019-02-02", + "DataServiceVersion": "3.0", + "url": "myaccount.table.core.windows.net", + "table": "Customers", + "partitionKey": "mypartitionkey", + "rowKey": "myrowkey", + "tableEntityProperties": { + "Address": "Santa Clara", + "Age": 23, + "AmountDue": 200.23, + "CustomerCode@odata.type": "Edm.Guid", + "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", + "CustomerSince@odata.type": "Edm.DateTime", + "CustomerSince": "2008-07-10T00:00:00", + "IsActive": false, + "NumberOfOrders@odata.type": "Edm.Int64", + "NumberOfOrders": "255", + "PartitionKey": "mypartitionkey", + "RowKey": "myrowkey" + } + }, + "responses": { + "204": {} + } +} From 61dc890c1de52a4e9662a8ae51c5a047d1e4f6b9 Mon Sep 17 00:00:00 2001 From: annatisch Date: Wed, 6 May 2020 14:26:19 -0700 Subject: [PATCH 15/21] Updated Delete example --- .../preview/2019-02-02/examples/TableDeleteEntity.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json index fa4580e4ea8b..2d0f7a9a5525 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json @@ -2,6 +2,7 @@ "parameters": { "x-ms-version": "2019-02-02", "DataServiceVersion": "3.0", + "If-Match": "*", "url": "myaccount.table.core.windows.net", "table": "Customers", "partitionKey": "mypartitionkey", From bc30a343c5461bb8dcf832bd68086318ded9c4a0 Mon Sep 17 00:00:00 2001 From: antisch Date: Thu, 7 May 2020 09:15:22 -0700 Subject: [PATCH 16/21] Run prettier --- .../preview/2019-02-02/table.json | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index 4554480c41ed..b0d3757316f0 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -1304,7 +1304,7 @@ "Message": { "description": "The error message.", "type": "string", - "xml":{ + "xml": { "name": "Message" } } @@ -1437,28 +1437,28 @@ "description": "The origin domains that are permitted to make a request against the service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", "type": "string", "xml": { - "name": "AllowedOrigins" + "name": "AllowedOrigins" } }, "AllowedMethods": { "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", "type": "string", "xml": { - "name": "AllowedMethods" + "name": "AllowedMethods" } }, "AllowedHeaders": { "description": "The request headers that the origin domain may specify on the CORS request.", "type": "string", "xml": { - "name": "AllowedHeaders" + "name": "AllowedHeaders" } }, "ExposedHeaders": { "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", "type": "string", "xml": { - "name": "ExposedHeaders" + "name": "ExposedHeaders" } }, "MaxAgeInSeconds": { @@ -1466,7 +1466,7 @@ "type": "integer", "minimum": 0, "xml": { - "name": "MaxAgeInSeconds" + "name": "MaxAgeInSeconds" } } } @@ -1485,7 +1485,7 @@ "description": "Indicates whether a retention policy is enabled for the service.", "type": "boolean", "xml": { - "name": "Enabled" + "name": "Enabled" } }, "Days": { @@ -1493,7 +1493,7 @@ "type": "integer", "minimum": 1, "xml": { - "name": "Days" + "name": "Days" } } } @@ -1648,7 +1648,9 @@ } }, "AccessPolicy": { - "xml": {"name": "AccessPolicy"}, + "xml": { + "name": "AccessPolicy" + }, "type": "object", "required": [ "Start", From 4fc53df90006a5c8bede993b88382b06e7ca2b38 Mon Sep 17 00:00:00 2001 From: antisch Date: Thu, 7 May 2020 09:18:38 -0700 Subject: [PATCH 17/21] Removed duplicate API version --- .../2018-10-10/examples/TableCreate.json | 22 - .../2018-10-10/examples/TableDelete.json | 10 - .../examples/TableDeleteEntity.json | 13 - .../preview/2018-10-10/examples/TableGet.json | 23 - .../examples/TableInsertEntity.json | 47 - .../examples/TableQueryEntities.json | 30 - ...leQueryEntitiesWithPartitionAndRowKey.json | 31 - .../examples/TableUpdateEntity.json | 27 - .../preview/2018-10-10/table.json | 1585 ----------------- 9 files changed, 1788 deletions(-) delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json delete mode 100644 specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json deleted file mode 100644 index d4f34cfccdbe..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableCreate.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "url": "myaccount.table.core.windows.net", - "tableProperties": { - "TableName": "mytable" - } - }, - "responses": { - "201": { - "body": { - "odata.metadata": "https://myaccount.table.core.windows.net/$metadata#Tables/@Element", - "odata.type": " myaccount.Tables", - "odata.id": "https://myaccount.table.core.windows.net/Tables('mytable')", - "odata.editLink": "Tables('mytable')", - "TableName": "mytable" - } - }, - "204": {} - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json deleted file mode 100644 index a3cc9c4dfc4a..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDelete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "url": "myaccount.table.core.windows.net", - "table": "mytable" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json deleted file mode 100644 index 8ea39e236b20..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableDeleteEntity.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "url": "myaccount.table.core.windows.net", - "table": "Customers", - "partitionKey": "mypartitionkey", - "rowKey": "myrowkey" - }, - "responses": { - "204": {} - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json deleted file mode 100644 index 218af3fd4b87..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "$top": 1, - "url": "myaccount.table.core.windows.net" - }, - "responses": { - "200": { - "body": { - "odata.metadata": "https://myaccount.table.core.windows.net/$metadata#Tables", - "value": [ - { - "odata.type": "myaccount.Tables", - "odata.id": "https://myaccount.table.core.windows.net/Tables('mytable')", - "odata.editLink": "Tables('mytable')", - "TableName": "mytable" - } - ] - } - } - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json deleted file mode 100644 index 52bec3cd6161..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableInsertEntity.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "table": "Customer", - "url": "myaccount.table.core.windows.net", - "tableEntityProperties": { - "Address": "Mountain View", - "Age": 23, - "AmountDue": 200.23, - "CustomerCode@odata.type": "Edm.Guid", - "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", - "CustomerSince@odata.type": "Edm.DateTime", - "CustomerSince": "2008-07-10T00:00:00", - "IsActive": true, - "NumberOfOrders@odata.type": "Edm.Int64", - "NumberOfOrders": "255", - "PartitionKey": "mypartitionkey", - "RowKey": "myrowkey" - } - }, - "responses": { - "201": { - "body": { - "odata.metadata": "https://myaccount.table.core.windows.net/Customer/$metadata#Customers/@Element", - "odata.type": "myaccount.Customers", - "odata.id": " https://myaccount.table.core.windows.net/Customers(PartitionKey='mypartitionkey',RowKey='myrowkey')", - "odata.etag": "W/\"0x5B168C7B6E589D2\"", - "odata.editLink": "Customers(PartitionKey='mypartitionkey',RowKey='myrowkey')", - "PartitionKey": "mypartitionkey", - "RowKey": "myrowkey", - "Timestamp@odata.type": "Edm.DateTime", - "Timestamp": "2013-08-22T01:12:06.2608595Z", - "Address": "Mountain View", - "Age": 23, - "AmountDue": 200.23, - "CustomerCode@odata.type": "Edm.Guid", - "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", - "CustomerSince@odata.type": "Edm.DateTime", - "CustomerSince": "2008-07-10T00:00:00", - "IsActive": true, - "NumberOfOrders@odata.type": "Edm.Int64", - "NumberOfOrders": "255" - } - } - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json deleted file mode 100644 index 0dbdb835a44b..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntities.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "url": "myaccount.table.core.windows.net", - "$top": 1, - "table": "Customer" - }, - "responses": { - "200": { - "body": { - "odata.metadata": " https://myaccount.table.core.windows.net/metadata#Customers", - "value": [ - { - "PartitionKey": "Customer", - "RowKey": "Name", - "odata.type": "myaccount.Customers", - "odata.id": "https://myaccount.table.core.windows.net/Customers(PartitionKey=Customer',RowKey='Name')", - "odata.etag": "W/\"0x5B168C7B6E589D2\"", - "odata.editLink": "Customers(PartitionKey=Customer',RowKey='Name')", - "Timestamp@odata.type": "Edm.DateTime", - "Timestamp": "2013-08-22T00:20:16.3134645Z", - "CustomerSince@odata.type": "Edm.DateTime", - "CustomerSince": "2008-10-01T15:25:05.2852025Z" - } - ] - } - } - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json deleted file mode 100644 index 12dcb075ec0d..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableQueryEntitiesWithPartitionAndRowKey.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "url": "myaccount.table.core.windows.net", - "table": "Customers", - "partitionKey": "Customer", - "rowKey": "Name" - }, - "responses": { - "200": { - "body": { - "odata.metadata": " https://myaccount.table.core.windows.net/metadata#Customers", - "value": [ - { - "odata.type": "myaccount.Customers", - "odata.id": "https://myaccount.table.core.windows.net/Customers(PartitionKey=Customer',RowKey='Name')", - "odata.etag": "W/\"0x5B168C7B6E589D2\"", - "odata.editLink": "Customers(PartitionKey=Customer',RowKey='Name')", - "PartitionKey": "Customer", - "RowKey": "Name", - "Timestamp@odata.type": "Edm.DateTime", - "Timestamp": "2013-08-22T00:20:16.3134645Z", - "CustomerSince@odata.type": "Edm.DateTime", - "CustomerSince": "2008-10-01T15:25:05.2852025Z" - } - ] - } - } - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json deleted file mode 100644 index 2a898f51fd21..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/examples/TableUpdateEntity.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "x-ms-version": "2018-10-10", - "DataServiceVersion": "3.0", - "url": "myaccount.table.core.windows.net", - "table": "Customers", - "partitionKey": "mypartitionkey", - "rowKey": "myrowkey", - "tableEntityProperties": { - "Address": "Santa Clara", - "Age": 23, - "AmountDue": 200.23, - "CustomerCode@odata.type": "Edm.Guid", - "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833", - "CustomerSince@odata.type": "Edm.DateTime", - "CustomerSince": "2008-07-10T00:00:00", - "IsActive": false, - "NumberOfOrders@odata.type": "Edm.Int64", - "NumberOfOrders": "255", - "PartitionKey": "mypartitionkey", - "RowKey": "myrowkey" - } - }, - "responses": { - "204": {} - } -} diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json deleted file mode 100644 index 04bb78ab1484..000000000000 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2018-10-10/table.json +++ /dev/null @@ -1,1585 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Table Storage", - "version": "2018-10-10", - "x-ms-code-generation-settings": { - "header": "MIT", - "strictSpecAdherence": false - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{url}", - "useSchemePrefix": false, - "positionInOperation": "first", - "parameters": [ - { - "$ref": "#/parameters/Url" - } - ] - }, - "securityDefinitions": { - "table_shared_key": { - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json;odata=nometadata" - ], - "produces": [ - "application/json;odata=nometadata" - ], - "paths": { - "/Tables": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_Query", - "x-ms-examples": { - "TableGet": { - "$ref": "./examples/TableGet.json" - } - }, - "description": "Queries tables under the given account.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - } - ], - "responses": { - "200": { - "description": "Success, table query completed.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextTableName": { - "type": "string", - "description": "This header contains the continuation token value." - } - }, - "schema": { - "$ref": "#/definitions/TableQueryResponse" - } - } - } - }, - "post": { - "tags": [ - "table" - ], - "operationId": "Table_Create", - "x-ms-examples": { - "TableCreate": { - "$ref": "./examples/TableCreate.json" - } - }, - "description": "Creates a new table under the given account.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableProperties" - } - ], - "responses": { - "201": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/TableResponse" - } - }, - "204": { - "description": "Success, table created.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - }, - "/Tables('{table}')": { - "delete": { - "tags": [ - "table" - ], - "operationId": "Table_Delete", - "x-ms-examples": { - "TableDelete": { - "$ref": "./examples/TableDelete.json" - } - }, - "description": "Operation permanently deletes the specified table", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/tableNameParameter" - } - ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - }, - "/{table}()": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_QueryEntities", - "x-ms-examples": { - "TableQueryEntities": { - "$ref": "./examples/TableQueryEntities.json" - } - }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextPartitionKey": { - "type": "string", - "description": "This header contains the continuation token value for partition key." - }, - "x-ms-continuation-NextRowKey": { - "type": "string", - "description": "This header contains the continuation token value for row key." - } - }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - }, - "/{table}(PartitionKey='{partitionKey}',RowKey='{rowKey}')": { - "get": { - "tags": [ - "table" - ], - "operationId": "Table_QueryEntitiesWithPartitionAndRowKey", - "x-ms-examples": { - "TableQueryEntitiesWithPartitionAndRowKey": { - "$ref": "./examples/TableQueryEntitiesWithPartitionAndRowKey.json" - } - }, - "description": "Queries entities in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/selectParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - }, - "x-ms-continuation-NextPartitionKey": { - "type": "string", - "description": "This header contains the continuation token value for partition key." - }, - "x-ms-continuation-NextRowKey": { - "type": "string", - "description": "This header contains the continuation token value for row key." - } - }, - "schema": { - "$ref": "#/definitions/TableEntityQueryResponse" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "put": { - "tags": [ - "table" - ], - "operationId": "Table_UpdateEntity", - "x-ms-examples": { - "TableUpdateEntity": { - "$ref": "./examples/TableUpdateEntity.json" - } - }, - "description": "Update entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "delete": { - "tags": [ - "table" - ], - "operationId": "Table_DeleteEntity", - "x-ms-examples": { - "TableDeleteEntity": { - "$ref": "./examples/TableDeleteEntity.json" - } - }, - "description": "Deletes the specified entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/partitionKeyParameter" - }, - { - "$ref": "#/parameters/rowKeyParameter" - } - ], - "responses": { - "204": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - }, - "/{table}": { - "post": { - "tags": [ - "table" - ], - "operationId": "Table_InsertEntity", - "x-ms-examples": { - "TableInsertEntity": { - "$ref": "./examples/TableInsertEntity.json" - } - }, - "description": "Insert entity in a table.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/DataServiceVersionParameter" - }, - { - "$ref": "#/parameters/formatParameter" - }, - { - "$ref": "#/parameters/TableEntityProperties" - }, - { - "$ref": "#/parameters/tableNameParameter" - } - ], - "responses": { - "201": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/TableEntityProperties" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "tags": [ - "table" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_GetAccessPolicy", - "description": "Retrieves details about any stored access policies specified on the table that may be used wit Shared Access Signatures.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/compAclParameter" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "put": { - "tags": [ - "table" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Table_SetAccessPolicy", - "description": "sets stored access policies for the table that may be used with Shared Access Signatures", - "parameters": [ - { - "$ref": "#/parameters/TableAcl" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/tableNameParameter" - }, - { - "$ref": "#/parameters/compAclParameter" - } - ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - } - }, - "x-ms-paths": { - "/?ServiceProperties": { - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to set the storage service properties" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "properties" - ], - "description": "Required query string to set the storage service properties" - } - ], - "put": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_SetProperties", - "description": "Sets properties for a storage account's Table service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules", - "parameters": [ - { - "$ref": "#/parameters/StorageServiceProperties" - }, - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "202": { - "description": "Success (Accepted)", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - }, - "get": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_GetProperties", - "description": "gets the properties of a storage account's Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - } - }, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - }, - "/?ServiceStats": { - "parameters": [ - { - "name": "restype", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "service" - ], - "description": "Required query string to get storage service stats" - }, - { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "stats" - ], - "description": "Required query string to get storage service stats" - } - ], - "get": { - "tags": [ - "service" - ], - "consumes": [ - "application/xml" - ], - "produces": [ - "application/xml" - ], - "operationId": "Service_GetStatistics", - "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", - "parameters": [ - { - "$ref": "#/parameters/Timeout" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClientRequestId" - } - ], - "responses": { - "200": { - "description": "Success.", - "headers": { - "x-ms-client-request-id": { - "x-ms-client-name": "ClientRequestId", - "type": "string", - "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." - }, - "x-ms-request-id": { - "x-ms-client-name": "RequestId", - "type": "string", - "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." - }, - "x-ms-version": { - "x-ms-client-name": "Version", - "type": "string", - "description": "Indicates the version of the Table service used to execute the request. This header is returned for requests made against version 2009-09-19 and above." - }, - "Date": { - "type": "string", - "format": "date-time-rfc1123", - "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" - } - }, - "schema": { - "$ref": "#/definitions/StorageServiceStats" - } - }, - "default": { - "description": "Failure", - "headers": { - "x-ms-error-code": { - "x-ms-client-name": "ErrorCode", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/StorageError" - } - } - } - } - } - }, - "definitions": { - "StorageError": { - "type": "object", - "properties": { - "Message": { - "type": "string" - } - } - }, - "StorageServiceProperties": { - "description": "Storage Service Properties.", - "type": "object", - "properties": { - "Logging": { - "description": "Azure Analytics Logging settings", - "$ref": "#/definitions/Logging" - }, - "HourMetrics": { - "description": "A summary of request statistics grouped by API in hourly aggregates for queues", - "$ref": "#/definitions/Metrics" - }, - "MinuteMetrics": { - "description": "a summary of request statistics grouped by API in minute aggregates for queues", - "$ref": "#/definitions/Metrics" - }, - "Cors": { - "description": "The set of CORS rules.", - "type": "array", - "items": { - "$ref": "#/definitions/CorsRule", - "xml": { - "name": "CorsRule" - } - }, - "xml": { - "wrapped": true - } - } - } - }, - "Logging": { - "description": "Azure Analytics Logging settings.", - "type": "object", - "required": [ - "Version", - "Delete", - "Read", - "Write", - "RetentionPolicy" - ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string" - }, - "Delete": { - "description": "Indicates whether all delete requests should be logged.", - "type": "boolean" - }, - "Read": { - "description": "Indicates whether all read requests should be logged.", - "type": "boolean" - }, - "Write": { - "description": "Indicates whether all write requests should be logged.", - "type": "boolean" - }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" - } - } - }, - "Metrics": { - "description": "", - "required": [ - "Enabled" - ], - "properties": { - "Version": { - "description": "The version of Storage Analytics to configure.", - "type": "string" - }, - "Enabled": { - "description": "Indicates whether metrics are enabled for the Queue service.", - "type": "boolean" - }, - "IncludeAPIs": { - "description": "Indicates whether metrics should generate summary statistics for called API operations.", - "type": "boolean" - }, - "RetentionPolicy": { - "$ref": "#/definitions/RetentionPolicy" - } - } - }, - "CorsRule": { - "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain", - "type": "object", - "required": [ - "AllowedOrigins", - "AllowedMethods", - "AllowedHeaders", - "ExposedHeaders", - "MaxAgeInSeconds" - ], - "properties": { - "AllowedOrigins": { - "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", - "type": "string" - }, - "AllowedMethods": { - "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", - "type": "string" - }, - "AllowedHeaders": { - "description": "the request headers that the origin domain may specify on the CORS request.", - "type": "string" - }, - "ExposedHeaders": { - "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer", - "type": "string" - }, - "MaxAgeInSeconds": { - "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", - "type": "integer", - "minimum": 0 - } - } - }, - "RetentionPolicy": { - "description": "the retention policy", - "type": "object", - "required": [ - "Enabled" - ], - "properties": { - "Enabled": { - "description": "Indicates whether a retention policy is enabled for the storage service", - "type": "boolean" - }, - "Days": { - "description": "Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted", - "type": "integer", - "minimum": 1 - } - } - }, - "StorageServiceStats": { - "description": "Stats for the storage service.", - "type": "object", - "properties": { - "GeoReplication": { - "description": "Geo-Replication information for the Secondary Storage Service", - "$ref": "#/definitions/GeoReplication" - } - } - }, - "GeoReplication": { - "type": "object", - "required": [ - "Status", - "LastSyncTime" - ], - "properties": { - "Status": { - "description": "The status of the secondary location", - "type": "string", - "enum": [ - "live", - "bootstrap", - "unavailable" - ], - "x-ms-enum": { - "name": "GeoReplicationStatusType", - "modelAsString": true - } - }, - "LastSyncTime": { - "description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.", - "type": "string", - "format": "date-time-rfc1123" - } - } - }, - "TableProperties": { - "description": "The properties for creating a table.", - "type": "object", - "properties": { - "TableName": { - "description": "The name of the table to create.", - "type": "string" - } - } - }, - "TableResponse": { - "description": "The response for a single table.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/TableResponseProperties" - } - ] - }, - "TableQueryResponse": { - "description": "The properties for the table query response.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" - }, - "value": { - "description": "List of tables.", - "type": "array", - "items": { - "$ref": "#/definitions/TableResponseProperties" - } - } - } - }, - "TableResponseProperties": { - "description": "The properties for the table response.", - "type": "object", - "properties": { - "TableName": { - "description": "The name of the table.", - "type": "string" - }, - "odata.type": { - "description": "The odata type of the table.", - "type": "string" - }, - "odata.id": { - "description": "The id of the table.", - "type": "string" - }, - "odata.editLink": { - "description": "The edit link of the table.", - "type": "string" - } - } - }, - "SignedIdentifier": { - "description": "signed identifier", - "type": "object", - "required": [ - "Id", - "AccessPolicy" - ], - "properties": { - "Id": { - "type": "string", - "description": "a unique id" - }, - "AccessPolicy": { - "description": "The access policy", - "$ref": "#/definitions/AccessPolicy" - } - } - }, - "SignedIdentifiers": { - "description": "a collection of signed identifiers", - "type": "array", - "items": { - "$ref": "#/definitions/SignedIdentifier", - "xml": { - "name": "SignedIdentifier" - } - }, - "xml": { - "wrapped": true, - "name": "SignedIdentifiers" - } - }, - "AccessPolicy": { - "type": "object", - "required": [ - "Start", - "Expiry", - "Permission" - ], - "description": "An Access policy", - "properties": { - "Start": { - "description": "the date-time the policy is active", - "type": "string", - "format": "date-time" - }, - "Expiry": { - "description": "the date-time the policy expires", - "type": "string", - "format": "date-time" - }, - "Permission": { - "description": "the permissions for the acl policy", - "type": "string" - } - } - }, - "TableEntityQueryResponse": { - "description": "The properties for the table entity query response.", - "type": "object", - "properties": { - "odata.metadata": { - "description": "The metadata response of the table.", - "type": "string" - }, - "value": { - "description": "List of table entities.", - "type": "array", - "items": { - "$ref": "#/definitions/TableEntityProperties" - } - } - } - }, - "TableEntityProperties": { - "description": "The other properties of the table entity", - "type": "object", - "additionalProperties": true - } - }, - "parameters": { - "Url": { - "name": "url", - "x-ms-parameter-location": "client", - "description": "The URL of the service account or table that is the targe of the desired operation.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - "StorageServiceProperties": { - "name": "storageServiceProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageServiceProperties" - }, - "x-ms-parameter-location": "method", - "description": "The StorageService properties." - }, - "Timeout": { - "name": "timeout", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "x-ms-parameter-location": "method", - "description": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations." - }, - "ApiVersionParameter": { - "name": "x-ms-version", - "x-ms-parameter-location": "client", - "x-ms-client-name": "version", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the version of the operation to use for this request.", - "enum": [ - "2018-10-10" - ] - }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "requestId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." - }, - "DataServiceVersionParameter": { - "name": "DataServiceVersion", - "in": "header", - "required": true, - "type": "string", - "description": "Specifies the data service version", - "x-ms-parameter-location": "method", - "enum": [ - "3.0" - ] - }, - "TableProperties": { - "name": "tableProperties", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TableProperties" - }, - "x-ms-parameter-location": "method", - "description": "The Table properties." - }, - "formatParameter": { - "name": "$format", - "in": "query", - "required": false, - "type": "string", - "description": "Specifies the media type for the response", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Format", - "enum": [ - "application/json;odata=nometadata", - "application/json;odata=minimalmetadata", - "application/json;odata=fullmetadata" - ] - }, - "topParameter": { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "Maximum number of records to return.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Top" - }, - "selectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Select" - }, - "filterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Filter" - }, - "compAclParameter": { - "name": "comp", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "acl" - ], - "x-ms-parameter-location": "method", - "description": "Required query string to handle stored access policies for the table that may be used with Shared Access Signatures" - }, - "TableAcl": { - "name": "tableAcl", - "in": "body", - "schema": { - "$ref": "#/definitions/SignedIdentifiers" - }, - "x-ms-parameter-location": "method", - "description": "the acls for the table" - }, - "TableEntityProperties": { - "name": "tableEntityProperties", - "in": "body", - "schema": { - "$ref": "#/definitions/TableEntityProperties" - }, - "x-ms-parameter-location": "method", - "description": "The properties for the table entity" - }, - "tableNameParameter": { - "name": "table", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The name of the table" - }, - "partitionKeyParameter": { - "name": "partitionKey", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The partition key of the entity" - }, - "rowKeyParameter": { - "name": "rowKey", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The row key of the entity" - } - } -} From dae76d27e75fe75e42fe5e00eb1cf8b14749fa5d Mon Sep 17 00:00:00 2001 From: antisch Date: Thu, 7 May 2020 09:23:51 -0700 Subject: [PATCH 18/21] Fixed insert response --- .../preview/2019-02-02/examples/TableInsertEntity.json | 3 ++- .../Microsoft.TablesStorage/preview/2019-02-02/table.json | 5 +---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json index c29a9bb05738..749a5ac0a691 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json @@ -42,6 +42,7 @@ "NumberOfOrders@odata.type": "Edm.Int64", "NumberOfOrders": "255" } - } + }, + "204": {} } } diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json index b0d3757316f0..659005f2313f 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json @@ -858,7 +858,7 @@ } }, "204": { - "description": "Success.", + "description": "No Content.", "headers": { "x-ms-client-request-id": { "x-ms-client-name": "ClientRequestId", @@ -892,9 +892,6 @@ "type": "string", "description": "Indicates the content type of the payload. The value depends on the value specified for the Accept request header." } - }, - "schema": { - "$ref": "#/definitions/TableEntityProperties" } }, "default": { From 2076fd5f05bff46a908bc6060a96a2ea71a8882c Mon Sep 17 00:00:00 2001 From: antisch Date: Thu, 7 May 2020 09:29:20 -0700 Subject: [PATCH 19/21] Removed 2018 readme tag --- .../cosmos-db/data-plane/readme.go.md | 10 ---------- specification/cosmos-db/data-plane/readme.md | 20 ------------------- 2 files changed, 30 deletions(-) diff --git a/specification/cosmos-db/data-plane/readme.go.md b/specification/cosmos-db/data-plane/readme.go.md index b5e151cb8a59..e8b63caff258 100644 --- a/specification/cosmos-db/data-plane/readme.go.md +++ b/specification/cosmos-db/data-plane/readme.go.md @@ -14,7 +14,6 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2019-02 - - tag: package-2018-10 ``` ### Tag: package-2019-02 and go @@ -24,13 +23,4 @@ Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2018-10' && $(go) -output-folder: $(go-sdk-folder)/services/preview/storage/tables/2018-10-10/$(namespace) ``` \ No newline at end of file diff --git a/specification/cosmos-db/data-plane/readme.md b/specification/cosmos-db/data-plane/readme.md index 4e5de5dea0c2..9d7c4b93b49f 100644 --- a/specification/cosmos-db/data-plane/readme.md +++ b/specification/cosmos-db/data-plane/readme.md @@ -39,15 +39,6 @@ input-file: - Microsoft.TablesStorage/preview/2019-02-02/table.json ``` -### Tag: package-2018-10 - -These settings apply only when `--tag=package-2018-10` is specified on the command line. - -``` yaml $(tag) == 'package-2018-10' -input-file: -- Microsoft.TablesStorage/preview/2018-10-10/table.json -``` - --- # Suppressions @@ -233,7 +224,6 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: - tag: package-2019-02 - - tag: package-2018-10 ``` ### Tag: package-2019-02 and python @@ -246,16 +236,6 @@ python: output-folder: $(python-sdks-folder)/azure-tables-storage/azure/tables/storage/v2019_02_02 ``` -### Tag: package-2018-10 and python - -These settings apply only when `--tag=package-2018-10 --python` is specified on the command line. - -``` yaml $(tag) == 'package-2018-10' && $(python) -python: - namespace: azure.tables.storage.v2018_10_10 - output-folder: $(python-sdks-folder)/azure-tables-storage/azure/tables/storage/v2018_10_10 -``` - ## Go See configuration in [readme.go.md](./readme.go.md) From 15dc063ef48935d3e60597225fbad174c8e068da Mon Sep 17 00:00:00 2001 From: antisch Date: Thu, 7 May 2020 09:45:20 -0700 Subject: [PATCH 20/21] Remove storage name --- .../2019-02-02/examples/TableCreate.json | 0 .../2019-02-02/examples/TableDelete.json | 0 .../examples/TableDeleteEntity.json | 0 .../preview/2019-02-02/examples/TableGet.json | 0 .../examples/TableInsertEntity.json | 0 .../2019-02-02/examples/TableMergeEntity.json | 0 .../examples/TableQueryEntities.json | 0 ...leQueryEntitiesWithPartitionAndRowKey.json | 0 .../examples/TableUpdateEntity.json | 0 .../preview/2019-02-02/table.json | 2 +- specification/cosmos-db/data-plane/readme.md | 26 +++++++++---------- 11 files changed, 14 insertions(+), 14 deletions(-) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableCreate.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableDelete.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableDeleteEntity.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableGet.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableInsertEntity.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableMergeEntity.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableQueryEntities.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/examples/TableUpdateEntity.json (100%) rename specification/cosmos-db/data-plane/{Microsoft.TablesStorage => Microsoft.Tables}/preview/2019-02-02/table.json (99%) diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableCreate.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableCreate.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableCreate.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDelete.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDelete.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDelete.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDelete.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDeleteEntity.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableDeleteEntity.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDeleteEntity.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableGet.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableGet.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableGet.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableInsertEntity.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableInsertEntity.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableInsertEntity.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableMergeEntity.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableMergeEntity.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableMergeEntity.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableMergeEntity.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableQueryEntities.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntities.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableQueryEntities.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableUpdateEntity.json similarity index 100% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/examples/TableUpdateEntity.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableUpdateEntity.json diff --git a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json similarity index 99% rename from specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json rename to specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json index 659005f2313f..6ec8ea5e20b5 100644 --- a/specification/cosmos-db/data-plane/Microsoft.TablesStorage/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json @@ -1235,7 +1235,7 @@ "application/xml" ], "operationId": "Service_GetStatistics", - "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.", + "description": "Retrieves statistics related to replication for the Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the account.", "parameters": [ { "$ref": "#/parameters/Timeout" diff --git a/specification/cosmos-db/data-plane/readme.md b/specification/cosmos-db/data-plane/readme.md index 9d7c4b93b49f..c6841b6c5125 100644 --- a/specification/cosmos-db/data-plane/readme.md +++ b/specification/cosmos-db/data-plane/readme.md @@ -1,14 +1,14 @@ -# Table Storage Dataplane +# Table Dataplane > see https://aka.ms/autorest -This is the AutoRest configuration file for Tables Storage. +This is the AutoRest configuration file for Tables. --- ## Getting Started -To build the SDK for Tables Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: +To build the SDK for Tables, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -22,7 +22,7 @@ To see additional help and options, run: ### Basic Information -These are the global settings for the Tables Storage API. +These are the global settings for the Tables API. ``` yaml azure-validator: true @@ -36,7 +36,7 @@ These settings apply only when `--tag=package-2019-02` is specified on the comma ``` yaml $(tag) == 'package-2019-02' input-file: -- Microsoft.TablesStorage/preview/2019-02-02/table.json +- Microsoft.Tables/preview/2019-02-02/table.json ``` --- @@ -60,19 +60,19 @@ directive: where: $.paths["/{table}"].put reason: The path only supports XML input/outputm which is not supported - suppress: R3016 - where: $.definitions.StorageError.properties.Message + where: $.definitions.TableServiceError.properties.Message reason: Response from service is not camel case - suppress: R3016 - where: $.definitions.StorageServiceProperties.properties.Logging + where: $.definitions.TableServiceProperties.properties.Logging reason: Response from service is not camel case - suppress: R3016 - where: $.definitions.StorageServiceProperties.properties.HourMetrics + where: $.definitions.TableServiceProperties.properties.HourMetrics reason: Response from service is not camel case - suppress: R3016 - where: $.definitions.StorageServiceProperties.properties.MinuteMetrics + where: $.definitions.TableServiceProperties.properties.MinuteMetrics reason: Response from service is not camel case - suppress: R3016 - where: $.definitions.StorageServiceProperties.properties.Cors + where: $.definitions.TableServiceProperties.properties.Cors reason: Response from service is not camel case - suppress: R3016 where: $.definitions.Logging.properties.Version @@ -123,7 +123,7 @@ directive: where: $.definitions.RetentionPolicy.properties.Days reason: Response from service is not camel case - suppress: R3016 - where: $.definitions.StorageServiceStats.properties.GeoReplication + where: $.definitions.TableServiceStats.properties.GeoReplication reason: Response from service is not camel case - suppress: R3016 where: $.definitions.GeoReplication.properties.Status @@ -211,8 +211,8 @@ python-mode: create python: license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 - namespace: azure.mgmt.media - package-name: azure-tables-storage + namespace: azure.tables + package-name: azure-tables clear-output-folder: true no-namespace-folders: true ``` From 9b8cc61f97cf5b91c2a1c63b0c090a515ea849f9 Mon Sep 17 00:00:00 2001 From: antisch Date: Thu, 7 May 2020 09:45:53 -0700 Subject: [PATCH 21/21] Remove multi-api reference --- specification/cosmos-db/data-plane/readme.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/specification/cosmos-db/data-plane/readme.md b/specification/cosmos-db/data-plane/readme.md index c6841b6c5125..6cc58e326fa6 100644 --- a/specification/cosmos-db/data-plane/readme.md +++ b/specification/cosmos-db/data-plane/readme.md @@ -217,15 +217,6 @@ python: no-namespace-folders: true ``` -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) && $(multiapi) -batch: - - tag: package-2019-02 -``` - ### Tag: package-2019-02 and python These settings apply only when `--tag=package-2019-02 --python` is specified on the command line.