Review request for Microsoft.ContainerService to add version 2022-08-03-preview #20789
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-08-02-preview to version 2022-08-03-preview
|
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.9.7)] | new version | base version |
|---|---|---|
| managedClusters.json | 2022-08-03-preview(a2cb42e) | 2022-07-01(main) |
| managedClusters.json | 2022-08-03-preview(a2cb42e) | 2022-08-02-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-08-03 | package-preview-2022-08-03(a2cb42e) | default(main) |
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-08-03-preview/managedClusters.json#L37 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L5778 |
| 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-03-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-08-03-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-08-03-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-08-03-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-03-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-08-03-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-03-preview/managedClusters.json#L1887 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L244 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-08-03-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-08-03-preview/managedClusters.json#L3659 |
|
| The child tracked resource, 'commandResults' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4106 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L5682 |
|
| The child tracked resource, 'trustedAccessRoleBindings' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L7035 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutoScaling Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3361 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableNodePublicIP Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3413 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableCustomCATrust Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3418 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableEncryptionAtHost Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3483 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableUltraSSD Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3488 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableFIPS Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3492 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableCSIProxy Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3708 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L3726 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableMultipleStandardLoadBalancers Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4274 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4361 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableRBAC Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4521 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePodSecurityPolicy Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4525 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableNamespaceResources Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4529 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAccounts Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4696 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePrivateCluster Location: Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json#L4797 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/containerservice/resource-manager/readme.md tag: specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-08-03 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation 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.
️⚠️SDK Track2 Validation: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/a2cb42eadd02bf9b1e27acb4091d5874540af148/specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-08-03-only">containerservice/resource-manager/readme.md#package-preview-2022-08-03-only
- "https://github.com/Azure/azure-rest-api-specs/blob/a2cb42eadd02bf9b1e27acb4091d5874540af148/specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-08-03">containerservice/resource-manager/readme.md#package-preview-2022-08-03
| Rule | Message |
|---|---|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-08-03-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-08-03", "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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @FumingZhang, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Sep 20, 2022
|
Dear review board, I would like to clarify the failures in the CI checks. For SDK azure-powershell, it happened in our previous PR 08-02-preview. From log it seems that the reason for the failure lies in the build tool For SDK azure-sdk-for-net, it happened in our previous PR 08-02-preview. I suppose this should be a known issue. Besides it's going to be replaced by track 2 SDK, which was expected to be GA in mid-August. For Swagger SDK Breaking Change Tracking,
For ~[Staging] Swagger LintDiff,
|
Does this property take a fixed set of values? If so, please model it as a string enum, rather than unrestricted string. You will be able to add additional enum values without an API version change. In reply to: 1258449239 Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json:3554 in a2cb42e. [](commit_id = a2cb42e, deletion_comment = False) |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
This property is based off of the existing networking field of the same name. Networking didn't model this as an enum, so we cannot either. This value in our API is basically just passthrough to the underlying networking option. |
tianxchen-ms
approved these changes
Sep 28, 2022
This was referenced Sep 28, 2022
11 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 09/19.
ASAP, 09/21.
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.
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.