DataBox API Version Upgrade to 2023-12-01#26822
Merged
visingla-ms merged 8 commits intoAzure:mainfrom Dec 8, 2023
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 |
|---|---|---|
| databox.json | 2023-12-01(3db4dfe) | 2023-03-01(main) |
| databox.json | 2023-12-01(3db4dfe) | 2021-08-01-preview(main) |
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/2023-12-01/databox.json#L5270: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.1.6) | new version | base version |
|---|---|---|
| package-2023-12 | package-2023-12(3db4dfe) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L40 |
ParametersOrder |
The parameters:jobName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L113 |
ParametersOrder |
The parameters:jobName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L167 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L514 |
ProvisioningStateSpecifiedForLROPut |
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L567 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L567 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L567 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L609 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L615 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L638 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L683 |
ConsistentPatchProperties |
The property 'properties.details.returnToCustomerPackageDetails' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L730 |
ProvisioningStateSpecifiedForLROPatch |
200 response schema in long running PATCH operation is missing ProvisioningState property. A LRO PATCH operations 200 response schema must have ProvisioningState specified. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L736 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L754 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L1084 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L1160 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L1299 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L1383 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L1395 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L1446 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L2257 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L2291 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L2979 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3030 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3100 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3124 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3149 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3162 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3185 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.DataBox/stable/2023-12-01/databox.json#L3209 |
️️✔️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: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Click detail for error messages. Exception contact vsswagger@microsoft.com or https://aka.ms/swaggersupport. |
️️✔️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
|
|
Hi @gaurikapoplai! 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. |
This was referenced Dec 7, 2023
Contributor
Author
|
/pr RequestMerge |
visingla-ms
approved these changes
Dec 8, 2023
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
* initial commit - copied files from previous version * added new version of databox.json * modified examples * updated readme.md files * fixes for failing checks * fix * fixes * prettier run
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
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.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReviewlabel.Click here to see the diagram footnotes
Diagram footnotes
[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 the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
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.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.