Microsoft.DataProtection swagger changes #13235
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
|
Hi, @mayankagg9722 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. vsswagger@microsoft.com |
Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
|
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L4200 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1060 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1140 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1417 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1503 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isVisible Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1815 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: extendedInfo Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1824 |
|
| 'RecoveryPointsFilters' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1809 |
|
| 'restorePointDataStoreId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1812 |
|
| 'isVisible' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json#L1815 |
️️✔️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) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 10 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'AzureBackupRecoveryPointResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'BackupInstanceResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'BackupVaultResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'BaseBackupPolicyResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'Error' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'JobExtendedInfo-additionalDetails' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"dataprotection/resource-manager/readme.md", "tag":"package-2021-02-preview", "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 @mayankagg9722, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
BreakingChangeReviewRequired
and removed
CI-FixRequiredOnFailure
labels
|
Hi @mayankagg9722, 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. |
|
NewApiVersionRequired reason: |
This was referenced Mar 2, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
We are not changing the API version as we are just addressing early phase validation bugs assigned to us and no clients currently use this API version. So it is not a breaking change. |
openapi-workflow-bot
bot
added
FixS360
WaitForARMFeedback
|
Hi, @mayankagg9722 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @qianwens |
Thanks for confirming, but since this swagger was published in public repo there could be customers using this version. Please check the ARM calls pattern for this API version to confirm if there is no caller coming in and re-confirm. |
chiragg4u
added
ARMSignedOff
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
Please help fix the ModelValidation error before it can be merged. |
I have fixed this. Please review. |
qianwens
approved these changes
Mar 9, 2021
qianwens
added
the
Approved-BreakingChange
This was referenced Mar 9, 2021
Closed
Closed
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* manual changes for swagger * changes for long-running operations * changes for validate for backup and restore * removing 204 from operationResults * changes for a monitoring * adding format * removing date-time from duration * changing to readonly * changes for listRPs * fixes swagger * reverting readonly for scheduleTimes * fixes for checkgates * prettier fixes * cahnges for friendlyname checks * fixing gates * removing tracking-via * model validation fixes Co-authored-by: Mayank Aggarwal <mayaggar@microsoft.com>
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.