Skip to content

[Quantum] Addressing swagger completeness and correctness errors #13150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 1, 2021
Merged

[Quantum] Addressing swagger completeness and correctness errors #13150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0278b7a
[Quantum] Addressing swagger completeness and correctness errors
masenol Feb 24, 2021
c228996
Fixing errors in SpellCheck and PrettierCheck
masenol Feb 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/offeringsList.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
{
"name": "Standard",
"id": "Standard",
"version": "1.0",
"description": "Provider CPU and FPGA QIO based solver.",
"restrictedAccessUri": "https://endpoint",
"targets": [
Expand Down
19 changes: 19 additions & 0 deletions ...t.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesCheckNameAvailability.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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": ""
}
}
}
}
8 changes: 8 additions & 0 deletions ...e-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
Expand Down
8 changes: 8 additions & 0 deletions ...osoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesListResourceGroup.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
]
Expand Down
8 changes: 8 additions & 0 deletions ...rosoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesListSubscription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
]
Expand Down
8 changes: 8 additions & 0 deletions ...manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesPatch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
Expand Down
16 changes: 16 additions & 0 deletions ...e-manager/Microsoft.Quantum/preview/2019-11-04-preview/examples/quantumWorkspacesPut.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
},
Expand Down Expand Up @@ -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"
}
}
}
Expand Down
92 changes: 89 additions & 3 deletions ...cation/quantum/resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -432,6 +478,11 @@
}
}
}
},
"systemData": {
"description": "System metadata",
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"readOnly": true
}
},
"allOf": [
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -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",
Expand All @@ -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
}
}
},
Expand Down Expand Up @@ -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": {
Copy link
Member

@RamyasreeChakka RamyasreeChakka Feb 27, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@masenol Consider modeling this as enum if limited set of values are returned. If a property has a finite set of values (enforced by the service), the string property should be declared as an enum type in the Swagger (using the x-ms-enum annotation) to enable client-side input validation and discovery.
Refer API guidelines here: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html

"type": "string",
"description": "The reason of unavailability."
}
}
}
},
"parameters": {
Expand Down