[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-03-01 #16744

joshdmcc · 2021-11-11T16:44:50Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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 langauge 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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 · 2021-11-11T16:44:52Z

Hi, @joshdmcc 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 · 2021-11-11T16:44:53Z

[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 · 2021-11-11T16:44:53Z

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.9.1)
- current:stable/2021-03-01/imds.json compared with base:stable/2021-03-01/imds.json

Rule	Message
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'extendedLocation' in response that was not found in the old version. New: Microsoft.InstanceMetadataService/stable/2021-03-01/imds.json#L243:7 Old: Microsoft.InstanceMetadataService/stable/2021-03-01/imds.json#L243:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'virtualMachineScaleSet' in response that was not found in the old version. New: Microsoft.InstanceMetadataService/stable/2021-03-01/imds.json#L243:7 Old: Microsoft.InstanceMetadataService/stable/2021-03-01/imds.json#L243:7

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

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- imds/data-plane/readme.md tag:package-2021-03-01
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- imds/data-plane/readme.md tag:package-2021-03-01

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

Validation passes for Avocado.

️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️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.

️️✔️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

imds/data-plane/readme.md#package-2021-03-01

️️✔️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 · 2021-11-11T16:44:54Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - imds/2019-02-01/imds - v59.2.0

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

⚠️Warning [Logs]Release - Generate from 18479a0. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] opencensus-ext-azure 1.1.0 requires azure-core<2.0.0,>=1.12.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] azure-identity 1.7.1 requires azure-core<2.0.0,>=1.11.0, but you have azure-core 1.6.0 which is incompatible.
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

️✔️azure-imds [View full logs] [Release SDK Changes]

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

⚠️Warning [Logs]Release - Generate from 18479a0. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-11-11 19:19:02 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs]Release - Generate from 18479a0. 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

️✔️imds/2019-02-01/imds [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```

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

⚠️Warning [Logs]Release - Generate from 18479a0. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/imds/data-plane/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

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

openapi-workflow-bot · 2021-11-11T16:47:09Z

Hi @joshdmcc, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

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

openapi-workflow-bot · 2021-11-11T16:47:21Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-workflow-bot · 2021-11-11T17:06:29Z

Hi @joshdmcc, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

joshdmcc · 2021-11-11T17:14:58Z

/azp run unifiedPipeline

azure-pipelines · 2021-11-11T17:15:04Z

No pipelines are associated with this pull request.

joshdmcc · 2021-11-11T18:51:05Z

@jhendrixMSFT So this PR (and a subsequent PR for version 2021-05-01) are going to be flagged as breaking changes because two fields that have been rolled out in the service were not added by mistake to their swagger versions when they were originally added. I see the "breaking change" workflow/procedure outlined above, but do we have to go through the whole process? As far as I know there is basically zero usage of these swagger docs in products, they're just used for documentation purposes.

jhendrixMSFT · 2021-11-11T18:57:37Z

@JeffreyRichter will have to answer that question.

JeffreyRichter · 2021-11-11T19:06:23Z

Swaggers are used for docs and for SDK creation in many languages. So, adding fields like this will force all new SDKs to be generated and published for customers. This is why it is important for the swaggers to be more accurate and why Azure has a breaking change review board.

In this case, I'll approve the breaking change since the swagger is changing to accurately reflect service behavior.

…to add version stable/2021-03-01 (Azure#16744) * Updating 2021-03-01 with extendedLocation and vmss ID * Trying to fix errrs * fixing property name Co-authored-by: jmccarthy <[email protected]>

Updating 2021-03-01 with extendedLocation and vmss ID

de90628

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Nov 11, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label Nov 11, 2021

openapi-sdkautomation bot mentioned this pull request Nov 11, 2021

[AutoPR azure-imds] [Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-03-01 AzureSDKAutomation/azure-sdk-for-python#8079

Closed

jmccarthy added 2 commits November 11, 2021 11:53

Trying to fix errrs

c85099c

fixing property name

b9e293e

openapi-pipeline-app bot added BreakingChangeReviewRequired and removed CI-FixRequiredOnFailure labels Nov 11, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Nov 11, 2021

openapi-pipeline-app bot removed BreakingChangeReviewRequired CI-FixRequiredOnFailure labels Nov 11, 2021

joshdmcc marked this pull request as ready for review November 11, 2021 18:47

openapi-assignment-bot bot assigned jhendrixMSFT Nov 11, 2021

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 11, 2021

jhendrixMSFT approved these changes Nov 11, 2021

View reviewed changes

jhendrixMSFT merged commit 18479a0 into Azure:main Nov 11, 2021

This was referenced Nov 11, 2021

[ReleasePR azure-imds] Add IMDS version 2021-10-01 for platformSubFaultDomain field Azure/azure-sdk-for-python#16819

Closed

[ReleasePR imds/2019-02-01/imds] Add IMDS version 2021-10-01 for platformSubFaultDomain field Azure/azure-sdk-for-go#15242

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-03-01 #16744

[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-03-01 #16744

joshdmcc commented Nov 11, 2021 •

edited

Loading

openapi-workflow-bot bot commented Nov 11, 2021

openapi-workflow-bot bot commented Nov 11, 2021

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Nov 11, 2021

openapi-workflow-bot bot commented Nov 11, 2021

openapi-workflow-bot bot commented Nov 11, 2021

joshdmcc commented Nov 11, 2021

azure-pipelines bot commented Nov 11, 2021

joshdmcc commented Nov 11, 2021

jhendrixMSFT commented Nov 11, 2021

JeffreyRichter commented Nov 11, 2021

[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-03-01 #16744

[Hub Generated] Review request for Microsoft.InstanceMetadataService to add version stable/2021-03-01 #16744

Conversation

joshdmcc commented Nov 11, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Nov 11, 2021

openapi-workflow-bot bot commented Nov 11, 2021

openapi-pipeline-app bot commented Nov 11, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Nov 11, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Nov 11, 2021

openapi-workflow-bot bot commented Nov 11, 2021

openapi-workflow-bot bot commented Nov 11, 2021

joshdmcc commented Nov 11, 2021

azure-pipelines bot commented Nov 11, 2021

joshdmcc commented Nov 11, 2021

jhendrixMSFT commented Nov 11, 2021

JeffreyRichter commented Nov 11, 2021

joshdmcc commented Nov 11, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 11, 2021 •

edited

Loading