-
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
Add new API version for databox 2022-10-01 #22049
Conversation
Hi, @utsrkr 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.4)] | new version | base version |
---|---|---|
databox.json | 2022-10-01(1e21dda) | 2022-09-01(main) |
databox.json | 2022-10-01(1e21dda) | 2021-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.DataBox/stable/2022-10-01/databox.json#L4783:7 Old: Microsoft.DataBox/stable/2022-09-01/databox.json#L4786:7 |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.DataBox/stable/2022-10-01/databox.json#L4783:7 Old: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L4203:7 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-10 | package-2022-10(1e21dda) | default(main) |
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: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
~[Staging] 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
|
Thank you for your contribution utsrkr! We will review the pull request and get back to you soon. |
Generated ApiView
|
Hi, @utsrkr your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Hi @utsrkr, 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. |
Hi, @utsrkr, 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 |
@microsoft-github-policy-service agree [company="Microsoft"] |
@microsoft-github-policy-service agree company="Microsoft" |
The initial commit is marked as "initial commit - copied files from previous api version" |
@mentat9 I had a discussion with my team regarding the comment on the PR to modify the ‘serialNumberCustomerResolutionMap’ in an RPC compliant way. We fully agree with the points mentioned – that keeping it in the current format (in the form of a dictionary with additional properties) is not ideal. However, in our use case, we require a dictionary, since we want the serial number to be non-duplicated. Also, currently our portal team has started using the API with the current contract. We fully agree that the contracts should have been reviewed before implementation and that this was an oversight on our part. However, currently, changing our contracts will lead to delay in our development cycle for the new feature and might lead to errors. Considering the above points, will it be possible to go ahead with the swagger (and API) in its current format? If required, I can book some time during the ARM office hours to explain the scenario. Please let me know whatever suits your convenience. |
It looks like I misread this property as being added to an existing resource type, but I see it is only in the request body of the mitigate action, so my concerns about Azure Policy and Azure Resource Graph don't apply. In reply to: 1374353780 Refers to: specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/databox.json:4824 in be2d2a7. [](commit_id = be2d2a7, deletion_comment = False) |
Python breaking is not caused by this PR since the new api-version is not confiured in readme.python.md |
@msyyc @tadelesh I missed the changes in the readme file, it was pointed out to me by a teammate. I have updated the PR with the changes in the readme file. In that context, @msyyc you might want to review the 'Python-ApprovedBreakingChange' tag once more. @tadelesh Let me get back to you regarding the change of parameter accountName to accountId. |
@tadelesh The change that you mentioned is approved by the following work item: https://msazure.visualstudio.com/One/_workitems/edit/15890768 |
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.
-[x] 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.