Skip to content

Update Compute Diagnostic RP swagger doc API version to 2021-06-01-preview #28354

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

Closed
Elina-L wants to merge 4 commits into from
Closed

Update Compute Diagnostic RP swagger doc API version to 2021-06-01-preview #28354

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce6527b
Initial change - update diagnostic.json version to 2021-06-01-preview
Elina-L Mar 20, 2024
7e277ba
Merge branch 'main' into wenxliu/SpotPlacementRecommenderAPIVersion20…
Elina-L Mar 20, 2024
a0e92a4
Merge branch 'main' into wenxliu/SpotPlacementRecommenderAPIVersion20…
Elina-L Mar 20, 2024
f3691ca
Merge branch 'main' into wenxliu/SpotPlacementRecommenderAPIVersion20…
Elina-L Mar 21, 2024
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
2 changes: 1 addition & 1 deletion ...esource-manager/Microsoft.Compute/DiagnosticRP/preview/2024-03-01-preview/diagnostic.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "ComputeDiagnosticResourceProviderClient",
"description": "The Compute Diagnostic Resource Provider Client",
"version": "2024-03-01-preview"
"version": "2021-06-01-preview"
Copy link
Copy Markdown
Contributor

@ms-zhenhua ms-zhenhua Mar 21, 2024

Choose a reason for hiding this comment

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

why change to 2021?

Copy link
Copy Markdown
Member Author

@Elina-L Elina-L Mar 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

@ms-zhenhua ms-zhenhua Mar 22, 2024

Choose a reason for hiding this comment

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

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.

},
"host": "management.azure.com",
"schemes": [
Expand Down