[Quantum] Fixing correctness issue regarding the CheckNameAvailability #13360

masenol · 2021-03-10T00:08:19Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…y API

openapi-pipeline-app · 2021-03-10T00:09:04Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

Compared Swaggers (Based on Oad v0.8.7)
- original: preview/2019-11-04-preview/quantum.json <---> new: preview/2019-11-04-preview/quantum.json

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- quantum/resource-manager/readme.md tag:package-2019-11-04-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- quantum/resource-manager/readme.md tag:package-2019-11-04-preview

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 11 Warnings warning [Detail]

Only 10 items are listed, please refer to log for more details.

The following tags are being changed in this PR

quantum/resource-manager/readme.md#package-2019-11-04-preview

Rule	Message
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'WorkspaceListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'OfferingsListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'TagsObject' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'WorkspaceResourceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"quantum/resource-manager/readme.md", "tag":"package-2019-11-04-preview", "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-03-10T00:09:05Z

Hi, @masenol Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-03-10T00:09:05Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 73ff802. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/quantum/resource-manager/readme.md
warn	No package detected after generation

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 73ff802. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-quantum [View full logs] [Release SDK Changes]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model SkuDescription has a new parameter version
info	[Changelog]   - Model SkuDescription has a new parameter restricted_access_uri
info	[Changelog]   - Model QuantumWorkspace has a new parameter system_data
info	[Changelog]   - Added operation group WorkspaceOperations

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 73ff802. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️preview/quantum/mgmt/2019-11-04-preview/quantum [View full logs] [Release SDK Changes]

info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `Application`
info	[Changelog] - New const `ManagedIdentity`
info	[Changelog] - New const `User`
info	[Changelog] - New const `Key`
info	[Changelog] - New function `WorkspaceClient.CheckNameAvailabilityPreparer(context.Context, string, CheckNameAvailabilityParameters) (*http.Request, error)`
info	[Changelog] - New function `NewWorkspaceClient(string) WorkspaceClient`
info	[Changelog] - New function `NewWorkspaceClientWithBaseURI(string, string) WorkspaceClient`
info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
info	[Changelog] - New function `WorkspaceClient.CheckNameAvailabilitySender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `WorkspaceClient.CheckNameAvailability(context.Context, string, CheckNameAvailabilityParameters) (CheckNameAvailabilityResult, error)`
info	[Changelog] - New function `CheckNameAvailabilityResult.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `WorkspaceClient.CheckNameAvailabilityResponder(*http.Response) (CheckNameAvailabilityResult, error)`
info	[Changelog] - New struct `CheckNameAvailabilityParameters`
info	[Changelog] - New struct `CheckNameAvailabilityResult`
info	[Changelog] - New struct `SystemData`
info	[Changelog] - New struct `WorkspaceClient`
info	[Changelog] - New field `Version` in struct `SkuDescription`
info	[Changelog] - New field `RestrictedAccessURI` in struct `SkuDescription`
info	[Changelog] - New field `SystemData` in struct `Workspace`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 22 additive change(s).
info	[Changelog]

️🔄[Staging] ApiDocPreview inProgress [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

masenol · 2021-03-10T00:09:11Z

This is to address the swagger correctness issue raised via S360 here: https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=23BA89E4-C70E-4B37-930C-DCD209EBDA37

njuCZ · 2021-03-10T02:32:31Z

@masenol I think the property "message" is a readonly field?

masenol · 2021-03-10T17:22:37Z

@njuCZ I just added the read-only property.

Azure#13360) * [Quantum] Fixing correctness issue regarding the CheckNameAvailability API * Adding read-only property

[Quantum] Fixing correctness issue regarding the CheckNameAvailabilit…

6c2b778

…y API

openapi-assignment-bot bot assigned njuCZ Mar 10, 2021

openapi-workflow-bot bot added the FixS360 label Mar 10, 2021

openapi-sdkautomation bot mentioned this pull request Mar 10, 2021

[AutoPR track2_azure-mgmt-quantum] [Quantum] Fixing correctness issue regarding the CheckNameAvailability AzureSDKAutomation/azure-sdk-for-python#4567

Closed

Adding read-only property

a53aae6

njuCZ approved these changes Mar 12, 2021

View reviewed changes

njuCZ merged commit 73ff802 into Azure:master Mar 12, 2021

vxfield mentioned this pull request Jun 14, 2021

Update Microsoft.Azure.Management.Quantum from latest swagger Azure/azure-sdk-for-net#21842

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Quantum] Fixing correctness issue regarding the CheckNameAvailability #13360

[Quantum] Fixing correctness issue regarding the CheckNameAvailability #13360

masenol commented Mar 10, 2021

openapi-pipeline-app bot commented Mar 10, 2021 •

edited

Loading

openapi-workflow-bot bot commented Mar 10, 2021

openapi-pipeline-app bot commented Mar 10, 2021 •

edited

Loading

masenol commented Mar 10, 2021

njuCZ commented Mar 10, 2021

masenol commented Mar 10, 2021 •

edited

Loading

[Quantum] Fixing correctness issue regarding the CheckNameAvailability #13360

[Quantum] Fixing correctness issue regarding the CheckNameAvailability #13360

Conversation

masenol commented Mar 10, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Mar 10, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Mar 10, 2021

openapi-pipeline-app bot commented Mar 10, 2021 • edited Loading

Swagger Generation Artifacts

masenol commented Mar 10, 2021

njuCZ commented Mar 10, 2021

masenol commented Mar 10, 2021 • edited Loading

openapi-pipeline-app bot commented Mar 10, 2021 •

edited

Loading

openapi-pipeline-app bot commented Mar 10, 2021 •

edited

Loading

masenol commented Mar 10, 2021 •

edited

Loading