Review request for Microsoft.ContainerService to add version 2022-08-02-preview #20487
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
…w/2022-07-02-preview to version 2022-08-02-preview
…oundNAT (Azure#20407) * AKS agent pool properties add AgentPoolWindowsProfile and DisableOutboundNAT * Change disableOutboundNAT to disableOutboundNat because of ARM format; Improve description. * Improve description
* added guardrails profile to specs * linter fix * added x-ms-enum * added guardrails definitions for versions route * linter fix, added custom word * fix * typo fix * fix for example * added object type * added object type * removed data field * changed descriptions * *
* add KubeProxyConfig to AKS NetworkProfile * remove extra comma, type: integer for *Seconds * add custom words * prettier * follow camel case ARM guidance * 2nd camel case standard
|
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 |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @FumingZhang your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| managedClusters.json | 2022-07-02-preview(622b23e) | 2022-07-02-preview(main) |
️⚠️Breaking Change(Cross-Version): 17 Warnings warning [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| managedClusters.json | 2022-08-02-preview(622b23e) | 2022-07-01(main) |
| managedClusters.json | 2022-08-02-preview(622b23e) | 2022-07-02-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-08 | package-preview-2022-08(622b23e) | default(main) |
| package-preview-2022-07 | package-preview-2022-07(622b23e) | package-preview-2022-07(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableOutboundNat Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L5956 |
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: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L37 |
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L37 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L5620 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L5742 |
| 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: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1268 |
|
| 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: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1271 |
|
| 'PUT' operation 'PrivateEndpointConnections_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1758 |
|
| 'PUT' operation 'PrivateEndpointConnections_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1725 |
|
| The operation 'ManagedClusters_GetCommandResult' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L2076 |
|
| The operation 'ManagedClusters_GetCommandResult' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L2037 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1859 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L2013 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1826 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1980 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1663 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1920 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1630 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1887 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L244 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L1967 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L244 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L1934 |
|
| The child tracked resource, 'agentPools' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3626 |
|
| The child tracked resource, 'commandResults' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L3998 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L5523 |
|
| The child tracked resource, 'trustedAccessRoleBindings' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json#L6857 |
|
| The child tracked resource, 'agentPools' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L3623 |
|
| The child tracked resource, 'commandResults' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L4070 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L5646 |
|
| The child tracked resource, 'trustedAccessRoleBindings' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json#L6999 |
️❌Avocado: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/containerservice/resource-manager/readme.md json: Microsoft.ContainerService/preview/2019-10-27-preview/openShiftManagedClusters.json |
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/containerservice/resource-manager/readme.md json: Microsoft.ContainerService/preview/2022-07-02-preview/fleets.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"\nfatal error: Failed to load step "step":"ManagedClusters_ListClusterAdminCredentials", "exampleFile":"../../2022-08-02-preview/examples/ManagedClustersListClusterCredentialResult.json": Example file is referenced by multiple operation: ManagedClusters_ListClusterAdminCredentials, ManagedClusters_ListClusterUserCredentials, ManagedClusters_ListClusterMonitoringUserCredentials ../../2022-08-02-preview/examples/ManagedClustersListClusterCredentialResult.json, \n" |
️⚠️~[Staging] TrafficValidation: 1 Warnings warning [Detail]
restlerResult: Request coverage (successful / total): 8 / 58 Attempted requests: 12 / 58
Traffic validation failed. Check pipeline artifact for restler output and detail report.
| Rule | Message |
|---|---|
| "Starting task Test...\nUsing python: 'python3' (Python 3.10.5)\nRequest coverage (successful / total): 8 / 58\nAttempted requests: 12 / 58\nNo bugs were found.\nTask Test succeeded.\nCollecting logs...\n" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/622b23e370d86b99202823777fbf25253b083a45/specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-07">containerservice/resource-manager/readme.md#package-preview-2022-07
- "https://github.com/Azure/azure-rest-api-specs/blob/622b23e370d86b99202823777fbf25253b083a45/specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-08">containerservice/resource-manager/readme.md#package-preview-2022-08
| Rule | Message |
|---|---|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-08", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-07", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
|
Hi @FumingZhang, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Aug 31, 2022
Presumably an alternative would be to do something like we do for GET So if guardrails versions weren't nested under |
That one is incorrect as well since ideally all GET resources in ARM need to follow the ARM schema with the top level ARM properties like id, name and type. That one was probably missed during review. This would cause issues with clients that make the assumption for these properties. If you want to keep it free form I would suggest converting it to a POST .. i.e "POST .../listguardrailversions" Just as a side note Even for location based resources like the trustecaccessroles , there is an expectation that it has the type and name property which includes the location value. https://armwiki.azurewebsites.net/rp_onboarding/ResourceProviderRegistrationRoutingTypes.html#locationbased |
raosuhas
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@raosuhas, I've forwarded you a mail where we explicitly asked about exactly this kind of API to the ARM API reviewers alias and were told that, provided the set of data is readonly (GET, no user PUT), the RP has flexibility to define it as "not a resource" and rather a static list of data. I don't think that solves your critique of it being under ManagedCluster (or does it?). But at least at the region level (like the TrustedAccessRoles API), I believe that pattern is allowed. |
FumingZhang
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
…erties (Azure#20625) * removed guardrails-versions route, added guardrails profice to MC properties * removed unsued file for guardrails versions, removed unused custom word
palma21
approved these changes
Sep 9, 2022
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
This was referenced Sep 13, 2022
12 tasks
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Alread deployed to all global regions by 08/29.
ASAP, 09/01.
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.
-[x] 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.
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.