Reusing the OSSku definition and renaming definitions to avoid overlap in SDK - HybridAKS 2023-11-15-preview#26741
Merged
Merged
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| provisionedClusterInstances.json | 2023-11-15-preview(2982f56) | 2023-11-15-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2023-11 | package-preview-2023-11(2982f56) | package-preview-2023-11(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1800 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
The service-defined (reserved name) resource 'default' should be represented as a path parameter enum with modelAsString set to true.Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L37 |
|
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L90 |
|
| 'PUT' operation 'HybridIdentityMetadata_Put' 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.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L237 |
|
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L252 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'agentPoolModel'. Consider using the plural form of 'agentPool' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L398 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'agentPoolModel'. Consider using the plural form of 'agentPool' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L433 |
|
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L455 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'agentPoolModel'. Consider using the plural form of 'agentPool' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L486 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'agentPoolModel'. Consider using the plural form of 'agentPool' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L530 |
|
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L548 |
|
| Based on the response model schema, operation 'agentPool_ListByProvisionedCluster' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L589 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'agentPoolModel'. Consider using the plural form of 'agentPool' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L590 |
|
| Operation should have a summary or description. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1049 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1111 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1122 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1190 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1206 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1209 |
|
| Schema should have a description or title. Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1339 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1361 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1368 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1371 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1427 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1509 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1535 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1571 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1610 |
|
| 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: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1666 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1767 |
|
| 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: Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json#L1871 |
️️✔️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.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 16, 2023
AzureRestAPISpecReview
added
ARMChangesRequested
ARMReview
BreakingChangeReviewRequired
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Nov 16, 2023
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
HariPrasadV
changed the title
HariPrasadV
changed the title
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
openapi-workflow-bot
Bot
added
the
WaitForARMFeedback
AzureRestAPISpecReview
added
ARMChangesRequested
and removed
WaitForARMFeedback
JeffreyRichter
added
the
Approved-BreakingChange
openapi-workflow-bot
Bot
added
the
WaitForARMFeedback
Contributor
Author
|
@rkmanda could you please help us with the ARM API Review of this change? Thanks! |
JocelynBerrendonner
approved these changes
Nov 20, 2023
Contributor
JocelynBerrendonner
left a comment
JocelynBerrendonner
left a comment
There was a problem hiding this comment.
LGTM from a feature team's perspective
HariPrasadV
added
the
EP-Edge-ARMReview
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
Bot
removed
the
WaitForARMFeedback
raych1
added
the
Approved-SdkBreakingChange-Go
Member
|
The Go SDK package hasn't been GAed. |
Contributor
Author
|
/pr RequestMerge |
raosuhas
approved these changes
Nov 22, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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.
Getting help
and https://aka.ms/ci-fix.