-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
DataBox API version upgrade to 2022-09-01 #20717
DataBox API version upgrade to 2022-09-01 #20717
Conversation
Hi, @ashoknailwal 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 |
Hi, @ashoknailwal your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
databox.json | 2022-09-01(2e5edf4) | 2022-02-01(main) |
databox.json | 2022-09-01(2e5edf4) | 2021-08-01-preview(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 2 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-09 | package-2022-09(2e5edf4) | default(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.DataBox/stable/2022-09-01/databox.json#L5279 |
||
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.DataBox/stable/2022-09-01/databox.json#L6250 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 13 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Deployed
Test run on region: westeurope; Operation coverage: total: 18, untested: 0, failed: 13, passed: 5
Service API Readiness Test failed. Check pipeline artifact for detail report.
Rule | Message |
---|---|
CLIENT_ERROR |
"statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' has permission to perform action 'Microsoft.DataBox/jobs/write' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-phqaKW-20717/providers/Microsoft.DataBox/jobs/jobnameeonwrh'; however, it does not have permission to perform action 'write' on the linked scope(s) '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount' or the linked scope(s) are invalid." |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.DataBox/locations/regionConfiguration/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials." |
CLIENT_ERROR |
"statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.DataBox/locations/validateAddress/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials." |
CLIENT_ERROR |
"statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.DataBox/locations/validateInputs/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials." |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.DataBox/jobs/jobnameeonwrh' under resource group 'apiTest-phqaKW-20717' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
SERVER_ERROR |
"statusCode: 500, errorCode: RestApiInternalError, errorMessage: " |
SERVER_ERROR |
"statusCode: 500, errorCode: TransportGenericNonRetryableError, errorMessage: " |
️️✔️
~[Staging] SwaggerAPIView 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
|
Hi @rkmanda, Currently we have the commerce boundary and country list map as part of a json config, after deserialization we have kept it as strings, similar to |
Hi, @ashoknailwal. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @ashoknailwal, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This reverts commit 215f002.
Hi @ashoknailwal, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
* Initial commit - copy files from previous version * Changes for v2022-09-01 * Remove unnecessary properties and add description and fix CI issues * Update databox.json * Revert "Update databox.json" This reverts commit 215f002. * add account id changes, fixed in previous api version * fix swagger validation issues and account id changes as per previous api version * fix swagger modelvalidation issue for location header Co-authored-by: Aakash Saini <rockmyinboxx@gmail.com>
* Initial commit - copy files from previous version * Changes for v2022-09-01 * Remove unnecessary properties and add description and fix CI issues * Update databox.json * Revert "Update databox.json" This reverts commit 215f002. * add account id changes, fixed in previous api version * fix swagger validation issues and account id changes as per previous api version * fix swagger modelvalidation issue for location header Co-authored-by: Aakash Saini <rockmyinboxx@gmail.com>
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.