Fix violated rule R4041 for 2022-06-02-preview managedCluster swagger #19582
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
|
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.6)] | new version | base version |
|---|---|---|
| managedClusters.json | 2022-06-02(a5eeac0) | 2022-04-01(main) |
| managedClusters.json | 2022-06-02(a5eeac0) | 2022-05-02(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileAzureDefender' removed or renamed? New: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L2800:3 Old: Microsoft.ContainerService/stable/2022-04-01/managedClusters.json#L2221:3 |
|
The new version is missing a property found in the old version. Was 'azureDefender' renamed or removed? New: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L6026:7 Old: Microsoft.ContainerService/stable/2022-04-01/managedClusters.json#L5426:7 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-06 | package-preview-2022-06(a5eeac0) | package-preview-2022-06(dev-containerservice-Microsoft.ContainerService-2022-06-02-preview) |
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 is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L1235 |
|
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-06-02-preview/managedClusters.json#L37 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L5453 |
| 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-06-02-preview/managedClusters.json#L1218 |
|
| '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-06-02-preview/managedClusters.json#L1626 |
|
| 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-06-02-preview/managedClusters.json#L1938 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L1727 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L1881 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L1531 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L1788 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L244 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L1835 |
|
| The child tracked resource, 'agentPools' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L3480 |
|
| The child tracked resource, 'commandResults' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L3852 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L5357 |
|
| The child tracked resource, 'trustedAccessRoleBindings' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L6656 |
|
| 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-06-02-preview/managedClusters.json#L3238 |
|
| 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-06-02-preview/managedClusters.json#L3290 |
|
| 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-06-02-preview/managedClusters.json#L3295 |
|
| 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-06-02-preview/managedClusters.json#L3352 |
|
| 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-06-02-preview/managedClusters.json#L3357 |
|
| 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-06-02-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: enableCSIProxy Location: Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json#L3529 |
|
| 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-06-02-preview/managedClusters.json#L3547 |
|
| 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-06-02-preview/managedClusters.json#L4020 |
|
| 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-06-02-preview/managedClusters.json#L4083 |
|
| 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-06-02-preview/managedClusters.json#L4243 |
|
| 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-06-02-preview/managedClusters.json#L4247 |
|
| 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-06-02-preview/managedClusters.json#L4251 |
|
| 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-06-02-preview/managedClusters.json#L4410 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️SDK Track2 Validation: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ManagedClusterPropertiesForSnapshot > properties > sku)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ManagedClusterPropertiesForSnapshot > properties > networkProfile)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| 💬 | "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
| 💬 | "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
| 💬 | "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
| 💬 | "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
| 💬 | "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Autorest completed in 14.07s. 0 files generated." |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Using directive.1.suppress which is deprecated and will be removed in the future." |
|
| "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > Resource > properties > systemData)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| 💬 | "readme":"containerservice/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"AutoRest core version selected from configuration: ^3.2.0." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
|
Hi @FumingZhang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Jun 24, 2022
moreOver0
approved these changes
Jun 24, 2022
moreOver0
approved these changes
Jun 24, 2022
FumingZhang
merged commit a716bce
into
Azure:dev-containerservice-Microsoft.ContainerService-2022-06-02-preview
honghr
pushed a commit
that referenced
this pull request
Jul 20, 2022
…02-preview (#19653) * Adds base for updating Microsoft.ContainerService from version preview/2022-05-02-preview to version 2022-06-02-preview * Updates readme * Updates API version in new specs and examples * update readmes (#19422) * Containerservice 2022 06 02 preview fleet (#19541) * add fleets and fleet members resource types * remove clusterLocation * wording * don't flatten hubprofile * extra comma * fix patch example * Fix violated rule R4041 for 2022-06-02-preview managedCluster swagger (#19582) * remove useless directive * fix R4041 * fix * add node restriction to swagger (#19587) * aks fleet list credentials api (#19559) * add fleet list credential api * tweaks * fix example filename * fix casing * add resourceId on hubProfile * drop the new field, keep it as internal field * fix duplicate shema error * different name for fleet credential results * use xms-identifier on the array items * prettier fi Co-authored-by: Stephane Erbrech <stephane.erbrech@gmail.com> * sterbrec - address fleet comments - Microsoft.ContainerService - 2022-06-02-preview (#19783) * address fleet comments * add example for nadditional status code * Add missing `x-ms-long-running-operation-options` for delete operations in fleet-related API (#19787) * add final-state-via * fix final state to location header Co-authored-by: Stéphane Erbrech <stephane.erbrech@gmail.com> Co-authored-by: lht6 <46062996+lht6@users.noreply.github.com> Co-authored-by: Haitao Chen <haitch@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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Fix the violated rule R4041(XmsIdentifierValidation/SDKViolation) in preview/2022-06-02-preview managedCluster.
"x-ms-identifiers": [].Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.