Adding resourceconnector - Appliance GA API version #20681
Conversation
|
Hi, @aditimalladi 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| appliances.json | 2022-10-27(6727b8d) | 2022-04-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listClusterCustomerUserCredential' removed or restructured? Old: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L356:5 |
|
| The read only property has changed from 'false' to 'true'. New: Microsoft.ResourceConnector/stable/2022-10-27/appliances.json#L642:9 Old: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L566:9 |
|
| The read only property has changed from 'false' to 'true'. New: Microsoft.ResourceConnector/stable/2022-10-27/appliances.json#L647:9 Old: Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L570:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-10-27 | package-2022-10-27(6727b8d) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The summary and description values should not be same. Location: Microsoft.ResourceConnector/stable/2022-10-27/appliances.json#L115 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceConnector/stable/2022-10-27/appliances.json#L759 |
|
| The child tracked resource, 'upgradeGraphs' with immediate parent 'appliance', must have a list by immediate parent operation. Location: Microsoft.ResourceConnector/stable/2022-10-27/appliances.json#L745 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ResourceConnector/stable/2022-10-27/appliances.json#L920 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.ResourceConnector' for api version '2022-10-27'. The supported api-versions are '2021-02-01, 2020-07-15-privatepreview, 2021-10-31-preview, 2022-04-15-preview'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️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
|
|
Hi @aditimalladi, Your PR has some issues. Please fix the CI sequentially by following the order of
|
AzureRestAPISpecReview
added
ARMReview
WaitForARMFeedback
|
Can you please update the checklist for this PR ? Also since this seems like a new api version please include the previous version as the first commit as explained above in the link :
|
raosuhas
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Hi @raosuhas Updated the API checklist and this is the previous API Version we had merged - https://github.com/Azure/azure-rest-api-specs/blob/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json |
aditimalladi
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @aditimalladi your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
@aditimalladi This is not helpful for me since I cannot view the diff like this. you need to add the previous api version as the base version in the first commit while creating the PR. IF you follow the links above this is explained in step 6 here (If creating manually) : or step 7 here : (If using openapui hub) |
raosuhas
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
…o-2021-08-27' (Azure#15905) * Adds base for updating Microsoft.Kusto from version stable/2021-01-01 to version 2021-08-27 * Updates readme * Updates API version in new specs and examples * Swagger changes * it1 * hh * it2 * it3 * it5 * it6 * it7 * readme * it10 * it11 * it11 * it 12 * it 13 * prettier * python * allowedIpRangeList - remove default * bassel changes * checkNameAvailability * fix lint * checkName * fix * managedPrivate check name * prettier * Update readme.python.md * add attached enum * Dor comments * fix description * readOnly Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
|
Trying to understand Swagger Model Validation error : but this operation is already marked as an async operation - not sure what the ask is here to fix this error. This is the older API version response for reference: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2022-04-15-preview/appliances.json#L280 |
@aditimalladi , please add |
@raych1 Could you please shar an example of the expected update? I have not added headers in responses for previous versions of the API |
@aditimalladi , please refer to this example |
@raych1 I have updated the example as discussed yesterday - is there something missing in the example? I still see the model validation failing with the same error. |
AzureRestAPISpecReview
added
ReadyForApiTest
* Adding resourceconnector - appliance GA API verson * Update swagger PR to add ArtifactURL and Another SSHKey type - ScopesAccessKey * Commiting previous API Version 2022-04-15-preview * Commiting latest API Version 2022-10-27 * Update to v3 types: * Adding words to custom-words.txt * run prettier check * Use v3 for appliance resource type too * resolve merge conflicts in custom words.txt * add in readmes * Add blockchain to latest profile * Add additional types * track2 modify eventhub readme.go.md (Azure#15338) * track2 modify operationalinsights readme.go.md (Azure#15354) * track2 modify security readme.go.md (Azure#15357) * track2 modify eventgrid readme.go.md (Azure#15358) * [Hub Generated] Public private branch 'dev-azure-kusto-Microsoft.Kusto-2021-08-27' (Azure#15905) * Adds base for updating Microsoft.Kusto from version stable/2021-01-01 to version 2021-08-27 * Updates readme * Updates API version in new specs and examples * Swagger changes * it1 * hh * it2 * it3 * it5 * it6 * it7 * readme * it10 * it11 * it11 * it 12 * it 13 * prettier * python * allowedIpRangeList - remove default * bassel changes * checkNameAvailability * fix lint * checkName * fix * managedPrivate check name * prettier * Update readme.python.md * add attached enum * Dor comments * fix description * readOnly Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> * update the format to int64 for creationtimestamp and expirationtimestamp * Updating Delete example to include location header for 202 response * fix header in delete example Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: hila levi <88654259+hilalevi170@users.noreply.github.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Aditi Malladi <amalladi@Aditis-MacBook-Pro.local>
* Adding resourceconnector - appliance GA API verson * Update swagger PR to add ArtifactURL and Another SSHKey type - ScopesAccessKey * Commiting previous API Version 2022-04-15-preview * Commiting latest API Version 2022-10-27 * Update to v3 types: * Adding words to custom-words.txt * run prettier check * Use v3 for appliance resource type too * resolve merge conflicts in custom words.txt * add in readmes * Add blockchain to latest profile * Add additional types * track2 modify eventhub readme.go.md (Azure#15338) * track2 modify operationalinsights readme.go.md (Azure#15354) * track2 modify security readme.go.md (Azure#15357) * track2 modify eventgrid readme.go.md (Azure#15358) * [Hub Generated] Public private branch 'dev-azure-kusto-Microsoft.Kusto-2021-08-27' (Azure#15905) * Adds base for updating Microsoft.Kusto from version stable/2021-01-01 to version 2021-08-27 * Updates readme * Updates API version in new specs and examples * Swagger changes * it1 * hh * it2 * it3 * it5 * it6 * it7 * readme * it10 * it11 * it11 * it 12 * it 13 * prettier * python * allowedIpRangeList - remove default * bassel changes * checkNameAvailability * fix lint * checkName * fix * managedPrivate check name * prettier * Update readme.python.md * add attached enum * Dor comments * fix description * readOnly Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> * update the format to int64 for creationtimestamp and expirationtimestamp * Updating Delete example to include location header for 202 response * fix header in delete example Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: JiahuiPeng <46921893+804873052@users.noreply.github.com> Co-authored-by: hila levi <88654259+hilalevi170@users.noreply.github.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Aditi Malladi <amalladi@Aditis-MacBook-Pro.local>
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.