Fix comments #28785
Merged
Fix comments #28785
Conversation
This file contains hidden or 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
nilo19
requested review from
palma21,
weinong,
alvinli222,
matthchr and
circy9
as code owners
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| managedClusters.json | 2024-03-02-preview(522c1cc) | 2024-02-01(main) |
| managedClusters.json | 2024-03-02-preview(522c1cc) | 2024-02-02-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-03 | package-preview-2024-03(522c1cc) | package-preview-2024-03(FumingZhang-containerservice-Microsoft.ContainerService-2024-03-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: aks/preview/2024-03-02-preview/managedClusters.json#L52 |
|
Operations API path must follow the schema provided in the common types. Location: aks/preview/2024-03-02-preview/managedClusters.json#L53 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-03-02-preview/managedClusters.json#L74 |
|
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/preview/2024-03-02-preview/managedClusters.json#L80 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-03-02-preview/managedClusters.json#L116 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-03-02-preview/managedClusters.json#L137 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-03-02-preview/managedClusters.json#L237 |
|
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2024-03-02-preview/managedClusters.json#L278 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-03-02-preview/managedClusters.json#L336 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-03-02-preview/managedClusters.json#L381 |
|
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-03-02-preview/managedClusters.json#L381 |
|
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-03-02-preview/managedClusters.json#L429 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L569 |
|
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-03-02-preview/managedClusters.json#L676 |
|
The patch operation body parameter schema should contain property 'identity'. Location: aks/preview/2024-03-02-preview/managedClusters.json#L695 |
|
The async patch operation should return 202. Location: aks/preview/2024-03-02-preview/managedClusters.json#L713 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L723 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L781 |
|
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2024-03-02-preview/managedClusters.json#L841 |
|
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-03-02-preview/managedClusters.json#L1011 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L1055 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L1223 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L1347 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-03-02-preview/managedClusters.json#L1363 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-03-02-preview/managedClusters.json#L1562 |
|
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-03-02-preview/managedClusters.json#L1566 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-03-02-preview/managedClusters.json#L1586 |
|
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-03-02-preview/managedClusters.json#L1605 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-03-02-preview/managedClusters.json#L1651 |
|
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-03-02-preview/managedClusters.json#L1667 |
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Apr 22, 2024
Closed
|
Trying to fix https://github.com/Azure/azure-openapi-validator/blob/main/docs/post-operation-id-contains-url-verb.md but hit a different error. @raosuhas what is the expected naming here? |
This was referenced Apr 22, 2024
FumingZhang
reviewed
Apr 23, 2024
| @@ -3833,7 +3833,7 @@ | |||
| "tags": [ | |||
| "LoadBalancers" | |||
| ], | |||
| "operationId": "LoadBalancers_Rebalance", | |||
| "operationId": "LoadBalancers_RebalanceLoadBalancers", | |||
There was a problem hiding this comment.
As LoadBalancers_RebalanceLoadBalancers is regarded as a bad case, what do you think about changing the url?
Url: managedClusters/{resourceName}/loadBalancers/rebalance
OperationId: LoadBalancers_Rebalance
There was a problem hiding this comment.
ok, got another error Path for 'post' method on a resource type MUST follow valid resource naming.
- https://github.com/Azure/azure-rest-api-specs/pull/28785/checks?check_run_id=24133521319
- https://github.com/Azure/azure-openapi-validator/blob/main/docs/path-for-resource-action.md
emmm.. is there something similar defined in the spec of nrp?
There was a problem hiding this comment.
@raosuhas can we bypass the check for the rebalance operation? As per our design, there shouldn't contain any resource name in the URI.
There was a problem hiding this comment.
Url: managedClusters/{resourceName}/loadBalancers/rebalance
I dont think we should do this as it's not valid as per ARMs guidelines. What you had before was more correct: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rebalanceLoadBalancers
There was a problem hiding this comment.
@matthchr yes I agree. But in that case there will be another alert complaining the operationId. Let me change it back.
nilo19
force-pushed
the
fix/comments
branch
2 times, most recently
from
ce10caa to
4b4c3bc
Compare
FumingZhang
merged commit ce02b31
into
Azure:FumingZhang-containerservice-Microsoft.ContainerService-2024-03-02-preview
25 of 29 checks passed
ramoka178
pushed a commit
that referenced
this pull request
Apr 29, 2024
…add version preview/2024-03-02-preview (#28612) * Adds base for updating Microsoft.ContainerService/aks from version preview/2024-02-02-preview to version 2024-03-02-preview * Updates readme * Updates API version in new specs and examples * update readmes for python & java * Add Automatic as mananged cluster SKU enum (#28543) * feat(retina): add advanced networking to api spec for 2024-03-02-preview api (#28502) * feat(retina): add advanced networking observability api to 2024-03-02-preview * move to 2024-03-02-preview * Adding ETags to AKS RP APIs (#28632) * Adding ETags to AKS RP APIs * Fix breaking change --------- Co-authored-by: indusridhar <[email protected]> * feat: Support multiple standard load balancers in 2024-03-02-preview (#28633) * feat: Support multiple standard load balancers in 2024-03-02-preview * fix pipeline errors * chore: Change operation id for rebalance lb operation (#28785) * Update sdk-suppressions.yaml --------- Co-authored-by: Yiran Li <[email protected]> Co-authored-by: Steven Nguyen <[email protected]> Co-authored-by: InduSridhar <[email protected]> Co-authored-by: indusridhar <[email protected]> Co-authored-by: Qi Ni <[email protected]> Co-authored-by: Yuchao Yan <[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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
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:
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 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
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.