Sawgger changes for DataBoxEdge version (2020-12-01) #13065
Merged
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
pvsraviteja
requested review from
ArcturusZhang,
ChenTanyi,
jsntcy and
msyyc
as code owners
|
Hi, @pvsraviteja 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
|
| Rule | Message |
|---|---|
| The child tracked resource, 'addons' with immediate parent 'Role', must have a list by immediate parent operation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L3783 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L6902 |
|
| 'state' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L5244 |
|
| 'registrationDate' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L5258 |
|
| 'subscriptionId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L5261 |
|
| 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L5264 |
|
| 'SubscriptionProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8043 |
|
| 'tenantId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8046 |
|
| 'locationPlacementId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8049 |
|
| 'quotaId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8052 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 2 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2020-09-01-preview/databoxedge.json <---> new: stable/2020-12-01/databoxedge.json
| Rule | Message |
|---|---|
| The new version has new required property 'userType' that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8508:9 Old: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L8397:9 |
|
| The new version has new required property 'userType' that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8562:5 Old: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L8451:5 |
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 2 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2020-09-01/databoxedge.json <---> new: stable/2020-12-01/databoxedge.json
| Rule | Message |
|---|---|
| The new version has new required property 'userType' that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8508:9 Old: Microsoft.DataBoxEdge/stable/2020-09-01/databoxedge.json#L8397:9 |
|
| The new version has new required property 'userType' that was not found in the old version. New: Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json#L8562:5 Old: Microsoft.DataBoxEdge/stable/2020-09-01/databoxedge.json#L8451:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 27 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"The schema 'CloudErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'ArcAddon' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'ArcAddon' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'CloudEdgeManagementRole' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from CloudEdgeManagementRole" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'CloudEdgeManagementRole' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from CloudEdgeManagementRole" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'CloudEdgeManagementRole' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from CloudEdgeManagementRole" |
|
| "readme":"databoxedge/resource-manager/readme.md", "tag":"package-2020-12-01", "details":"Schema 'FileEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from FileEventTrigger" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @pvsraviteja, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 19, 2021
pvsraviteja
force-pushed
the
developer/rapvs/DBESDKLatest
branch
from
602c0a0
to
fc039da
Compare
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
This was referenced Feb 19, 2021
This was referenced Feb 19, 2021
pvsraviteja
force-pushed
the
developer/rapvs/DBESDKLatest
branch
from
fc039da
to
36fd04b
Compare
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
pvsraviteja
force-pushed
the
developer/rapvs/DBESDKLatest
branch
from
44d7c55
to
0f19320
Compare
You haven't added the $skiptoken parameter. Also: current guidance is to use $top and $skip for pagination. Refers to: specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json:3581 in 0f19320. [](commit_id = 0f19320, deletion_comment = False) |
Best practice is to use enum [True, False] to allow adding future values without a breaking change. Might want to consider actionType: enum [Data, Control (or whatever non-data is)], or something similar instead. Refers to: specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json:6904 in 0f19320. [](commit_id = 0f19320, deletion_comment = False) |
mentat9
added
the
ARMChangesRequested
Corrected the description as per swagger. It was incorrect earlier. |
This is not being used in our API's. |
|
@pvsraviteja Agreed on both counts: changing the boolean to an enum would be a breaking change from the previous api-version. , and your change to the description resolves the issue. |
markcowl
approved these changes
Feb 23, 2021
markcowl
added
ARMSignedOff
|
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki Window to Fix Broken for more details. |
This was referenced Feb 24, 2021
[ReleasePR databoxedge] add con figuration for databoxedge
Azure/azure-resource-manager-schemas#1335
Merged
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Copy existing folder 2020-09-01 to 2020-12-01 version * DataBoxEdge Changes * Read me file changes * Correct description as per API
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.