Add MaintenanceWindow into MaintenanceConfigurationProperties #21337
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, @wenxuan0923 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.1)] | new version | base version |
|---|---|---|
| managedClusters.json | 2022-10-02-preview(aeae165) | 2022-09-01(main) |
| managedClusters.json | 2022-10-02-preview(aeae165) | 2022-09-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-10 | package-preview-2022-10(aeae165) | package-preview-2022-10(dev-containerservice-Microsoft.ContainerService-2022-10-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 schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L37 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L6103 |
| 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-10-02-preview/managedClusters.json#L1283 |
|
| '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-10-02-preview/managedClusters.json#L1737 |
|
| 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-10-02-preview/managedClusters.json#L2049 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L1838 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L1992 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L1642 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L1899 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L244 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L1946 |
|
| The child tracked resource, 'agentPools' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L3736 |
|
| The child tracked resource, 'commandResults' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L4398 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L6007 |
|
| The child tracked resource, 'trustedAccessRoleBindings' with immediate parent 'ManagedCluster', must have a list by immediate parent operation. Location: Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json#L7392 |
|
| 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-10-02-preview/managedClusters.json#L3373 |
|
| 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-10-02-preview/managedClusters.json#L3425 |
|
| 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-10-02-preview/managedClusters.json#L3430 |
|
| 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-10-02-preview/managedClusters.json#L3495 |
|
| 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-10-02-preview/managedClusters.json#L3500 |
|
| 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-10-02-preview/managedClusters.json#L3504 |
|
| 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-10-02-preview/managedClusters.json#L3785 |
|
| 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-10-02-preview/managedClusters.json#L3803 |
|
| 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-10-02-preview/managedClusters.json#L4566 |
|
| 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-10-02-preview/managedClusters.json#L4653 |
|
| 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-10-02-preview/managedClusters.json#L4813 |
|
| 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-10-02-preview/managedClusters.json#L4817 |
|
| 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-10-02-preview/managedClusters.json#L4821 |
|
| 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-10-02-preview/managedClusters.json#L4988 |
|
| 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-10-02-preview/managedClusters.json#L5089 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 50 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
This was referenced Oct 28, 2022
This was referenced Oct 29, 2022
wenxuan0923
requested review from
palma21,
alvinli222,
matthchr and
circy9
as code owners
matthchr
approved these changes
Nov 1, 2022
| "items": { | ||
| "$ref": "#/definitions/DateSpan" | ||
| }, | ||
| "x-ms-identifiers": [], |
There was a problem hiding this comment.
I don't think you want/need this x-ms-identifiers
There was a problem hiding this comment.
Fixed, thank you!!
There was a problem hiding this comment.
Well, I thought this is kind of necessary to pass the check in Swagger LintDiff.
Since this is an array, the spec will expect each element to be distinguishable, but an empty list can also be used to bypass the check.
There was a problem hiding this comment.
Huh, interesting. Looks like you need to bring this back then. TIL.
Sorry for the bad advice @wenxuan0923.
There was a problem hiding this comment.
Hi @matthchr and @FumingZhang , thank you both for your comments! I have added the identifiers back.
|
Hi @wenxuan0923, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
The errors scanned by Swagger ModelValidation is irrelevant to the changes in this PR. I'll help bypass the check after the identifier issue got fixed. |
FumingZhang
merged commit 84547b9
into
Azure:dev-containerservice-Microsoft.ContainerService-2022-10-02-preview
FumingZhang
pushed a commit
to FumingZhang/azure-rest-api-specs
that referenced
this pull request
Nov 7, 2022
…21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck
live1206
pushed a commit
that referenced
this pull request
Nov 24, 2022
…02-preview (#21439) * Adds base for updating Microsoft.ContainerService from version preview/2022-09-02-preview to version 2022-10-02-preview * Updates readme * Updates API version in new specs and examples * Pmiller/nodeosupgradechannel (#21326) * missed working comment * matthew comments * unpatched is a word * Add MaintenanceWindow into MaintenanceConfigurationProperties (#21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck * Fix ARM ID format for samples (#21402) * Fix Swagger Model Validation for the 2022-10-02-preview dev branch of container service (#21373) * fix API version * fix INVALID_FORMAT byte * fix INVALID_FORMAT arm-id * fix missing resource id * fix LRO_RESPONSE_HEADER * Update readmes for the 2022-10-02-preview dev branch of container service (#21366) * update readmes * remove fleets * Updating abort apis response to make it long running (#21362) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header Co-authored-by: InduSridhar <indusridhar@microsoft.com> * fix 202 location header * fix ProvisioningState validation * add x-ms-long-running-operation-options * fix ResourceNameRestriction * Fix abort location url in example (#21446) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples Co-authored-by: InduSridhar <indusridhar@microsoft.com> * Abort api response fix (#21559) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses Co-authored-by: InduSridhar <indusridhar@microsoft.com> * Node os upgrade desc fix (#21636) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses * Minor edit to node os upgrade description based on ARM review Co-authored-by: InduSridhar <indusridhar@microsoft.com> Co-authored-by: Paul Miller <pmiller@microsoft.com> Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com> Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com> Co-authored-by: InduSridhar <InduSridhar@users.noreply.github.com> Co-authored-by: InduSridhar <indusridhar@microsoft.com>
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
…02-preview (Azure#21439) * Adds base for updating Microsoft.ContainerService from version preview/2022-09-02-preview to version 2022-10-02-preview * Updates readme * Updates API version in new specs and examples * Pmiller/nodeosupgradechannel (Azure#21326) * missed working comment * matthew comments * unpatched is a word * Add MaintenanceWindow into MaintenanceConfigurationProperties (Azure#21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck * Fix ARM ID format for samples (Azure#21402) * Fix Swagger Model Validation for the 2022-10-02-preview dev branch of container service (Azure#21373) * fix API version * fix INVALID_FORMAT byte * fix INVALID_FORMAT arm-id * fix missing resource id * fix LRO_RESPONSE_HEADER * Update readmes for the 2022-10-02-preview dev branch of container service (Azure#21366) * update readmes * remove fleets * Updating abort apis response to make it long running (Azure#21362) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header Co-authored-by: InduSridhar <indusridhar@microsoft.com> * fix 202 location header * fix ProvisioningState validation * add x-ms-long-running-operation-options * fix ResourceNameRestriction * Fix abort location url in example (Azure#21446) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples Co-authored-by: InduSridhar <indusridhar@microsoft.com> * Abort api response fix (Azure#21559) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses Co-authored-by: InduSridhar <indusridhar@microsoft.com> * Node os upgrade desc fix (Azure#21636) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses * Minor edit to node os upgrade description based on ARM review Co-authored-by: InduSridhar <indusridhar@microsoft.com> Co-authored-by: Paul Miller <pmiller@microsoft.com> Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com> Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com> Co-authored-by: InduSridhar <InduSridhar@users.noreply.github.com> Co-authored-by: InduSridhar <indusridhar@microsoft.com>
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
…02-preview (Azure#21439) * Adds base for updating Microsoft.ContainerService from version preview/2022-09-02-preview to version 2022-10-02-preview * Updates readme * Updates API version in new specs and examples * Pmiller/nodeosupgradechannel (Azure#21326) * missed working comment * matthew comments * unpatched is a word * Add MaintenanceWindow into MaintenanceConfigurationProperties (Azure#21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck * Fix ARM ID format for samples (Azure#21402) * Fix Swagger Model Validation for the 2022-10-02-preview dev branch of container service (Azure#21373) * fix API version * fix INVALID_FORMAT byte * fix INVALID_FORMAT arm-id * fix missing resource id * fix LRO_RESPONSE_HEADER * Update readmes for the 2022-10-02-preview dev branch of container service (Azure#21366) * update readmes * remove fleets * Updating abort apis response to make it long running (Azure#21362) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header Co-authored-by: InduSridhar <indusridhar@microsoft.com> * fix 202 location header * fix ProvisioningState validation * add x-ms-long-running-operation-options * fix ResourceNameRestriction * Fix abort location url in example (Azure#21446) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples Co-authored-by: InduSridhar <indusridhar@microsoft.com> * Abort api response fix (Azure#21559) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses Co-authored-by: InduSridhar <indusridhar@microsoft.com> * Node os upgrade desc fix (Azure#21636) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses * Minor edit to node os upgrade description based on ARM review Co-authored-by: InduSridhar <indusridhar@microsoft.com> Co-authored-by: Paul Miller <pmiller@microsoft.com> Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com> Co-authored-by: Matthew Christopher <matthchr@users.noreply.github.com> Co-authored-by: InduSridhar <InduSridhar@users.noreply.github.com> Co-authored-by: InduSridhar <indusridhar@microsoft.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.
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:
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.
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.