Swagger changes for adding autoscalerprofile flags for daemonset/multipleexpander #25487
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
aagusuab
requested review from
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| managedClusters.json | 2023-08-02-preview(8574132) | 2023-07-01(main) |
| managedClusters.json | 2023-08-02-preview(8574132) | 2023-07-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 '$ref' property points to different models in the old and new versions. New: aks/preview/2023-08-02-preview/managedClusters.json#L5238:13 Old: aks/preview/2023-07-02-preview/managedClusters.json#L5223:13 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-preview-2023-08 | package-preview-2023-08(8574132) | package-preview-2023-08(FumingZhang-containerservice-Microsoft.ContainerService-2023-08-02-preview) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: aks/preview/2023-08-02-preview/managedClusters.json#L2153 |
| Based on the response model schema, operation 'ManagedClusters_ListKubernetesVersions' might be pageable. Consider adding the x-ms-pageable extension. Location: aks/preview/2023-08-02-preview/managedClusters.json#L116 |
|
| OperationId should contain the verb: 'listcredential' in:'ManagedClusters_GetAccessProfile'. Consider updating the operationId Location: aks/preview/2023-08-02-preview/managedClusters.json#L284 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Managed Cluster Location: aks/preview/2023-08-02-preview/managedClusters.json#L367 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Managed Cluster Location: aks/preview/2023-08-02-preview/managedClusters.json#L415 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Managed Cluster Location: aks/preview/2023-08-02-preview/managedClusters.json#L460 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Managed Cluster Location: aks/preview/2023-08-02-preview/managedClusters.json#L502 |
|
| The response of operation:'AgentPools_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-08-02-preview/managedClusters.json#L1072 |
|
| The response of operation:'AgentPools_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-08-02-preview/managedClusters.json#L1115 |
|
| The response of operation:'Machines_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-08-02-preview/managedClusters.json#L1385 |
|
| Based on the response model schema, operation 'PrivateEndpointConnections_List' might be pageable. Consider adding the x-ms-pageable extension. Location: aks/preview/2023-08-02-preview/managedClusters.json#L1869 |
|
| The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-08-02-preview/managedClusters.json#L1912 |
|
| The response of operation:'PrivateEndpointConnections_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: aks/preview/2023-08-02-preview/managedClusters.json#L1960 |
|
| Based on the response model schema, operation 'PrivateLinkResources_List' might be pageable. Consider adding the x-ms-pageable extension. Location: aks/preview/2023-08-02-preview/managedClusters.json#L2131 |
|
| OperationId should contain the verb: 'resolveprivatelinkserviceid' in:'ResolvePrivateLinkServiceId_POST'. Consider updating the operationId Location: aks/preview/2023-08-02-preview/managedClusters.json#L2178 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌SpellCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (daemonsets), please fix the error or add words to ./custom-words.txt path: aks/preview/2023-08-02-preview/managedClusters.json#L5233:21 |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
This was referenced Aug 24, 2023
This was referenced Aug 24, 2023
FumingZhang
reviewed
Aug 25, 2023
3 tasks
|
LGTM, will merge the change once the custom words PR is merged |
matthchr
approved these changes
Aug 25, 2023
FumingZhang
merged commit f58f4e5
into
Azure:FumingZhang-containerservice-Microsoft.ContainerService-2023-08-02-preview
raosuhas
pushed a commit
that referenced
this pull request
Sep 28, 2023
…add version preview/2023-08-02-preview (#25891) * Adds base for updating Microsoft.ContainerService/aks from version preview/2023-07-02-preview to version 2023-08-02-preview * Updates readme * Updates API version in new specs and examples * update (#25469) * Fix the IstioComponents structure (#25492) * add netorkPolicy "none" (#25511) * add netorkPolicy "none" value and description * add "none" enum value to networkPolicy * add addon autoscaling api (#25479) * Update trusted access put and delete to async operation (#25537) * Update trusted access put and delete to async operation * Update example * Update header * Swagger changes for adding autoscalerprofile flags for daemonset/multipleexpander (#25487) * Adding json changes * adding "daemonsets" to the custom-words * Editing "Expander" to "expander" * Removing daemonset custom word from this pr. look at: #25533 * Add AzureServiceMesh example (#25560) * Add AzureServiceMesh example * Fix AKV resource id format * enrich ASM examples (#25598) --------- Co-authored-by: deveshdama <[email protected]> Co-authored-by: robogatikov <[email protected]> Co-authored-by: Chih-Sheng Huang <[email protected]> Co-authored-by: Tongyao Si <[email protected]> Co-authored-by: Youn Jae Kim <[email protected]>
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
…add version preview/2023-08-02-preview (#25891) * Adds base for updating Microsoft.ContainerService/aks from version preview/2023-07-02-preview to version 2023-08-02-preview * Updates readme * Updates API version in new specs and examples * update (#25469) * Fix the IstioComponents structure (#25492) * add netorkPolicy "none" (#25511) * add netorkPolicy "none" value and description * add "none" enum value to networkPolicy * add addon autoscaling api (#25479) * Update trusted access put and delete to async operation (#25537) * Update trusted access put and delete to async operation * Update example * Update header * Swagger changes for adding autoscalerprofile flags for daemonset/multipleexpander (#25487) * Adding json changes * adding "daemonsets" to the custom-words * Editing "Expander" to "expander" * Removing daemonset custom word from this pr. look at: #25533 * Add AzureServiceMesh example (#25560) * Add AzureServiceMesh example * Fix AKV resource id format * enrich ASM examples (#25598) --------- Co-authored-by: deveshdama <[email protected]> Co-authored-by: robogatikov <[email protected]> Co-authored-by: Chih-Sheng Huang <[email protected]> Co-authored-by: Tongyao Si <[email protected]> Co-authored-by: Youn Jae Kim <[email protected]>
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.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links