[Hub Generated] Review request for Microsoft.ContainerService/aks to add version preview/2023-05-02-preview #24245
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
…eview/2023-04-02-preview to version 2023-05-02-preview
FumingZhang
requested review from
msyyc,
Wzb123456789,
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
|
Hi, @FumingZhang Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| managedClusters.json | 2023-05-02-preview(ccbc48f) | 2023-04-01(main) |
| managedClusters.json | 2023-05-02-preview(ccbc48f) | 2023-04-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 adds a response code '201'. New: aks/preview/2023-05-02-preview/managedClusters.json#L891:11 |
|
| The new version adds a response code '201'. New: aks/preview/2023-05-02-preview/managedClusters.json#L1936:11 |
|
| The new version adds a response code '201'. New: aks/preview/2023-05-02-preview/managedClusters.json#L3040:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 15 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-preview-2023-05 | package-preview-2023-05(ccbc48f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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-05-02-preview/managedClusters.json#L3360 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: aks/preview/2023-05-02-preview/managedClusters.json#L3918 |
||
| 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-05-02-preview/managedClusters.json#L3921 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: aks/preview/2023-05-02-preview/managedClusters.json#L3947 |
||
| 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-05-02-preview/managedClusters.json#L4753 |
||
| 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-05-02-preview/managedClusters.json#L5046 |
||
| 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-05-02-preview/managedClusters.json#L6348 |
||
| 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-05-02-preview/managedClusters.json#L6854 |
||
| 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-05-02-preview/managedClusters.json#L6900 |
||
| 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-05-02-preview/managedClusters.json#L7112 |
||
| 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-05-02-preview/managedClusters.json#L7272 |
||
| Schema should have a description or title. Location: aks/preview/2023-05-02-preview/managedClusters.json#L7520 |
||
| 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-05-02-preview/managedClusters.json#L7523 |
||
| 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-05-02-preview/managedClusters.json#L7756 |
||
| 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-05-02-preview/managedClusters.json#L7909 |
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 schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/preview/2023-05-02-preview/managedClusters.json#L52 |
|
Operations API path must follow the schema provided in the common types. Location: aks/preview/2023-05-02-preview/managedClusters.json#L53 |
|
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/preview/2023-05-02-preview/managedClusters.json#L80 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-05-02-preview/managedClusters.json#L103 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-05-02-preview/managedClusters.json#L137 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-05-02-preview/managedClusters.json#L260 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-05-02-preview/managedClusters.json#L278 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-05-02-preview/managedClusters.json#L336 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-05-02-preview/managedClusters.json#L381 |
|
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-05-02-preview/managedClusters.json#L381 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2023-05-02-preview/managedClusters.json#L429 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L553 |
|
LRO PATCH must have 200 and 202 return codes. Location: aks/preview/2023-05-02-preview/managedClusters.json#L648 |
|
The patch operation body parameter schema should contain property 'identity'. Location: aks/preview/2023-05-02-preview/managedClusters.json#L667 |
|
The patch operation body parameter schema should contain property 'sku'. Location: aks/preview/2023-05-02-preview/managedClusters.json#L667 |
|
The async patch operation should return 202. Location: aks/preview/2023-05-02-preview/managedClusters.json#L677 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L687 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L737 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-05-02-preview/managedClusters.json#L797 |
|
A LRO POST operation must have both 200 & 202 return codes. Location: aks/preview/2023-05-02-preview/managedClusters.json#L967 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1018 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1181 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1298 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-05-02-preview/managedClusters.json#L1347 |
|
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-05-02-preview/managedClusters.json#L1370 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2023-05-02-preview/managedClusters.json#L1390 |
|
200 response for a LRO POST operation must have a response schema specified. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1409 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1455 |
|
200 response for a LRO POST operation must have a response schema specified. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1471 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2023-05-02-preview/managedClusters.json#L1518 |
️❌Avocado: 9 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.ContainerService/openShiftManagedClusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2019-10-27-preview/openShiftManagedClusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/openShiftManagedClusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2019-10-27-preview/openShiftManagedClusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/openShiftManagedClusters/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2019-10-27-preview/openShiftManagedClusters.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/fleets/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2022-09-02-preview/fleets.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/fleets is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2022-09-02-preview/fleets.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.ContainerService/fleets is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2022-09-02-preview/fleets.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/fleets/{}/members/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2022-09-02-preview/fleets.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/fleets/{}/members is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2022-09-02-preview/fleets.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerService/fleets/{}/listCredentials is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: resource-manager/Microsoft.ContainerService/aks/readme.md json: aks/preview/2022-09-02-preview/fleets.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
new-api-version
resource-manager
WaitForARMFeedback
|
Hi @FumingZhang, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jun 1, 2023
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
mentat9
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@mentat9 - I believe we considered using an enum for enabling this feature rather than a boolean. There were two reasons why we decided not to:
|
FumingZhang
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ms-zhenhua
added
ARMSignedOff
|
@msyyc - Please check the Python Breaking changes. If there is no problem, please add the |
FumingZhang
removed
the
DoNotMerge
|
The service is ready now, please help merge the PR thanks! |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
openapi-pipeline-app
bot
added
the
DoNotMerge
zedy-wj
added
Approved-OkToMerge
live1206
approved these changes
Jun 9, 2023
live1206
deleted the
FumingZhang-containerservice-Microsoft.ContainerService-2023-05-02-preview
branch
openapi-pipeline-app
bot
added
the
DoNotMerge
This was referenced Jun 9, 2023
11 tasks
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
…add version preview/2023-05-02-preview (Azure#24245) * Adds base for updating Microsoft.ContainerService/aks from version preview/2023-04-02-preview to version 2023-05-02-preview * Updates readme * Updates API version in new specs and examples * uppdate readmes * add network monitoring * fix RPC-Put-V1-11 * fix python config --------- Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.