Dataplane swagger for tables (#8151)

* adding swagger for tables dataplane * updating produces/consumes, adding format parameter and adding DataServiceVersion header * update swagger so that query parameters do not appear in x-ms-paths * add new custom words, fix incorrect api version * making suggested changes to continuation header, response status codes * Updates to tables spec * Fixed indentation * Removed storage references * Grammar * Improved match condition description * Remove format statements * Removed excess tags * Fix extra commas * Added missing example * Updated Delete example * Run prettier * Removed duplicate API version * Fixed insert response * Removed 2018 readme tag * Remove storage name * Remove multi-api reference Co-authored-by: Sam Hurd <[email protected]> Co-authored-by: annatisch <[email protected]>
Azure · May 8, 2020 · f8b92e8 · f8b92e8
1 parent 6871a33
commit f8b92e8
Show file tree

Hide file tree

Showing 15 changed files with 2,440 additions and 0 deletions.
diff --git a/custom-words.txt b/custom-words.txt
@@ -562,6 +562,7 @@ Français
 frontdoor
 fsaction
 Fulfilment
+fullmetadata
 Fulltext
 fullyqualified
 functionappsettings
@@ -980,6 +981,7 @@ nodeconfiguration
 nodecounts
 Nodeploy
 nodrm
+nometadata
 nonadmin
 NONCLUSTERED
 nonincreasing
@@ -1253,6 +1255,7 @@ resourcetype
 Responsys
 restoreheartbeat
 Restproxy
+restype
 resumable
 resync
 resynchronization

diff --git a/...cation/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableCreate.json b/...cation/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableCreate.json
@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "x-ms-version": "2019-02-02",
+    "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/...cation/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDelete.json b/...cation/cosmos-db/data-plane/Microsoft.Tables/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/.../cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDeleteEntity.json b/.../cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableDeleteEntity.json
@@ -0,0 +1,14 @@
+{
+  "parameters": {
+    "x-ms-version": "2019-02-02",
+    "DataServiceVersion": "3.0",
+    "If-Match": "*",
+    "url": "myaccount.table.core.windows.net",
+    "table": "Customers",
+    "partitionKey": "mypartitionkey",
+    "rowKey": "myrowkey"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...ification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableGet.json b/...ification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableGet.json
@@ -0,0 +1,23 @@
+{
+  "parameters": {
+    "x-ms-version": "2019-02-02",
+    "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/.../cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableInsertEntity.json b/.../cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableInsertEntity.json
@@ -0,0 +1,48 @@
+{
+  "parameters": {
+    "x-ms-version": "2019-02-02",
+    "DataServiceVersion": "3.0",
+    "table": "Customer",
+    "url": "myaccount.table.core.windows.net",
+    "tableEntityProperties": {
+      "Address": "Mountain View",
+      "Age": 23,
+      "AmountDue": 200.23,
+      "[email protected]": "Edm.Guid",
+      "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833",
+      "[email protected]": "Edm.DateTime",
+      "CustomerSince": "2008-07-10T00:00:00",
+      "IsActive": true,
+      "[email protected]": "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",
+        "[email protected]": "Edm.DateTime",
+        "Timestamp": "2013-08-22T01:12:06.2608595Z",
+        "Address": "Mountain View",
+        "Age": 23,
+        "AmountDue": 200.23,
+        "[email protected]": "Edm.Guid",
+        "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833",
+        "[email protected]": "Edm.DateTime",
+        "CustomerSince": "2008-07-10T00:00:00",
+        "IsActive": true,
+        "[email protected]": "Edm.Int64",
+        "NumberOfOrders": "255"
+      }
+    },
+    "204": {}
+  }
+}
diff --git a/...n/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableMergeEntity.json b/...n/cosmos-db/data-plane/Microsoft.Tables/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,
+      "[email protected]": "Edm.Guid",
+      "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833",
+      "[email protected]": "Edm.DateTime",
+      "CustomerSince": "2008-07-10T00:00:00",
+      "IsActive": false,
+      "[email protected]": "Edm.Int64",
+      "NumberOfOrders": "255",
+      "PartitionKey": "mypartitionkey",
+      "RowKey": "myrowkey"
+    }
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableQueryEntities.json b/...cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableQueryEntities.json
@@ -0,0 +1,30 @@
+{
+  "parameters": {
+    "x-ms-version": "2019-02-02",
+    "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')",
+            "[email protected]": "Edm.DateTime",
+            "Timestamp": "2013-08-22T00:20:16.3134645Z",
+            "[email protected]": "Edm.DateTime",
+            "CustomerSince": "2008-10-01T15:25:05.2852025Z"
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/...icrosoft.Tables/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json b/...icrosoft.Tables/preview/2019-02-02/examples/TableQueryEntitiesWithPartitionAndRowKey.json
@@ -0,0 +1,31 @@
+{
+  "parameters": {
+    "x-ms-version": "2019-02-02",
+    "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",
+            "[email protected]": "Edm.DateTime",
+            "Timestamp": "2013-08-22T00:20:16.3134645Z",
+            "[email protected]": "Edm.DateTime",
+            "CustomerSince": "2008-10-01T15:25:05.2852025Z"
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/.../cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableUpdateEntity.json b/.../cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/examples/TableUpdateEntity.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,
+      "[email protected]": "Edm.Guid",
+      "CustomerCode": "c9da6455-213d-42c9-9a79-3e9149a57833",
+      "[email protected]": "Edm.DateTime",
+      "CustomerSince": "2008-07-10T00:00:00",
+      "IsActive": false,
+      "[email protected]": "Edm.Int64",
+      "NumberOfOrders": "255",
+      "PartitionKey": "mypartitionkey",
+      "RowKey": "myrowkey"
+    }
+  },
+  "responses": {
+    "204": {}
+  }
+}