[Hub Generated] Publish private branch 'containerservice/official/aks-api-release' #23542
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
…26419: [API Release] 2023-03-02-preview Create Swagger ba...
…r release for 2023-03 APIs
|
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/12059 |
FumingZhang
requested review from
Wzb123456789,
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
|
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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| managedClusters.json | 2023-03-02-preview(b5998e4) | 2023-02-01(main) |
| managedClusters.json | 2023-03-02-preview(b5998e4) | 2023-02-02-preview(main) |
| managedClusters.json | 2023-03-01(b5998e4) | 2023-02-01(main) |
| managedClusters.json | 2023-03-01(b5998e4) | 2023-02-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:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots' removed or restructured? Old: aks/preview/2023-02-02-preview/managedClusters.json#L2548:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots' removed or restructured? Old: aks/preview/2023-02-02-preview/managedClusters.json#L2587:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}' removed or restructured? Old: aks/preview/2023-02-02-preview/managedClusters.json#L2629:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles' removed or restructured? Old: aks/preview/2023-02-02-preview/managedClusters.json#L2815:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings' removed or restructured? Old: aks/preview/2023-02-02-preview/managedClusters.json#L2857:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}' removed or restructured? Old: aks/preview/2023-02-02-preview/managedClusters.json#L2902:5 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolNetworkProfile' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NodePublicIPTags' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterNodeResourceGroupProfile' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'MaintenanceWindow' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'Schedule' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'DailySchedule' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'WeeklySchedule' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AbsoluteMonthlySchedule' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'RelativeMonthlySchedule' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'UpgradeOverrideSettings' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ClusterUpgradeSettings' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'AgentPoolWindowsProfile' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterIngressProfile' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterIngressProfileWebAppRouting' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileNodeRestriction' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSecurityProfileCustomCATrustCertificates' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSnapshot' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterSnapshotProperties' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'ManagedClusterPropertiesForSnapshot' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkProfileForSnapshot' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPlugin' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPluginMode' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkPolicy' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
|
| The new version is missing a definition that was found in the old version. Was 'NetworkMode' removed or renamed? New: aks/stable/2023-03-01/managedClusters.json#L2543:3 Old: aks/preview/2023-02-02-preview/managedClusters.json#L3043:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 16 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-03 | package-2023-03(b5998e4) | default(main) |
| package-preview-2023-03 | package-preview-2023-03(b5998e4) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'ManagedClusters_ListKubernetesVersions' might be pageable. Consider adding the x-ms-pageable extension. Location: aks/preview/2023-03-02-preview/managedClusters.json#L116 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L3342 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L3909 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L4738 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L5031 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L6306 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L6812 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L6858 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7070 |
||
| Schema should have a description or title. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7468 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7471 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7704 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7775 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7857 |
||
| Based on the response model schema, operation 'ManagedClusters_ListKubernetesVersions' might be pageable. Consider adding the x-ms-pageable extension. Location: aks/stable/2023-03-01/managedClusters.json#L116 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: aks/stable/2023-03-01/managedClusters.json#L6042 |
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: aks/preview/2023-03-02-preview/managedClusters.json#L52 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-03-02-preview/managedClusters.json#L278 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: aks/preview/2023-03-02-preview/managedClusters.json#L508 |
|
The patch operation body parameter schema should contains property 'identity'. Location: aks/preview/2023-03-02-preview/managedClusters.json#L667 |
|
The patch operation body parameter schema should contains property 'sku'. Location: aks/preview/2023-03-02-preview/managedClusters.json#L667 |
|
The async patch operation should return 202. Location: aks/preview/2023-03-02-preview/managedClusters.json#L677 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: aks/preview/2023-03-02-preview/managedClusters.json#L698 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-03-02-preview/managedClusters.json#L797 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: aks/preview/2023-03-02-preview/managedClusters.json#L1123 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: aks/preview/2023-03-02-preview/managedClusters.json#L1246 |
|
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: aks/preview/2023-03-02-preview/managedClusters.json#L1364 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: aks/preview/2023-03-02-preview/managedClusters.json#L1838 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: aks/preview/2023-03-02-preview/managedClusters.json#L1943 |
|
An async DELETE operation must return 202. Location: aks/preview/2023-03-02-preview/managedClusters.json#L1970 |
|
A 202 response should include an Location response header. Location: aks/preview/2023-03-02-preview/managedClusters.json#L2030 |
|
The private endpoint model 'PrivateLinkResourcesListResult' schema does not conform to the common type definition. Location: aks/preview/2023-03-02-preview/managedClusters.json#L2081 |
|
The get operation should only return 200. Location: aks/preview/2023-03-02-preview/managedClusters.json#L2246 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L3416 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L3697 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L4671 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L4676 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L4726 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L5018 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L5023 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L5353 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L6740 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L6744 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L6752 |
|
Property name should be camel case. Location: aks/preview/2023-03-02-preview/managedClusters.json#L7032 |
|
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/stable/2023-03-01/managedClusters.json#L52 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
FumingZhang
added
the
DoNotMerge
AzureRestAPISpecReview
added
ARMReview
new-api-version
ReadyForApiTest
This was referenced Apr 13, 2023
This was referenced Apr 13, 2023
|
Mark the PR as draft and tag DoNotMerge label, wait for PM to confirm whether to merge this PR. |
FumingZhang
removed
the
DoNotMerge
The above is the corresponding release PR in private repo |
I will merege it directly considering it is reviewed. |
MaryGao
approved these changes
Apr 19, 2023
MaryGao
deleted the
published/Azure/azure-rest-api-specs-pr/containerservice/official/aks-api-release
branch
This was referenced Apr 19, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…-api-release' (Azure#23542) * [AutoSyncSwagger] bae8054ad7e Merged PR 7768257: Revert "Merged PR 7726419: [API Release] 2023-03-02-preview Create Swagger ba... * [AutoSyncSwagger] cdb0458f06d Merged PR 7937177: [API Release] Swagger release for 2023-03 APIs --------- Co-authored-by: apispec-automation <[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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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:
Waiting for PM confirmation, so added the DoNotMerge label.ASAP.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.