Skip to content
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

Fixing swagger correctness and completeness issues for RecoveryServicesBackup #15024

Merged
merged 6 commits into from
Jul 8, 2021
Merged

Fixing swagger correctness and completeness issues for RecoveryServicesBackup #15024

merged 6 commits into from
Jul 8, 2021

Conversation

pratimaupadhyay02
Copy link
Contributor

@pratimaupadhyay02 pratimaupadhyay02 commented Jun 29, 2021

RecoveryServicesBackup

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.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

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.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • 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.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-workflow-bot
Copy link

Hi, @pratimaupadhyay02 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 29, 2021

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L21:5
    ️❌LintDiff: 1 Errors, 7 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L21
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'BackupResourceStorageConfigsNonCRR_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L70
    ⚠️ R1007 - PatchInOperationName 'PATCH' operation 'BackupResourceStorageConfigsNonCRR_patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L122
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L2375
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: crossRegionRestoreFlag
    Location: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L2333
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Vault Storage Configuration
    Location: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L529
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update Vault Storage Configuration
    Location: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L581
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update Vault Storage Configuration
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L157


    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L164
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L209
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L254
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L299
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L460
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L517
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L194
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L239
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L284
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.RecoveryServices/stable/2021-04-01/bms.json#L337
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION 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-04
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌[Staging] SDK Track2 Validation: 11 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    PreCheck/DuplicateSchema "readme":"recoveryservicesbackup/resource-manager/readme.md",
    "tag":"package-2021-04",
    "details":"Duplicate Schema named NewErrorResponse -- properties.error.$ref: undefined => "#/components/schemas/schemas:1087" ; 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-04",
    "details":"Duplicate Schema named NewErrorResponse-error -- properties.details.$ref: undefined => "#/components/schemas/schemas:1091" ; 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-04",
    "details":"Duplicate Schema named AzureFileShareRecoveryPoint -- properties.recoveryPointType.$ref: undefined => "#/components/schemas/schemas:1115",
    properties.recoveryPointType.readOnly: undefined => true,
    properties.recoveryPointTime.$ref: undefined => "#/components/schemas/schemas:1116",
    properties.recoveryPointTime.readOnly: undefined => true,
    properties.fileShareSnapshotUri.$ref: undefined => "#/components/schemas/schemas:1117",
    properties.fileShareSnapshotUri.readOnly: undefined => true,
    properties.recoveryPointSizeInGB.$ref: undefined => "#/components/schemas/schemas:1118",
    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-04",
    "details":"Duplicate Schema named AzureWorkloadPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1252" ; 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-04",
    "details":"Duplicate Schema named AzureWorkloadRecoveryPoint -- properties.recoveryPointTimeInUTC.$ref: undefined => "#/components/schemas/schemas:1253",
    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-04",
    "details":"Duplicate Schema named AzureWorkloadSAPHanaPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1248" ; 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-04",
    "details":"Duplicate Schema named AzureWorkloadSAPHanaRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1252" ; 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-04",
    "details":"Duplicate Schema named AzureWorkloadSQLPointInTimeRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1273" ; 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-04",
    "details":"Duplicate Schema named AzureWorkloadSQLRecoveryPoint -- allOf.0.$ref: undefined => "#/components/schemas/schemas:1252",
    properties.extendedInfo.$ref: undefined => "#/components/schemas/schemas:1274" ; 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-04",
    "details":"Duplicate Schema named AzureWorkloadSQLRecoveryPointExtendedInfo -- properties.dataDirectoryTimeInUTC.$ref: undefined => "#/components/schemas/schemas:1275",
    properties.dataDirectoryTimeInUTC.readOnly: undefined => true,
    properties.dataDirectoryPaths.$ref: undefined => "#/components/schemas/schemas:1276",
    properties.dataDirectoryPaths.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."


    The following errors/warnings exist before current PR submission:

    Rule Message
    PreCheck/DuplicateSchema "readme":"recoveryservicesbackup/resource-manager/readme.md",
    "tag":"package-2021-04",
    "details":"Duplicate Schema named AzureFileshareProtectedItem -- properties.healthStatus: undefined => "x-ms-enum":"name":"HealthStatus",
    "modelAsString":true,
    "$ref":"#/components/schemas/HealthStatus",
    "description":"backups running status for this backup item." ; 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."
    AutorestCore/Exception "readme":"recoveryservicesbackup/resource-manager/readme.md",
    "tag":"package-2021-04",
    "details":"Error: Plugin prechecker reported failure."
    💬 AutorestCore/Exception "readme":"recoveryservicesbackup/resource-manager/readme.md",
    "tag":"package-2021-04",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 29, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-recoveryservicesbackup - 1.0.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2021-01-01/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2020-12-01/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2020-02-02/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2019-06-15/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2019-05-13/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2017-07-01/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2016-12-01/backup - v55.5.0
    ️✔️azure-sdk-for-go - recoveryservices/mgmt/2016-06-01/backup - v55.5.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2cbe9bd. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.RecoveryServices.Backup [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2cbe9bd. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-recoveryservicesbackup [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model AzureWorkloadRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model Day has a new parameter date_property
      info	[Changelog]   - Model IaasVMRestoreWithRehydrationRequest has a new parameter identity_info
      info	[Changelog]   - Model AzureWorkloadPointInTimeRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSAPHanaRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureFileshareProtectedItem has a new parameter health_status
      info	[Changelog]   - Model AzureWorkloadSAPHanaPointInTimeRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSQLRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSQLRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model IaasVMRestoreRequest has a new parameter identity_info
      info	[Changelog]   - Model AzureWorkloadSAPHanaRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSQLPointInTimeRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Added operation ProtectionPoliciesOperations.delete
      info	[Changelog]   - Added operation PrivateEndpointConnectionOperations.delete
      info	[Changelog]   - Added operation PrivateEndpointConnectionOperations.put
      info	[Changelog]   - Added operation RecoveryServicesBackupClientOperationsMixin.bms_trigger_data_move
      info	[Changelog]   - Added operation RecoveryServicesBackupClientOperationsMixin.move_recovery_point
      info	[Changelog]   - Added operation RecoveryServicesBackupClientOperationsMixin.bms_prepare_data_move
      info	[Changelog]   - Added operation CrossRegionRestoreOperations.trigger
      info	[Changelog]   - Added operation RestoresOperations.trigger
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation RecoveryPointsRecommendedForMoveOperations.list has a new signature
      info	[Changelog]   - Operation RecoveryPointsRecommendedForMoveOperations.list has a new signature
      info	[Changelog]   - Operation SecurityPINsOperations.get has a new signature
      info	[Changelog]   - Operation RecoveryPointsOperations.list has a new signature
      info	[Changelog]   - Operation RecoveryPointsOperations.get_access_token has a new signature
      info	[Changelog]   - Operation RecoveryPointsOperations.get has a new signature
      info	[Changelog]   - Operation RecoveryPointsCrrOperations.list has a new signature
      info	[Changelog]   - Operation ProtectionPolicyOperationStatusesOperations.get has a new signature
      info	[Changelog]   - Operation ProtectionPolicyOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation ProtectionPoliciesOperations.get has a new signature
      info	[Changelog]   - Operation ProtectionPoliciesOperations.create_or_update has a new signature
      info	[Changelog]   - Operation ProtectionIntentOperations.validate has a new signature
      info	[Changelog]   - Operation ProtectionIntentOperations.get has a new signature
      info	[Changelog]   - Operation ProtectionIntentOperations.delete has a new signature
      info	[Changelog]   - Operation ProtectionIntentOperations.create_or_update has a new signature
      info	[Changelog]   - Operation ProtectionContainersOperations.unregister has a new signature
      info	[Changelog]   - Operation ProtectionContainersOperations.register has a new signature
      info	[Changelog]   - Operation ProtectionContainersOperations.refresh has a new signature
      info	[Changelog]   - Operation ProtectionContainersOperations.inquire has a new signature
      info	[Changelog]   - Operation ProtectionContainersOperations.get has a new signature
      info	[Changelog]   - Operation ProtectionContainerRefreshOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation ProtectionContainerOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation ProtectedItemsOperations.get has a new signature
      info	[Changelog]   - Operation ProtectedItemsOperations.delete has a new signature
      info	[Changelog]   - Operation ProtectedItemsOperations.create_or_update has a new signature
      info	[Changelog]   - Operation ProtectedItemOperationStatusesOperations.get has a new signature
      info	[Changelog]   - Operation ProtectedItemOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation ProtectableContainersOperations.list has a new signature
      info	[Changelog]   - Operation PrivateEndpointOperations.get_operation_status has a new signature
      info	[Changelog]   - Operation PrivateEndpointConnectionOperations.get has a new signature
      info	[Changelog]   - Operation OperationOperations.validate has a new signature
      info	[Changelog]   - Operation JobsOperations.export has a new signature
      info	[Changelog]   - Operation JobOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation JobDetailsOperations.get has a new signature
      info	[Changelog]   - Operation JobCancellationsOperations.trigger has a new signature
      info	[Changelog]   - Operation ItemLevelRecoveryConnectionsOperations.revoke has a new signature
      info	[Changelog]   - Operation ItemLevelRecoveryConnectionsOperations.provision has a new signature
      info	[Changelog]   - Operation FeatureSupportOperations.validate has a new signature
      info	[Changelog]   - Operation ExportJobsOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation CrrOperationStatusOperations.get has a new signature
      info	[Changelog]   - Operation CrrOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation BackupsOperations.trigger has a new signature
      info	[Changelog]   - Operation BackupWorkloadItemsOperations.list has a new signature
      info	[Changelog]   - Operation BackupUsageSummariesOperations.list has a new signature
      info	[Changelog]   - Operation BackupUsageSummariesCRROperations.list has a new signature
      info	[Changelog]   - Operation BackupStatusOperations.get has a new signature
      info	[Changelog]   - Operation BackupResourceVaultConfigsOperations.update has a new signature
      info	[Changelog]   - Operation BackupResourceVaultConfigsOperations.put has a new signature
      info	[Changelog]   - Operation BackupResourceVaultConfigsOperations.get has a new signature
      info	[Changelog]   - Operation BackupResourceStorageConfigsOperations.update has a new signature
      info	[Changelog]   - Operation BackupResourceStorageConfigsOperations.patch has a new signature
      info	[Changelog]   - Operation BackupResourceStorageConfigsOperations.get has a new signature
      info	[Changelog]   - Operation BackupResourceEncryptionConfigsOperations.update has a new signature
      info	[Changelog]   - Operation BackupResourceEncryptionConfigsOperations.get has a new signature
      info	[Changelog]   - Operation BackupProtectionIntentOperations.list has a new signature
      info	[Changelog]   - Operation BackupProtectionContainersOperations.list has a new signature
      info	[Changelog]   - Operation BackupProtectedItemsOperations.list has a new signature
      info	[Changelog]   - Operation BackupProtectedItemsCrrOperations.list has a new signature
      info	[Changelog]   - Operation BackupProtectableItemsOperations.list has a new signature
      info	[Changelog]   - Operation BackupPoliciesOperations.list has a new signature
      info	[Changelog]   - Operation BackupOperationStatusesOperations.get has a new signature
      info	[Changelog]   - Operation BackupOperationResultsOperations.get has a new signature
      info	[Changelog]   - Operation BackupJobsOperations.list has a new signature
      info	[Changelog]   - Operation BackupEnginesOperations.list has a new signature
      info	[Changelog]   - Operation BackupEnginesOperations.get has a new signature
      info	[Changelog]   - Operation BMSPrepareDataMoveOperationResultOperations.get has a new signature
      info	[Changelog]   - Operation AadPropertiesOperations.get has a new signature
      info	[Changelog]   - Model Day no longer has parameter date
      info	[Changelog]   - Operation Operations.list has a new signature
      info	[Changelog]   - Operation BackupCrrJobDetailsOperations.get has a new signature
      info	[Changelog]   - Operation BackupCrrJobsOperations.list has a new signature
      info	[Changelog]   - Removed operation ProtectionPoliciesOperations.begin_delete
      info	[Changelog]   - Removed operation PrivateEndpointConnectionOperations.begin_delete
      info	[Changelog]   - Removed operation PrivateEndpointConnectionOperations.begin_put
      info	[Changelog]   - Removed operation RecoveryServicesBackupClientOperationsMixin.begin_bms_trigger_data_move
      info	[Changelog]   - Removed operation RecoveryServicesBackupClientOperationsMixin.begin_bms_prepare_data_move
      info	[Changelog]   - Removed operation RecoveryServicesBackupClientOperationsMixin.begin_move_recovery_point
      info	[Changelog]   - Removed operation CrossRegionRestoreOperations.begin_trigger
      info	[Changelog]   - Removed operation RestoresOperations.begin_trigger
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2cbe9bd. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-recoveryservicesbackup [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model AzureWorkloadSQLPointInTimeRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model IaasVMRestoreWithRehydrationRequest has a new parameter identity_info
      info	[Changelog]   - Model IaasVMRestoreRequest has a new parameter identity_info
      info	[Changelog]   - Model AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSAPHanaRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSAPHanaRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadPointInTimeRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSQLRestoreRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSQLRestoreWithRehydrateRequest has a new parameter target_virtual_machine_id
      info	[Changelog]   - Model AzureWorkloadSAPHanaPointInTimeRestoreRequest has a new parameter target_virtual_machine_id
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2cbe9bd. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-07-08 08:01:37 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-recoveryservicesbackup;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-07-08 08:01:37 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-07-08 08:01:37 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.32 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/recoveryservicesbackup/azure-resourcemanager-recoveryservicesbackup --java.namespace=com.azure.resourcemanager.recoveryservicesbackup   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/readme.md
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-recoveryservicesbackup
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [POM][Skip] pom already has module azure-resourcemanager-recoveryservicesbackup
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [POM][Skip] pom already has module sdk/recoveryservicesbackup
      cmderr	[generate.py] 2021-07-08 08:02:39 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-recoveryservicesbackup [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-07-08 08:04:36 DEBUG Got artifact_id: azure-resourcemanager-recoveryservicesbackup
      cmderr	[Inst] 2021-07-08 08:04:36 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-07-08 08:04:36 DEBUG Got artifact: azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-07-08 08:04:36 DEBUG Match jar package: azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-07-08 08:04:36 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15024/azure-sdk-for-java/azure-resourcemanager-recoveryservicesbackup/azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.2.jar\" -o azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-recoveryservicesbackup -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2cbe9bd. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️recoveryservices/mgmt/2021-01-01/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New struct `IdentityInfo`
      info	[Changelog] - New field `IdentityInfo` in struct `IaasVMRestoreRequest`
      info	[Changelog] - New field `IdentityInfo` in struct `IaasVMRestoreWithRehydrationRequest`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 4 additive change(s).
      info	[Changelog]
    • ️✔️recoveryservices/mgmt/2020-12-01/backup [View full logs
      info	[Changelog] This is a new package
    • ️✔️recoveryservices/mgmt/2020-02-02/backup [View full logs
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2019-06-15/backup [View full logs
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2019-05-13/backup [View full logs
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2017-07-01/backup [View full logs
      info	[Changelog] This is a new package
    • ️✔️recoveryservices/mgmt/2016-12-01/backup [View full logs
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2016-06-01/backup [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2cbe9bd. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/readme.md
    • ️✔️@azure/arm-recoveryservicesbackup [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/recoveryServicesBackupClient.js → ./dist/arm-recoveryservicesbackup.js...
      cmderr	[npmPack] created ./dist/arm-recoveryservicesbackup.js in 1.2s
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2cbe9bd. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️recoveryservicesbackup [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @pratimaupadhyay02, 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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @raych1 raych1 assigned jianyexi and unassigned raych1 Jun 30, 2021
    @jianyexi jianyexi assigned ruowan and unassigned jianyexi Jun 30, 2021
    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 2, 2021
    @@ -18,6 +18,149 @@
    "application/json"
    ],
    "paths": {
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig": {
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    The api-version 2018-12-20 has the same path, but the tag is different. So it's conflict. Pls fix it

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Hi @ruowan In this PR the API BackupResourceStorageConfigs which is already present in the version 2018-12-20, is being added in the version 2021-04-01(which routes the request to the active stamp) with different operationId and tag which will ensure a new SDK function is generated for this API that routes the request specifically to active stamp.

    We have followed similar procedure for a number of other APIs and the SDK generation has always worked in the past. This is an example of such a scenario : This is the API in 2021-04-01 :

    "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries": {

    This is the same API in 2018-12-20 with different operationId and tag :
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries": {

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    It seems you changed the tags of the below api in the new api version , this caused conflict.
    $.paths["/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.RecoveryServices/vaults/vaultName/backupstorageconfig/vaultstorageconfig"].get

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    discussed offline, accept this change as this situation exists for historical reason, and cannot easily fix.

    @ruowan ruowan assigned zhenglaizhang and unassigned ruowan Jul 7, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @pratimaupadhyay02 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 8, 2021
    @zhenglaizhang
    Copy link
    Contributor

    discussed offline, ARM review is not needed as this is copied from old version.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff CI-BreakingChange-Go CI-BreakingChange-Python FixS360 WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants