[Hub Generated] Review request for Microsoft.HybridContainerService to add version preview/2022-09-01-preview #22814
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
…preview/2022-05-01-preview to version 2022-09-01-preview
|
Hi, @HariPrasadV 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 |
|---|---|---|
| provisionedClusters.json | 2022-09-01-preview(7c8a610) | 2022-05-01-preview(main) |
| storageSpaces.json | 2022-09-01-preview(7c8a610) | 2022-05-01-preview(main) |
| virtualNetworks.json | 2022-09-01-preview(7c8a610) | 2022-05-01-preview(main) |
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.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 14 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-09 | package-preview-2022-09(7c8a610) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ProvisionedClusters_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L76 |
||
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L102 |
||
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L196 |
||
| '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/2022-09-01-preview/provisionedClusters.json#L348 |
||
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L372 |
||
| 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/2022-09-01-preview/provisionedClusters.json#L527 |
||
| 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/2022-09-01-preview/provisionedClusters.json#L568 |
||
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L596 |
||
| 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/2022-09-01-preview/provisionedClusters.json#L627 |
||
Operations with a 202 response should specify x-ms-long-running-operation: true.Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L667 |
||
| 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/2022-09-01-preview/provisionedClusters.json#L668 |
||
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L692 |
||
| 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/2022-09-01-preview/provisionedClusters.json#L725 |
||
| 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/2022-09-01-preview/provisionedClusters.json#L2207 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Operation should have a summary or description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L879 |
|
| Schema should have a description or title. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L927 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L978 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1115 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1123 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1149 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1158 |
|
| Schema should have a description or title. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1190 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L1214 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L1232 |
|
| Schema should have a description or title. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1239 |
|
| Schema should have a description or title. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1391 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1510 |
|
| Schema should have a description or title. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/provisionedClusters.json#L1524 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L1618 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L1622 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L1710 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L2091 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L2096 |
|
| 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/2022-09-01-preview/provisionedClusters.json#L2125 |
|
| 'GET' operation 'storageSpaces_Retrieve' should use method name 'Get' or Method name start with 'List'. 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/2022-09-01-preview/storageSpaces.json#L39 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'storageSpacesModel'. Consider using the plural form of 'storageSpaces' 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/2022-09-01-preview/storageSpaces.json#L39 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'storageSpacesModel'. Consider using the plural form of 'storageSpaces' 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/2022-09-01-preview/storageSpaces.json#L77 |
|
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/storageSpaces.json#L102 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'storageSpacesModel'. Consider using the plural form of 'storageSpaces' 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/2022-09-01-preview/storageSpaces.json#L133 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'storageSpacesModel'. Consider using the plural form of 'storageSpaces' 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/2022-09-01-preview/storageSpaces.json#L171 |
|
| Parameter should have a description. Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/storageSpaces.json#L196 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'storageSpacesModel'. Consider using the plural form of 'storageSpaces' 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/2022-09-01-preview/storageSpaces.json#L229 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'storageSpacesModel'. Consider using the plural form of 'storageSpaces' 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/2022-09-01-preview/storageSpaces.json#L269 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridContainerService/preview/2022-09-01-preview/storageSpaces.json#L406 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-preview-2023-03 |
️️✔️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]
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Feb 28, 2023
This was referenced Feb 28, 2023
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @HariPrasadV your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
JocelynBerrendonner
approved these changes
Feb 28, 2023
pilor
added
ARMSignedOff
tadelesh
added
the
Approved-SdkBreakingChange-Go
msyyc
deleted the
HariPrasadV-hybridaks-Microsoft.HybridContainerService-2022-09-01-preview
branch
This was referenced Mar 1, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…o add version preview/2022-09-01-preview (Azure#22814) * Adds base for updating Microsoft.HybridContainerService from version preview/2022-05-01-preview to version 2022-09-01-preview * Updates readme * Updates API version in new specs and examples * Added the 2022-09-01-preview version of Microsoft.HybridContainerService * Added id, name and type to PutProvisionedCluster example response
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.
We are using RPaaS and this API was already signed off by the ARM API Review board in RPSaaSMaster branch of the private repo. Please refer to the following PRs: https://github.com/Azure/azure-rest-api-specs-pr/pull/8487 and https://github.com/Azure/azure-rest-api-specs-pr/pull/8768 (including the breaking change).
This PR is for moving the API version 2022-09-01-preview from Private Preview to Public Preview.
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:
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.