Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update(acns): advanced networking profile to note addition costs - 2024-04 preview #29245

Merged
merged 1 commit into from
May 30, 2024
Merged

update(acns): advanced networking profile to note addition costs - 2024-04 preview #29245

merged 1 commit into from
May 30, 2024

Conversation

snguyen64
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • updating the description for the api.

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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 ApiView comment 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
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 28, 2024 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
    To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 28, 2024 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 10 Warnings warning [Detail]
Compared specs (v0.10.9) new version base version
managedClusters.json 2024-04-02-preview(d060a1c) 2024-02-01(main)
managedClusters.json 2024-04-02-preview(d060a1c) 2024-03-02-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5059:9
Old: aks/stable/2024-02-01/managedClusters.json#L3636:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5063:9
Old: aks/stable/2024-02-01/managedClusters.json#L3664:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5067:9
Old: aks/stable/2024-02-01/managedClusters.json#L3681:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5071:9
Old: aks/stable/2024-02-01/managedClusters.json#L3708:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5076:9
Old: aks/stable/2024-02-01/managedClusters.json#L3731:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5137:9
Old: aks/stable/2024-02-01/managedClusters.json#L3805:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L5172:11
Old: aks/stable/2024-02-01/managedClusters.json#L3854:11
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: aks/preview/2024-04-02-preview/managedClusters.json#L6108:13
Old: aks/stable/2024-02-01/managedClusters.json#L4643:13


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1036 - ConstraintChanged The new version has a different 'maximum' value than the previous one.
New: aks/preview/2024-04-02-preview/managedClusters.json#L4209:9
Old: aks/preview/2024-03-02-preview/managedClusters.json#L4198:9
⚠️ 1036 - ConstraintChanged The new version has a different 'minimum' value than the previous one.
New: aks/preview/2024-04-02-preview/managedClusters.json#L4209:9
Old: aks/preview/2024-03-02-preview/managedClusters.json#L4198:9
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-04 package-preview-2024-04(d060a1c) package-preview-2024-04(FumingZhang-containerservice-Microsoft.ContainerService-2024-04-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
❌ OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L52
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L53
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L74
❌ ParametersInPointGet Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L80
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L116
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L137
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L237
❌ ResourceNameRestriction The resource name parameter 'roleName' should be defined with a 'pattern' restriction.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L278
❌ ParametersInPost server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L336
❌ ParametersInPost server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L381
❌ ParametersInPost format is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L381
❌ ParametersInPost server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L429
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L569
❌ PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L676
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L695
❌ LroPatch202 The async patch operation should return 202.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L713
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L723
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L781
❌ ResourceNameRestriction The resource name parameter 'configName' should be defined with a 'pattern' restriction.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L841
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1011
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1055
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1223
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1350
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1366
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1565
❌ OperationIdNounVerb 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/2024-04-02-preview/managedClusters.json#L1569
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1589
❌ PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1608
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1654
❌ PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: aks/preview/2024-04-02-preview/managedClusters.json#L1670
️️✔️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.
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand] 
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 28, 2024 •
edited
Loading

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-python warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-java failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-resource-manager-schemas failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-powershell succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 28, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/containerservice/armcontainerservice https://apiview.dev/Assemblies/Review/2f19cca64456411e9c342082a432418f?revisionId=ad4adf1f13e64926bb95f559e70f5cbf
JavaScript @azure/arm-containerservice https://apiview.dev/Assemblies/Review/dabf043916d14dc38e0c2d456d89f55a?revisionId=3750639ed7c844c38dca34166d48c572
Swagger Microsoft.ContainerService https://apiview.dev/Assemblies/Review/71d5cd3d2d1c46b59eabc692899ea0b4?revisionId=bd731bb8e6c747679339329449d459f9

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 28, 2024
This was referenced May 28, 2024
Closed
Closed
Closed
Closed
Closed
@snguyen64 snguyen64 changed the base branch from main to FumingZhang-containerservice-Microsoft.ContainerService-2024-04-02-preview May 29, 2024 11:00
@AzureRestAPISpecReview AzureRestAPISpecReview removed new-api-version ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels May 29, 2024
@FumingZhang FumingZhang merged commit 59e7db0 into Azure:FumingZhang-containerservice-Microsoft.ContainerService-2024-04-02-preview May 30, 2024
27 of 32 checks passed
razvanbadea-msft pushed a commit that referenced this pull request Jun 11, 2024
@FumingZhang @zjpjack-github
@wenxuan0923 @norshtein @MartinForReal @HuShaoRu @snguyen64
Review request for Microsoft.ContainerService/aks to add version prev…
e5597e4 
…iew/2024-04-02-preview (#29061)

* Adds base for updating Microsoft.ContainerService/aks from version preview/2024-03-02-preview to version 2024-04-02-preview

* Updates readme

* Updates API version in new specs and examples

* add undrainableNodeBehavior property (#28919)

* add undrainableNodeBehavior property

* fix some spell errors

* fix some grammer issues

* MixSku Pool Autoscale mode API Change (#29052)

* MixSku Pool Autoscale mode API Change

* Prettier

---------

Co-authored-by: wenxuanW <wenxuanwang@microsoft.com>

* Add swagger defination for IMDS restriction feature (#29044)

* Add swagger defination for IMDS restriction feature

* update swagger

* fix spell

* add none to outbound type in aks managedCluster (#29095)

* add componentsByReleases (#29002)

* update(retina): update adv networking to note additional costs (#29245)

* apply code review (#29272)

* apply code review

* remove wireserver description because it's not link local address

* apply code review

* remove(monitoring): remove network monitoring profile from api 04-02 preview (#29279)

---------

Co-authored-by: zjpjack-github <136433002+zjpjack-github@users.noreply.github.com>
Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com>
Co-authored-by: wenxuanW <wenxuanwang@microsoft.com>
Co-authored-by: Tongyao Si <tosi@microsoft.com>
Co-authored-by: Fan Shang Xiang <fanshangxiang@gmail.com>
Co-authored-by: Shaoru Hu <49520642+HuShaoRu@users.noreply.github.com>
Co-authored-by: Steven Nguyen <30740718+snguyen64@users.noreply.github.com>
markcowl pushed a commit to markcowl/azure-rest-api-specs that referenced this pull request Jun 11, 2024
@FumingZhang @zjpjack-github
@wenxuan0923 @norshtein @MartinForReal @HuShaoRu @snguyen64 @markcowl
Review request for Microsoft.ContainerService/aks to add version prev…
5ad210f 
…iew/2024-04-02-preview (Azure#29061)

* Adds base for updating Microsoft.ContainerService/aks from version preview/2024-03-02-preview to version 2024-04-02-preview

* Updates readme

* Updates API version in new specs and examples

* add undrainableNodeBehavior property (Azure#28919)

* add undrainableNodeBehavior property

* fix some spell errors

* fix some grammer issues

* MixSku Pool Autoscale mode API Change (Azure#29052)

* MixSku Pool Autoscale mode API Change

* Prettier

---------

Co-authored-by: wenxuanW <wenxuanwang@microsoft.com>

* Add swagger defination for IMDS restriction feature (Azure#29044)

* Add swagger defination for IMDS restriction feature

* update swagger

* fix spell

* add none to outbound type in aks managedCluster (Azure#29095)

* add componentsByReleases (Azure#29002)

* update(retina): update adv networking to note additional costs (Azure#29245)

* apply code review (Azure#29272)

* apply code review

* remove wireserver description because it's not link local address

* apply code review

* remove(monitoring): remove network monitoring profile from api 04-02 preview (Azure#29279)

---------

Co-authored-by: zjpjack-github <136433002+zjpjack-github@users.noreply.github.com>
Co-authored-by: Thalia Wang <58485997+wenxuan0923@users.noreply.github.com>
Co-authored-by: wenxuanW <wenxuanwang@microsoft.com>
Co-authored-by: Tongyao Si <tosi@microsoft.com>
Co-authored-by: Fan Shang Xiang <fanshangxiang@gmail.com>
Co-authored-by: Shaoru Hu <49520642+HuShaoRu@users.noreply.github.com>
Co-authored-by: Steven Nguyen <30740718+snguyen64@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FumingZhang FumingZhang FumingZhang approved these changes

@msyyc msyyc Awaiting requested review from msyyc

@palma21 palma21 Awaiting requested review from palma21

@matthchr matthchr Awaiting requested review from matthchr

Assignees
No one assigned
Labels
resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@snguyen64 @FumingZhang @AzureRestAPISpecReview