Setting the response type for AttachDetach API spec to StorageProfile#26910
Merged
grizzlytheodore merged 3 commits intoAzure:feature/cplat-2023-09-01from Dec 1, 2023
Merged
Conversation
tanishkalra08
requested review from
MS-syh2qs,
Sandido,
dkulkarni-ms,
grizzlytheodore and
haagha
as code owners
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 |
|---|---|---|
| virtualMachine.json | 2023-09-01(cb96539) | 2023-07-01(main) |
| virtualMachineScaleSet.json | 2023-09-01(cb96539) | 2023-07-01(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-09-01 | package-2023-09-01(cb96539) | package-2023-09-01(feature/cplat-2023-09-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response in the GET collection operation 'VirtualMachineRunCommands_List' does not match the response definition in the individual GET operation 'VirtualMachineRunCommands_Get' . Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L36 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L112 |
|
The async patch operation should return 202. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L156 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L177 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L216 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L245 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L344 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L457 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L700 |
|
The async patch operation should return 202. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L753 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L777 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L816 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L842 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L941 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L963 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L995 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L1017 |
|
hibernate is a query parameter. Post operation must not contain any query parameter other than api-version. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1023 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1056 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1296 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L1318 |
|
skipShutdown is a query parameter. Post operation must not contain any query parameter other than api-version. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1324 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1358 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L1380 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1412 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L1431 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1463 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L1485 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-09-01/virtualMachine.json#L1517 |
|
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: ComputeRP/stable/2023-09-01/virtualMachine.json#L1539 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2023-09-01 |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
microsoft-github-policy-service
Bot
added
the
customer-reported
Contributor
|
Thank you for your contribution tanishkalra08! We will review the pull request and get back to you soon. |
This was referenced Dec 1, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Context
As per the suggestions for POST request we shouldn't be returning a tracked object i.e VirtualMachine in this case. Changing the spec to return only the required minimal response i.e the StorageProfile.
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 (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReviewlabel.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
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] 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 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
Swagger-Suppression-Process
to get approval.
Getting help
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.