merge 2023-08-01-preview API version to main repo #26239
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| arcSettings.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| arcSettings.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| clusters.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| clusters.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| extensions.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| extensions.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| offers.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| offers.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| operations.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| operations.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| publishers.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| publishers.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| skus.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| skus.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| updateRuns.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| updateRuns.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| updateSummaries.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| updateSummaries.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
| updates.json | 2023-08-01-preview(09f4249) | 2023-08-01(main) |
| updates.json | 2023-08-01-preview(09f4249) | 2022-12-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 23 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 42 Errors, 271 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2023-08 | package-preview-2023-08(09f4249) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 23 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L120 |
RPC-Async-V1-11, RPC-Put-V1-11 |
|
The property 'tags' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L189 |
RPC-Patch-V1-03 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L218 |
RPC-Delete-V1-01 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L242 |
RPC-Async-V1-07 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L351 |
RPC-Async-V1-07 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L409 |
RPC-Async-V1-11, RPC-Async-V1-14 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L441 |
RPC-Async-V1-07 |
|
Missing identifier id in array item property Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json#L607 |
|
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json#L159 |
RPC-Async-V1-11, RPC-Put-V1-11 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json#L257 |
RPC-Delete-V1-01 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json#L286 |
RPC-Async-V1-07 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json#L338 |
RPC-Async-V1-07 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json#L387 |
RPC-Async-V1-07 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json#L445 |
RPC-Async-V1-07 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/edgeDevices.json#L194 |
RPC-Delete-V1-01 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json#L227 |
RPC-Async-V1-07 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json#L247 |
RPC-Delete-V1-01 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json#L274 |
RPC-Async-V1-07 |
|
A 202 response should include an Location response header. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json#L332 |
RPC-Async-V1-07 |
|
Missing identifier id in array item property Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json#L448 |
|
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/offers.json#L134 |
RPC-Get-V1-08 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/skus.json#L92 |
RPC-Get-V1-08 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AzureStackHCI/preview/2023-08-01-preview/updateRuns.json#L83 |
RPC-Delete-V1-01 |
️❌Avocado: 34 Errors, 0 Warnings failed [Detail]
Only 23 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.AzureStackHCI/clusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/extensions is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/extensions/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/generatePassword is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/createArcIdentity is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/consentAndInstallDefaultExtensions is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/uploadCertificate is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/createClusterIdentity is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/extendSoftwareAssuranceBenefit is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/arcSettings/{}/extensions/{}/upgrade is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/publishers/{}/offers is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/offers.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/offers is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/offers.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/publishers/{}/offers/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/offers.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/publishers is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/publishers.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/publishers/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/publishers.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/publishers/{}/offers/{}/skus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/skus.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/publishers/{}/offers/{}/skus/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/skus.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/updates/{}/updateRuns is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/updateRuns.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.AzureStackHCI/clusters/{}/updates/{}/updateRuns/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/azurestackhci/resource-manager/readme.md json: Microsoft.AzureStackHCI/preview/2023-08-01-preview/updateRuns.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
|
Hi @agrbhuvnesh! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
added 2 commits
October 16, 2023 16:18
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
msyyc
added
Approved-SdkBreakingChange-Python
and removed
Approved-SdkBreakingChange-Python
labels
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
Hi @agrbhuvnesh , I'm from JS SDK team, I have some issues about your pr: 1: azurestackhci was released with apiversion 2023-09-01-preview last month, but your version is 2023-08-01-preview, and you change the default tag in readme.md from 09-01-preview to 08-01-preview. So do you want to release your tag in the future? If so, unfortunately we are not allowed to release the older version preview. 2: please fix the duplicate schema 3 @msyyc @Alancere , please help check the ci sdk generation error for python and go, thanks |
|
Hi @kazrael2119 ,
And I see that the JS SDK check is passing now.. |
qiaozha
reviewed
Nov 2, 2023
Comment on lines
+101
to
+112
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/extensions.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/offers.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/operations.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/publishers.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/skus.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/updateRuns.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/updateSummaries.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/updates.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/deploymentSettings.json | ||
| - Microsoft.AzureStackHCI/preview/2023-08-01-preview/edgeDevices.json |
There was a problem hiding this comment.
@priyjain358 Is your change for this PR just adding arcSettings, clusters, extensions back and add new resources ? If yes, could you support the 2023-09-01-preview version and add it to the package-preview-2023-09, we've already released SDK with that tag, and are not allowed to release an older version.
There was a problem hiding this comment.
With that, we could just release a minor version to add those back.
There was a problem hiding this comment.
@qiaozha, we didn't raise any SDk release request, when did we release SDK with 2023-09-01-preview version? It's still in private preview..
There was a problem hiding this comment.
We have already released 2023-08-01-preview in private and want to release it as public preview now, hence we can't include those changes in 2023-09-01-preview.
If we don't change the default tag, what are the implications? Will we be able to release SDK with 08-01-preview?
raych1
added
the
Approved-SdkBreakingChange-Go
@priyjain358 for 2, could you use different names to distinguish "cluster" and "step" in their respective files due to different definitions? |
|
/pr RequestMerge |
rkmanda
approved these changes
Nov 3, 2023
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Nov 3, 2023
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
* merge 2023-08-01-preview API version to main repo * updated words * updated readme * merged changes with 08-01 API version * update default tag * update readme * updated readme * updated readme * updated readme * minor * minor * revert sbeinfo * set default tag as 2023-08 preview * revert readme tag --------- Co-authored-by: Bhuvnesh kumar <bhukumar@microsoft.com> Co-authored-by: Priyanshi Jain <priyjain@microsoft.com>
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
* merge 2023-08-01-preview API version to main repo * updated words * updated readme * merged changes with 08-01 API version * update default tag * update readme * updated readme * updated readme * updated readme * minor * minor * revert sbeinfo * set default tag as 2023-08 preview * revert readme tag --------- Co-authored-by: Bhuvnesh kumar <bhukumar@microsoft.com> Co-authored-by: Priyanshi Jain <priyjain@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.