Update Compute Diagnostic RP swagger doc API version to 2021-06-01-preview#28354
Update Compute Diagnostic RP swagger doc API version to 2021-06-01-preview#28354Elina-L wants to merge 4 commits intoAzure:mainfrom
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| diagnostic.json | 2024-03-01-preview(f3691ca) | 2024-03-01-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-03-01-preview-only | package-2024-03-01-preview-only(f3691ca) | package-2024-03-01-preview-only(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L6 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| 'GET' operation 'DiagnosticOperations_Read' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L42 |
|
| OperationId should contain the verb: 'run' in:'DiskInspection_Create'. Consider updating the operationId Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L92 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets the status of a scheduled disk inspection request. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L180 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets the status of a scheduled disk inspection request. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L219 |
|
| OperationId should contain the verb: 'registerstorageconfiguration' in:'DiskInspectionStorageConfiguration_Register'. Consider updating the operationId Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L231 |
|
| OperationId should contain the verb: 'validatestorageconfiguration' in:'DiskInspectionStorageConfiguration_Validate'. Consider updating the operationId Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L280 |
|
| OperationId should contain the verb: 'generate' in:'SpotPlacementRecommender_Post'. Consider updating the operationId Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L362 |
|
| Missing identifier id in array item property Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L557 |
|
| Missing identifier id in array item property Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L595 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L607 |
|
| Missing identifier id in array item property Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L624 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L636 |
|
| Missing identifier id in array item property Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L640 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json#L679 |
️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
INCONSISTENT_API_VERSION |
The API version of the swagger is inconsistent with its file path. readme: specification/compute/resource-manager/readme.md json: DiagnosticRP/preview/2024-03-01-preview/diagnostic.json |
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2024-03-01 |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
The PR is failing LintDiff and model validation checks because the API-version does not match the package version, should I request a temporary suppression for this PR? |
| "title": "ComputeDiagnosticResourceProviderClient", | ||
| "description": "The Compute Diagnostic Resource Provider Client", | ||
| "version": "2024-03-01-preview" | ||
| "version": "2021-06-01-preview" |
There was a problem hiding this comment.
Hi Zhenhua, this is because the new 2024-03-01-preview version is blocked by the ARM compute manifest rollout taking very long to deploy. https://msazure.visualstudio.com/One/_release?definitionId=18535&view=mine&_a=releases
Without the ARM manifest rolled out, the APIs in this swagger are unable to invoke using 2024-03-01-preview API version. This is blocking our Az PS PR from merging in by the current release milestone cutoff 3/25.
In order to unblock the PS PR, we decided to "downgrade" the API version from 2024-03-01-preview to 2021-06-01-preview. There are no code differences between the two API versions in our service and all APIs on this swagger doc function exactly the same between the two versions. We are downgrading to get the PS cmdlet unblocked, once the ARM manifest is merged, we will upgrade the version back to 2024-03-01-preview. Since there are no changes between the two versions, "upgrading" it back to the latest is only to align with ARM swagger doc conventions and not for any feature/functionality change.
If possible, please let us know if we can merge this ASAP to unblock the Az PS PR. Thank you
AzPS PR: Azure/azure-powershell#24352
There was a problem hiding this comment.
AFAIK, it's not allowed. The API version in the file should be consistent with the name of the folder which includes the file, and the content in the readme. Since 2021-06-01-preview already exists, it will cause two files point to the same API version. And since you do not update the readme, the related SDK may not be generated.
|
Please address or respond to feedback from the ARM API reviewer. |
|
Hi, @Elina-L. 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 |
|
Hi, @Elina-L. 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. |
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
The reason for this "downgrade" is because the new API version ARM manifest is still being rolled out by CRP team, but is taking longer than expected due to unforseen blockers, and this delayed rollout is blocking our targeted release for Az PS and CLI related PRs. https://msazure.visualstudio.com/One/_release?definitionId=18535&view=mine&_a=releases
Once the Compute Manifest has completed the rollout, we will "upgrade" the API version back to the latest API version.
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.