-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[Hub Generated] Review request for Microsoft.ContainerService/aks to add version preview/2023-10-02-preview #26610
[Hub Generated] Review request for Microsoft.ContainerService/aks to add version preview/2023-10-02-preview #26610
Conversation
…eview/2023-09-02-preview to version 2023-10-02-preview
* Add flexible virtualMachines profile and status to AP properties * add new line * fix * fix --------- Co-authored-by: Wenjun Gao <wenjungao@microsoft.com>
…6415) * Adding privatedns to allowedresource types for dnsZoneResourceIds * fix style
* impl * fix * fix * fix * fix * fix
* update CRGID definition * change CRGID to CapacityReservationGroupID --------- Co-authored-by: tong chen <tonche@microsoft.com>
Co-authored-by: Mikolaj Umanski <mumanski@microsoft.com>
* impl * fix * fix * fix * fix * fix --------- Co-authored-by: Wen Huang <wenhuang@microsoft.com>
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 |
---|---|---|
managedClusters.json | 2023-10-02-preview(79de171) | 2023-10-01(main) |
managedClusters.json | 2023-10-02-preview(79de171) | 2023-09-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version has a different format than the previous one. New: aks/preview/2023-10-02-preview/managedClusters.json#L4063:9 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3792:9 |
|
The new version has a different format than the previous one. New: aks/preview/2023-10-02-preview/managedClusters.json#L4063:9 Old: aks/preview/2023-09-02-preview/managedClusters.json#L3792:9 |
|
The new version has a different format than the previous one. New: aks/preview/2023-10-02-preview/managedClusters.json#L8270:5 Old: aks/preview/2023-09-02-preview/managedClusters.json#L7998:5 |
|
The new version is missing a property found in the old version. Was 'expanders' renamed or removed? New: aks/preview/2023-10-02-preview/managedClusters.json#L5538:11 Old: aks/preview/2023-09-02-preview/managedClusters.json#L5261:11 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 42 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-preview-2023-10 | package-preview-2023-10(79de171) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
The response of operation:'Machines_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1458 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2478 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2481 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2484 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2523 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2526 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2529 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2535 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2568 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2571 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2574 |
||
Use the latest version v5 of types.json. Location: aks/preview/2023-10-02-preview/managedClusters.json#L2583 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get OperationStatusResult Location: aks/preview/2023-10-02-preview/managedClusters.json#L2600 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L3968 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: aks/preview/2023-10-02-preview/managedClusters.json#L4680 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L4683 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: aks/preview/2023-10-02-preview/managedClusters.json#L4709 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L5515 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L5544 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L5549 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L5554 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L5846 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L7136 |
||
Schema should have a description or title. Location: aks/preview/2023-10-02-preview/managedClusters.json#L7153 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L7156 |
||
Schema should have a description or title. Location: aks/preview/2023-10-02-preview/managedClusters.json#L7163 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L7166 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L7485 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L7771 |
||
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: aks/preview/2023-10-02-preview/managedClusters.json#L7831 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/preview/2023-10-02-preview/managedClusters.json#L52 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: aks/preview/2023-10-02-preview/managedClusters.json#L53 |
ParametersInPointGet |
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/preview/2023-10-02-preview/managedClusters.json#L80 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-10-02-preview/managedClusters.json#L137 |
ResourceNameRestriction |
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-10-02-preview/managedClusters.json#L278 |
ParametersInPost |
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-10-02-preview/managedClusters.json#L336 |
ParametersInPost |
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-10-02-preview/managedClusters.json#L381 |
ParametersInPost |
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-10-02-preview/managedClusters.json#L381 |
ParametersInPost |
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-10-02-preview/managedClusters.json#L429 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L553 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: aks/preview/2023-10-02-preview/managedClusters.json#L660 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: aks/preview/2023-10-02-preview/managedClusters.json#L679 |
LroPatch202 |
The async patch operation should return 202. Location: aks/preview/2023-10-02-preview/managedClusters.json#L689 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L699 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L749 |
ResourceNameRestriction |
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-10-02-preview/managedClusters.json#L809 |
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: aks/preview/2023-10-02-preview/managedClusters.json#L979 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1023 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1175 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1291 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1510 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-10-02-preview/managedClusters.json#L1530 |
PostResponseCodes |
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: aks/preview/2023-10-02-preview/managedClusters.json#L1549 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1595 |
PostResponseCodes |
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: aks/preview/2023-10-02-preview/managedClusters.json#L1611 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1658 |
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: aks/preview/2023-10-02-preview/managedClusters.json#L1674 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1715 |
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: aks/preview/2023-10-02-preview/managedClusters.json#L1731 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-10-02-preview/managedClusters.json#L1768 |
️️✔️
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.
️️✔️
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
|
Why is this being modeled as POST? Can you add some context? Instead can you use DELETE? Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-10-02-preview/managedClusters.json:1352 in 79de171. [](commit_id = 79de171, deletion_comment = False) |
Please address or respond to feedback from the ARM API reviewer. |
The above link is a very similar API in VMSS, where user can delete multiple instances from VMSS. The reason we model it as post is 1. We want to align with current VMSS implementation. 2. Since we want to delete multiple machines from an agent pool, user need to provide a list of machine names like |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
@raych1 could you please help approve the SDK breaking change - go? |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to 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 help
section 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)
ARMReview
label.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 ApiView
comment 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.