-
Notifications
You must be signed in to change notification settings - Fork 5.6k
move extendedNetworkBlocks to end of PrivateCloudProperties #27036
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.
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
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| vmware.json | 2023-03-01(9fc50de) | 2023-03-01(main) |
| Rule | Message |
|---|---|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.AVS/stable/2023-03-01/vmware.json#L5816:9 Old: Microsoft.AVS/stable/2023-03-01/vmware.json#L5816:9 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.AVS/stable/2023-03-01/vmware.json#L5898:5 Old: Microsoft.AVS/stable/2023-03-01/vmware.json#L5898:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 3 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-03-01 | package-2023-03-01(9fc50de) | package-2023-03-01(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L5816 |
RPC-Policy-V1-03 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L5906 |
RPC-Policy-V1-03 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L6176 |
RPC-Policy-V1-03 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L285 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L538 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L590 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L597 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L649 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L674 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also 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. They also must not have other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L695 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L717 |
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also 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. They also must not have other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L738 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L760 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L876 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L932 |
PatchPropertiesCorrespondToPutProperties |
clusterSize property in patch body is not present in the corresponding put body. A patch request body must only contain properties present in the corresponding put request body, and must contain at least one of the properties. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L939 |
PatchPropertiesCorrespondToPutProperties |
hosts property in patch body is not present in the corresponding put body. A patch request body must only contain properties present in the corresponding put request body, and must contain at least one of the properties. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L939 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L939 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L991 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1019 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1190 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1245 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1276 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1433 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1629 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1685 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1713 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1829 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1885 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L1913 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L2068 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L2119 |
RequestBodyMustExistForPutPatch |
The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation. Location: Microsoft.AVS/stable/2023-03-01/vmware.json#L2178 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️️✔️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
|
| ], | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/PrivateCloudUpdateProperties" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The solution is remove this allOf, then copy all of the properties in, in the correct order. extendedNetworkBlocks is moved to the end.
This was a problem identified in the 2023-03-01 API when creating the .NET SDK.
Azure/azure-sdk-for-net#39536 (review)
In #24490,
extendedNetworkBlockswas added atPrivateCloudUpdateProperties. It should have been added at the end ofPrivateCloudPropertiesas well, butPrivateCloudPropertieswas using anallOf PrivateCloudUpdateProperties.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.
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
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.