Initial review of the swagger json for DataBox (#2772)

* swagger json swagger for DataBox service * gets or sets removal gets or sets removal from comments * Fixed linter validations * Added examples Added examples for all the service apis. * Fixed OAV validations Fixed all OAV validation related * Removing the internal api Removing the internal api that is only being used by the runner service and should not be visible to customers.
Azure · Apr 18, 2018 · 7b0ce29 · 7b0ce29
1 parent fd59e73
commit 7b0ce29
Show file tree

Hide file tree

Showing 18 changed files with 3,359 additions and 0 deletions.
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json
diff --git a/...esource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json b/...esource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json
@@ -0,0 +1,21 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "sdktest5497",
+    "api-version": "2018-01-01",
+    "shipmentPickUpRequest": {
+      "startTime": "2018-04-15T18:30:00Z",
+      "endTime": "2018-04-17T18:30:00Z",
+      "shipmentLocation": "Front desk"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "confirmationNumber": "2929602E9CP",
+        "readyByTime": "2023-04-19T00:00:00Z"
+      }
+    }
+  }
+}
diff --git a/...on/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json b/...on/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "SdkJob8558",
+    "api-version": "2018-01-01",
+    "$expand": "details",
+    "cancellationReason": {
+      "reason": "CancelTest"
+    }
+  },
+  "responses": {
+    "204": {
+      "body": ""
+    }
+  }
+}
diff --git a/...on/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json b/...on/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json
@@ -0,0 +1,80 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "SdkJob8558",
+    "api-version": "2018-01-01",
+    "jobResource": {
+      "properties": {
+        "destinationAccountDetails": [
+          {
+            "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus"
+          }
+        ],
+        "details": {
+          "contactDetails": {
+            "contactName": "Public SDK Test",
+            "phone": "1234567890",
+            "phoneExtension": "1234",
+            "emailList": [
+              "testing@microsoft.com"
+            ]
+          },
+          "shippingAddress": {
+            "streetAddress1": "16 TOWNSEND ST",
+            "streetAddress2": "Unit 1",
+            "city": "San Francisco",
+            "stateOrProvince": "CA",
+            "country": "US",
+            "postalCode": "94107",
+            "companyName": "Microsoft",
+            "addressType": "Commercial"
+          }
+        }
+      },
+      "location": "westus",
+      "sku": {
+        "name": "DataBox"
+      }
+    }
+  },
+  "responses": {
+    "202": {
+      "body": ""
+    },
+    "200": {
+      "body": {
+        "properties": {
+          "deviceType": "Pod",
+          "isCancellable": true,
+          "isShippingAddressEditable": true,
+          "status": "DeviceOrdered",
+          "startTime": "2018-04-13T16:28:38.9999793+05:30",
+          "deliveryPackage": {
+            "carrierName": "",
+            "trackingId": "",
+            "trackingUrl": ""
+          },
+          "returnPackage": {
+            "carrierName": "",
+            "trackingId": "",
+            "trackingUrl": ""
+          },
+          "destinationAccountDetails": [
+            {
+              "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus"
+            }
+          ]
+        },
+        "location": "westus",
+        "tags": {},
+        "sku": {
+          "name": "DataBox"
+        },
+        "name": "SdkJob8558",
+        "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558",
+        "type": "Microsoft.DataBox/jobs"
+      }
+    }
+  }
+}
diff --git a/...on/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json b/...on/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json
@@ -0,0 +1,14 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "SdkJob8558",
+    "api-version": "2018-01-01",
+    "$expand": "details"
+  },
+  "responses": {
+    "204": {
+      "body": ""
+    }
+  }
+}
diff --git a/...e-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json b/...e-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json
@@ -0,0 +1,15 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "sdktest5497",
+    "api-version": "2018-01-01"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "shippingLabelSasUri": "https://wusintd2cis2secx0fo9.blob.core.windows.net/dummycontainer/1Z12345E8791315509.PDF?sv=2016-05-31&sr=b&sig=ijNPoWPcbt0BNxTCK9p6nta4jsOr2hzJpgWyyE7AU0k%3D&st=2018-04-16T04%3A42%3A31Z&se=2018-04-16T05%3A12%3A31Z&sp=r"
+      }
+    }
+  }
+}
diff --git a/...ation/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json b/...ation/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json
@@ -0,0 +1,142 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "SdkJob8558",
+    "api-version": "2018-01-01",
+    "$expand": "details"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "deviceType": "Pod",
+          "isCancellable": true,
+          "isShippingAddressEditable": true,
+          "status": "DeviceOrdered",
+          "startTime": "2018-04-13T16:28:38.9999793+05:30",
+          "deliveryPackage": {
+            "carrierName": "",
+            "trackingId": "",
+            "trackingUrl": ""
+          },
+          "returnPackage": {
+            "carrierName": "",
+            "trackingId": "",
+            "trackingUrl": ""
+          },
+          "destinationAccountDetails": [
+            {
+              "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus"
+            }
+          ],
+          "details": {
+            "copyProgress": [
+              {
+                "storageAccountName": "kvtestwus",
+                "bytesSentToCloud": 0,
+                "totalBytesToProcess": 0
+              }
+            ],
+            "jobStages": [
+              {
+                "stageName": "DeviceOrdered",
+                "displayName": "Ordered",
+                "stageStatus": "Succeeded",
+                "stageTime": "2018-04-13T16:28:41.1669459+05:30"
+              },
+              {
+                "stageName": "DevicePrepared",
+                "displayName": "Processed",
+                "stageStatus": "None"
+              },
+              {
+                "stageName": "Dispatched",
+                "displayName": "Dispatched",
+                "stageStatus": "None"
+              },
+              {
+                "stageName": "Delivered",
+                "displayName": "Delivered",
+                "stageStatus": "None"
+              },
+              {
+                "stageName": "PickedUp",
+                "displayName": "Picked up",
+                "stageStatus": "None"
+              },
+              {
+                "stageName": "AtAzureDC",
+                "displayName": "Received",
+                "stageStatus": "None"
+              },
+              {
+                "stageName": "DataCopy",
+                "displayName": "Data copy in progress",
+                "stageStatus": "None"
+              },
+              {
+                "stageName": "Completed",
+                "displayName": "Completed",
+                "stageStatus": "None"
+              }
+            ],
+            "contactDetails": {
+              "contactName": "Public SDK Test",
+              "phone": "1234567890",
+              "phoneExtension": "1234",
+              "emailList": [
+                "testing@microsoft.com"
+              ],
+              "notificationPreference": [
+                {
+                  "stageName": "DevicePrepared",
+                  "sendNotification": true
+                },
+                {
+                  "stageName": "Dispatched",
+                  "sendNotification": true
+                },
+                {
+                  "stageName": "Delivered",
+                  "sendNotification": true
+                },
+                {
+                  "stageName": "PickedUp",
+                  "sendNotification": true
+                },
+                {
+                  "stageName": "AtAzureDC",
+                  "sendNotification": true
+                },
+                {
+                  "stageName": "DataCopy",
+                  "sendNotification": true
+                }
+              ]
+            },
+            "shippingAddress": {
+              "streetAddress1": "16 TOWNSEND ST",
+              "streetAddress2": "Unit 1",
+              "city": "San Francisco",
+              "stateOrProvince": "CA",
+              "country": "US",
+              "postalCode": "94107",
+              "companyName": "Microsoft",
+              "addressType": "Commercial"
+            },
+            "errorDetails": []
+          }
+        },
+        "location": "westus",
+        "tags": {},
+        "sku": {
+          "name": "DataBox"
+        },
+        "name": "SdkJob8558",
+        "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558",
+        "type": "Microsoft.DataBox/jobs"
+      }
+    }
+  }
+}
diff --git a/...ox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json b/...ox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json
@@ -0,0 +1,21 @@
+{
+  "parameters": {
+    "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f",
+    "resourceGroupName": "SdkRg2508",
+    "jobName": "sdktest5497",
+    "api-version": "2018-01-01"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "copyLogDetails": [
+          {
+            "accountName": "devicemanagertest1",
+            "copyLogLink": "test1234",
+            "copyLogDetailsType": "Pod"
+          }
+        ]
+      }
+    }
+  }
+}