AzureDataShare: Adding version 2020-09-01 swagger. #12745
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
…he newly created folder for version 2020-09-01
|
Hi, @ahermas 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 |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.DataShare/stable/2020-09-01/DataShare.json#L5147 |
️️✔️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): 8 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2018-11-01-preview/DataShare.json <---> new: stable/2020-09-01/DataShare.json
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.DataShare/ListInvitations' removed or restructured? Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L314:5 |
|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.DataShare/locations/{location}/RejectInvitation' removed or restructured? Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L406:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/ConsumerSourceDataSets' removed or restructured? Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L1988:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/Synchronize' removed or restructured? Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L2265:5 |
|
| The required parameter 'providerShareSubscription' was added in the new version. New: Microsoft.DataShare/stable/2020-09-01/DataShare.json#L1550:11 |
|
| The new version has new required property 'sourceShareLocation' that was not found in the old version. New: Microsoft.DataShare/stable/2020-09-01/DataShare.json#L5798:7 Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L5674:7 |
|
| The new version has new required property 'sourceShareLocation' that was not found in the old version. New: Microsoft.DataShare/stable/2020-09-01/DataShare.json#L5763:9 Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L5640:9 |
|
| The new version has new required property 'sourceShareLocation' that was not found in the old version. New: Microsoft.DataShare/stable/2020-09-01/DataShare.json#L5791:5 Old: Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json#L5668:5 |
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 5 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2019-11-01/DataShare.json <---> new: stable/2020-09-01/DataShare.json
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.DataShare/ListInvitations' removed or restructured? Old: Microsoft.DataShare/stable/2019-11-01/DataShare.json#L314:5 |
|
| The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.DataShare/locations/{location}/RejectInvitation' removed or restructured? Old: Microsoft.DataShare/stable/2019-11-01/DataShare.json#L406:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/ConsumerSourceDataSets' removed or restructured? Old: Microsoft.DataShare/stable/2019-11-01/DataShare.json#L1988:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/Synchronize' removed or restructured? Old: Microsoft.DataShare/stable/2019-11-01/DataShare.json#L2265:5 |
|
| The required parameter 'providerShareSubscription' was added in the new version. New: Microsoft.DataShare/stable/2020-09-01/DataShare.json#L1550:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"datashare/resource-manager/readme.md", "tag":"package-2020-09-01", "details":"The schema 'DefaultDto-systemData' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"datashare/resource-manager/readme.md", "tag":"package-2020-09-01", "details":"The schema 'ProxyDto-systemData' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"datashare/resource-manager/readme.md", "tag":"package-2020-09-01", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @ahermas, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
AzureDataShare: First Commit : Just duplicating the files of the previous stable version 2019 into the newly created folder for version 2020-09-01. The upcoming second commit will be the real files for the new 2020-09-01. It will include the systemData property of azure resources. |
This was referenced Jan 30, 2021
ahermas
changed the title
ahermas
changed the title
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
The second commit is the that actually add the 2020-09-01 files. This is a branch new PR doine what was supposed to be done in this PR. |
erich-wang
added
the
WaitForARMFeedback
|
Adding label |
Hi @erich-wang , Thanks for your comment. I fixed the CI issue and now all checks have passed. Thanks |
|
Please mark the appropriate checkboxes from above, without marking them we cannot proceed to review your PR, we need to ensure that you reviewed our documentation repository and are following the standard. |
|
Hi, @ahermas your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @jorgecotillo |
@jorgecotillo fillGapWithZero is a string but we set it to "true" in our code for eg. |
jorgecotillo
added
ARMChangesRequested
|
@jorgecotillo I updated the PR to address your comment about systemdata to follow the property types from common-type. |
@jorgecotillo this is a tenant level fan out query that returns a list of items, we had clarified this in our initial review with ARM and went with their suggestion. |
@jorgecotillo this is the schema to be integrated with diagnostics logging team. |
11 tasks
|
@jorgecotillo I know that a check is still in progress but please let me know if you're ok with the recent changes to system data and Santosh's comments. |
If this is a string with a value "true" I assume it can be set to "false" which makes this a boolean. Please update the type to ensure type consistency. In reply to: 772095284 [](ancestors = 772095284) Refers to: specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/DataShare.json:5142 in 1128b45. [](commit_id = 1128b45, deletion_comment = False) |
|
Address fillGapWithZero type inconsistency please. |
@jorgecotillo I've addressed the "fillGapWithZero type inconsistency" |
jorgecotillo
added
ARMSignedOff
erich-wang
approved these changes
Feb 5, 2021
This was referenced Feb 5, 2021
This was referenced Feb 10, 2021
11 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Just duplicating the files of the previous stable version 2019 into the newly created folder for version 2020-09-01 * Second Commit : Adding the actual 2020-09-01 swagger files * Fix CI Avocado errors by editing readme files * Add UserAssigned enum to 2020-09-01 * Updated systemdata in DataShare according to types.json * Change fillGapWithZero to boolean instead of string
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.
Just duplicating the files of the previous stable version 2019 into the newly created folder for version 2020-09-01.
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 API 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.