[Quantum] Addressing swagger completeness and correctness errors (Azu…

…re#13150) * [Quantum] Addressing swagger completeness and correctness errors * Fixing errors in SpellCheck and PrettierCheck
mkarmark · Jul 20, 2021 · f3b775c · f3b775c
1 parent 7d53b67
commit f3b775c
Show file tree

Hide file tree

Showing 8 changed files with 157 additions and 3 deletions.
diff --git a/...resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/offeringsList.json b/...resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/offeringsList.json
@@ -24,6 +24,7 @@
                 {
                   "name": "Standard",
                   "id": "Standard",
+                  "version": "1.0",
                   "description": "Provider CPU and FPGA QIO based solver.",
                   "restrictedAccessUri": "https://endpoint",
                   "targets": [

diff --git a/...t.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesCheckNameAvailability.json b/...t.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesCheckNameAvailability.json
@@ -0,0 +1,19 @@
+{
+  "parameters": {
+    "subscriptionId": "00000000-1111-2222-3333-444444444444",
+    "api-version": "2019-11-04-preview",
+    "locationName": "westus2",
+    "checkNameAvailabilityParameters": {
+      "name": "sample-workspace-name",
+      "type": "Microsoft.Quantum/Workspaces"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "nameAvailable": true,
+        "reason": ""
+      }
+    }
+  }
+}
diff --git a/...e-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesGet.json b/...e-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesGet.json
@@ -52,6 +52,14 @@
           "type": "SystemAssigned",
           "principalId": "00000000-1111-2222-3333-444444444444",
           "tenantId": "00000000-1111-2222-3333-444444444444"
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2020-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
         }
       }
     }

diff --git a/...osoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesListResourceGroup.json b/...osoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesListResourceGroup.json
@@ -37,6 +37,14 @@
               "type": "SystemAssigned",
               "principalId": "00000000-1111-2222-3333-444444444444",
               "tenantId": "00000000-1111-2222-3333-444444444444"
+            },
+            "systemData": {
+              "createdBy": "user1",
+              "createdByType": "User",
+              "createdAt": "2020-01-01T17:18:19.1234567Z",
+              "lastModifiedBy": "user2",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
             }
           }
         ]

diff --git a/...rosoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesListSubscription.json b/...rosoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesListSubscription.json
@@ -36,6 +36,14 @@
               "type": "SystemAssigned",
               "principalId": "00000000-1111-2222-3333-444444444444",
               "tenantId": "00000000-1111-2222-3333-444444444444"
+            },
+            "systemData": {
+              "createdBy": "user1",
+              "createdByType": "User",
+              "createdAt": "2020-01-01T17:18:19.1234567Z",
+              "lastModifiedBy": "user2",
+              "lastModifiedByType": "User",
+              "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
             }
           }
         ]

diff --git a/...manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesPatch.json b/...manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesPatch.json
@@ -58,6 +58,14 @@
           "type": "SystemAssigned",
           "principalId": "00000000-1111-2222-3333-444444444444",
           "tenantId": "00000000-1111-2222-3333-444444444444"
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2020-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
         }
       }
     }

diff --git a/...e-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesPut.json b/...e-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesPut.json
@@ -72,6 +72,14 @@
           "type": "SystemAssigned",
           "principalId": "00000000-1111-2222-3333-444444444444",
           "tenantId": "00000000-1111-2222-3333-444444444444"
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2020-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
         }
       }
     },
@@ -111,6 +119,14 @@
           "type": "SystemAssigned",
           "principalId": "00000000-1111-2222-3333-444444444444",
           "tenantId": "00000000-1111-2222-3333-444444444444"
+        },
+        "systemData": {
+          "createdBy": "user1",
+          "createdByType": "User",
+          "createdAt": "2020-01-01T17:18:19.1234567Z",
+          "lastModifiedBy": "user2",
+          "lastModifiedByType": "User",
+          "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
         }
       }
     }

diff --git a/...cation/quantum/resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json b/...cation/quantum/resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json
@@ -361,6 +361,52 @@
           "nextLinkName": "nextLink"
         }
       }
+    },
+    "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability": {
+      "post": {
+        "description": "Check the availability of the resource name.",
+        "operationId": "Workspace_CheckNameAvailability",
+        "x-ms-examples": {
+          "QuantumWorkspacesCheckNameAvailability": {
+            "$ref": "./examples/quantumWorkspacesCheckNameAvailability.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "#/parameters/LocationParameter"
+          },
+          {
+            "name": "checkNameAvailabilityParameters",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/CheckNameAvailabilityParameters"
+            },
+            "description": "The name and type of the resource."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK. The request has succeeded.",
+            "schema": {
+              "$ref": "#/definitions/CheckNameAvailabilityResult"
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "deprecated": false
+      }
     }
   },
   "definitions": {
@@ -402,7 +448,7 @@
       "properties": {
         "properties": {
           "x-ms-client-flatten": true,
-          "description": "Gets or sets the properties. Define quantum space's specific properties.",
+          "description": "Gets or sets the properties. Define quantum workspace's specific properties.",
           "$ref": "#/definitions/WorkspaceResourceProperties"
         },
         "identity": {
@@ -432,6 +478,11 @@
               }
             }
           }
+        },
+        "systemData": {
+          "description": "System metadata",
+          "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+          "readOnly": true
         }
       },
       "allOf": [
@@ -654,6 +705,10 @@
           "type": "string",
           "description": "Display name of this sku."
         },
+        "version": {
+          "type": "string",
+          "description": "Display name of this sku."
+        },
         "description": {
           "type": "string",
           "description": "Description about this sku."
@@ -769,7 +824,8 @@
         },
         "applicationName": {
           "type": "string",
-          "description": "The provider's marketplace application display name."
+          "description": "The provider's marketplace application display name.",
+          "readOnly": true
         },
         "provisioningState": {
           "type": "string",
@@ -789,7 +845,8 @@
         },
         "resourceUsageId": {
           "type": "string",
-          "description": "Id to track resource usage for the provider."
+          "description": "Id to track resource usage for the provider.",
+          "readOnly": true
         }
       }
     },
@@ -848,6 +905,35 @@
       "required": [
         "value"
       ]
+    },
+    "CheckNameAvailabilityParameters": {
+      "description": "Details of check name availability request body.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name for checking availability."
+        },
+        "type": {
+          "type": "string",
+          "default": "Microsoft.Quantum/Workspaces",
+          "description": "The resource type of Quantum Workspace."
+        }
+      }
+    },
+    "CheckNameAvailabilityResult": {
+      "description": "Result of check name availability.",
+      "type": "object",
+      "properties": {
+        "nameAvailable": {
+          "type": "boolean",
+          "description": "Indicator of availability of the Quantum Workspace resource name."
+        },
+        "reason": {
+          "type": "string",
+          "description": "The reason of unavailability."
+        }
+      }
     }
   },
   "parameters": {