[Please do not merge after approval] Ashwinm/add aliases version #18612

ashwinmayya · 2022-04-08T01:08:34Z

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

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a 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.

openapi-workflow-bot · 2022-04-08T01:08:36Z

Hi, @ashwinmayya 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. [email protected]

openapi-workflow-bot · 2022-04-08T01:08:37Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-04-08T01:08:37Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.12.2 , classic-openapi-validator v1.2.3 )
- quantum/resource-manager/readme.md tag:package-2022-04-05-preview
Linted configuring files (Based on target branch, openapi-validator v1.12.2 , classic-openapi-validator v1.2.3 )
- quantum/resource-manager/readme.md tag:default

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4037 - MissingTypeObject	The schema 'WorkspaceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L418
`❌` R4037 - MissingTypeObject	The schema 'OfferingsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L434
`❌` R4037 - MissingTypeObject	The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L499
`❌` R4037 - MissingTypeObject	The schema 'WorkspaceResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L511
`❌` R4037 - MissingTypeObject	The schema 'operation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L868
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoAdd Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L733
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L944
⚠️ R4006 - DeprecatedXmsCodeGenerationSetting	The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Quantum/preview/2022-04-05-preview/quantum.json#L6

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

Validation passes for Avocado.

️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'Operations' could not be found in the namespace 'Microsoft.Quantum' for api version '2022-04-05-preview'. The supported api-versions are '2019-11-04-preview'."

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2022-04-05-preview/quantum.json compared with base:preview/2022-01-10-preview/quantum.json

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

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

quantum/resource-manager/readme.md#package-2022-04-05-preview

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

openapi-pipeline-app · 2022-04-08T01:08:37Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go-track2 - armquantum - 0.3.0

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-quantum - 1.0.0b2
️✔️azure-sdk-for-go - preview/quantum/mgmt/2019-11-04-preview/quantum - v63.1.0

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

⚠️Warning [Logs] Generate from 211006238f3b07a46f938d8920e6bafc9dc64374. 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] [Preview SDK Changes]

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

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

️✔️Succeeded [Logs] Generate from 211006238f3b07a46f938d8920e6bafc9dc64374. SDK Automation 14.0.0

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../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] [Preview SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

️✔️Succeeded [Logs] Generate from 211006238f3b07a46f938d8920e6bafc9dc64374. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️armquantum [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `ErrorDetail.MarshalJSON` has been removed
info	[Changelog] - Struct `ErrorAdditionalInfo` has been removed
info	[Changelog] - Struct `ErrorDetail` has been removed
info	[Changelog] - Struct `ErrorResponse` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `Aliases` in struct `TargetDescription`
info	[Changelog] - New field `AutoAdd` in struct `SKUDescription`
info	[Changelog]
info	[Changelog] Total 7 breaking change(s), 2 additive change(s).

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs] Generate from 211006238f3b07a46f938d8920e6bafc9dc64374. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh]  @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-quantum [View full logs] [Preview SDK Changes]

azure-arm-quantum-1.0.0-beta.1.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

openapi-workflow-bot · 2022-04-08T01:08:38Z

Hi, @ashwinmayya your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

ashwinmayya · 2022-04-08T01:09:51Z

...ification/quantum/resource-manager/Microsoft.Quantum/preview/2022-04-05-preview/quantum.json

+          "description": "The list of aliases for the target.",
+          "items": {
+            "type": "string"
+          }


This is the only new change from previous version - a new property "aliases" is being added

openapi-workflow-bot · 2022-04-08T01:11:10Z

Hi @ashwinmayya, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

ashwinmayya · 2022-04-12T18:39:15Z

Important: Please do NOT merge after approval

ghost · 2022-05-01T16:01:43Z

Hi, @ashwinmayya. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

ghost · 2022-05-16T05:02:04Z

Hi, @ashwinmayya. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

markcowl and others added 4 commits August 21, 2019 19:39

Add blockchain to latest profile

1bcc20d

Add additional types

7b46097

Merge branch 'Azure:main' into main

1504010

Add new version with target aliases

8bbef44

openapi-assignment-bot bot assigned lirenhe Apr 8, 2022

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 8, 2022

ashwinmayya commented Apr 8, 2022

View reviewed changes

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Apr 8, 2022

ashwinmayya requested a review from shenyingjun April 8, 2022 01:11

openapi-pipeline-app bot added the CI-BreakingChange-Go-V2 label Apr 8, 2022

This was referenced Apr 8, 2022

[AutoPR track2_azure-mgmt-quantum] Ashwinm/add aliases version AzureSDKAutomation/azure-sdk-for-python#9936

Draft

[AutoPR @azure/arm-quantum] Ashwinm/add aliases version AzureSDKAutomation/azure-sdk-for-js#8470

Draft

Fix Avocado

25bff8c

ashwinmayya removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 8, 2022

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Apr 8, 2022

lirenhe added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 8, 2022

ashwinmayya changed the title ~~Ashwinm/add aliases version~~ [Please do not merge after approval] Ashwinm/add aliases version Apr 12, 2022

ghost added the no-recent-activity label May 1, 2022

ghost closed this May 16, 2022

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Please do not merge after approval] Ashwinm/add aliases version #18612

[Please do not merge after approval] Ashwinm/add aliases version #18612

ashwinmayya commented Apr 8, 2022 •

edited

Loading

openapi-workflow-bot bot commented Apr 8, 2022

openapi-workflow-bot bot commented Apr 8, 2022

openapi-pipeline-app bot commented Apr 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Apr 8, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Apr 8, 2022

ashwinmayya Apr 8, 2022 •

edited

Loading

openapi-workflow-bot bot commented Apr 8, 2022

ashwinmayya commented Apr 12, 2022

ghost commented May 1, 2022

ghost commented May 16, 2022

[Please do not merge after approval] Ashwinm/add aliases version #18612

[Please do not merge after approval] Ashwinm/add aliases version #18612

Conversation

ashwinmayya commented Apr 8, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Apr 8, 2022

openapi-workflow-bot bot commented Apr 8, 2022

openapi-pipeline-app bot commented Apr 8, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 8, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Apr 8, 2022

ashwinmayya Apr 8, 2022 • edited Loading

Choose a reason for hiding this comment

openapi-workflow-bot bot commented Apr 8, 2022

ashwinmayya commented Apr 12, 2022

Important: Please do NOT merge after approval

ghost commented May 1, 2022

ghost commented May 16, 2022

ashwinmayya commented Apr 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Apr 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Apr 8, 2022 •

edited

Loading

ashwinmayya Apr 8, 2022 •

edited

Loading