-
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
MFA MUA V1 swagger changes #13079
MFA MUA V1 swagger changes #13079
Conversation
Hi, @deymadhumanti 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
|
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/recoveryservicesbackup/resource-manager/readme.md tag: specification/recoveryservicesbackup/resource-manager/readme.md#tag-package-2021-02 |
️️✔️
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.
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2021-02-01/bms.json <---> new: preview/2021-02-01-preview/bms.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
[Staging] SDK Track2 Validation: 13 Errors, 27 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named NewErrorResponse -- properties.error.$ref: undefined => "#/components/schemas/schemas:1020" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named NewErrorResponse-error -- properties.details.$ref: undefined => "#/components/schemas/schemas:1024" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureFileshareProtectedItem -- properties.healthStatus: undefined => "description":"backups running status for this backup item.", "$ref":"#/components/schemas/HealthStatus" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureFileShareRecoveryPoint -- properties.recoveryPointType.$ref: undefined => "#/components/schemas/schemas:1047", properties.recoveryPointType.readOnly: undefined => true, properties.recoveryPointTime.$ref: undefined => "#/components/schemas/schemas:1048", properties.recoveryPointTime.readOnly: undefined => true, properties.fileShareSnapshotUri.$ref: undefined => "#/components/schemas/schemas:1049", properties.fileShareSnapshotUri.readOnly: undefined => true, properties.recoveryPointSizeInGB.readOnly: undefined => true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureWorkloadPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1174" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureWorkloadRecoveryPoint -- properties.recoveryPointTimeInUTC.$ref: undefined => "#/components/schemas/schemas:1175", properties.recoveryPointTimeInUTC.readOnly: undefined => true, properties.type.readOnly: undefined => true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureWorkloadSAPHanaPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1170" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureWorkloadSAPHanaRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1174" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureWorkloadSQLPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1194" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"recoveryservicesbackup/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named AzureWorkloadSQLRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1174", properties.extendedInfo.$ref: undefined => "#/components/schemas/schemas:1195" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi @deymadhumanti, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @jianyexi , Can you please review this PR. No new changes are there. Copied content of 2021-02-01 folder in 2021-02-01-preview folder. We will make the swagger changes for those features which are in preview stage on top of this changes. |
It seems have duplicate schema in the swagger , could you fix it ?
|
Please go through the contribution checklist added as part of the review and mark them completed. This is a requirement before review can be continued. |
@deymadhumanti could you update the contribution checklists above? We can't start the review before the checklist is completed. |
Hi @filizt , I have completed the contribution checklist. Can you please review the PR now. |
Are you adding a new preview API version? The content of the PR is the same as stable 2021-02-01. One thing to be aware is that once the PR is merged, then any change to the preview API version may need to go through the breaking changes review depending on the type of the change. You can find more information about API changes and versioning here: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#versioning Refers to: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2021-02-01-preview/bms.json:4 in 83c5337. [](commit_id = 83c5337, deletion_comment = False) |
"subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
"resourceGroupName": "rishgrp", | ||
"vaultName": "rishTestVault", | ||
"api-version": "2021-01-01" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"api-version": "2021-01-01" [](start = 3, length = 28)
nit - update api-version to the new version (in other examples too)
* MFA MUA V1 swagger changes * Copying json from 2021-02-01 to 2021-02-01-preview * Moving these details under Preview folder * Fixing Avocado errors * updated version in example json files Co-authored-by: Madhumanti Dey <madhude@microsoft.com>
* MFA MUA V1 swagger changes * Copying json from 2021-02-01 to 2021-02-01-preview * Moving these details under Preview folder * Fixing Avocado errors * updated version in example json files Co-authored-by: Madhumanti Dey <madhude@microsoft.com>
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.
No new changes are there. copied content of 2021-02-01 folder in 2021-02-01-preview folder. Will add MFA MUA related APIs on top of this existing json file
In this PR, we have copied the content from stable\2021-02-01 (latest stable swagger json) to preview\2021-02-01-preview folder. Then, updated the swagger version to 2021-02-01-preview in swagger json file and all example json file in preview\2021-02-01-preview folder. Now stable and preview swagger json has same content. Only swagger version is different for both. For all the features which are in preview stage, we are planning to make changes on top this preview\2021-02-01-preview\bms.json file.