Skip to content

Conversation

@soumyapattnaik
Copy link
Contributor

@soumyapattnaik soumyapattnaik commented Aug 10, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Getting help

@openapi-workflow-bot
Copy link

Hi, @soumyapattnaik! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
  • @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 10, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 3 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    dataprotection.json 2023-06-01-preview(0b3bf4b) 2023-05-01(main)
    dataprotection.json 2023-06-01-preview(0b3bf4b) 2023-04-01-preview(main)

    The following breaking changes are detected by comparison with the latest preview version:

    Rule Message
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L6119:11
    Old: Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json#L5920:11
    ⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/managedidentity.json#L27:9
    Old: Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json#L5932:9
    ⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: common-types/resource-management/v4/managedidentity.json#L21:9
    Old: Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json#L5937:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.4) new version base version
    package-preview-2023-06 package-preview-2023-06(0b3bf4b) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'fetchsecondaryrecoverypoints' in:'SecondaryRPs_Fetch'. Consider updating the operationId
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L1543
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'fetchcrossregionrestorejob' in:'CrossRegionRestoreJob_Get'. Consider updating the operationId
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L1773
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'fetchcrossregionrestorejobs' in:'CrossRegionRestoreJobs_List'. Consider updating the operationId
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L1829


    The following errors/warnings exist before current PR submission:

    Rule Message
    ParametersOrder The parameters:operationId,location should be kept in the same order as they present in the path.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L64
    MissingTypeObject The schema 'AzureBackupFindRestorableTimeRangesRequestResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L4446
    MissingTypeObject The schema 'AzureBackupFindRestorableTimeRangesResponseResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L4477
    MissingTypeObject The schema 'AzureBackupRecoveryPointResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L4792
    MissingTypeObject The schema 'BackupInstanceResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L5235
    MissingTypeObject The schema 'BackupVaultResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L5423
    MissingTypeObject The schema 'BaseBackupPolicyResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L5483
    MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L5719
    MissingTypeObject The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L6369
    MissingTypeObject The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L6407
    MissingTypeObject The schema 'additionalDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L6673
    MissingTypeObject The schema 'additionalDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L6730
    ⚠️ DeprecatedXmsCodeGenerationSetting The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation.
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L6
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get OperationStatus
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L228
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get OperationStatus
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L276
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'validaterestore' in:'BackupInstances_ValidateForRestore'. Consider updating the operationId
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L2418
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'findrestorabletimeranges' in:'RestorableTimeRanges_Find'. Consider updating the operationId
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L2544
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'exportbackupjobs' in:'ExportJobs_Trigger'. Consider updating the operationId
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L2769
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List OperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3431
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List OperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3483
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List OperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3535
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List OperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3587
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List OperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3639
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get DefaultOperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3749
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get DefaultOperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3804
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get DefaultOperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3859
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get DefaultOperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3914
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get DefaultOperationsRequestObject
    Location: Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json#L3969
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    ️️✔️Automated merging requirements met succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 10, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/dataprotection/armdataprotection - 3.0.0-beta.1
    +	Type of `BaseResourceProperties.ObjectType` has been changed from `*string` to `*ResourcePropertiesObjectType`

    azure-sdk-for-js - @azure/arm-dataprotection - 2.0.0-beta.1
    +	Type of parameter objectType of interface BaseResourceProperties is changed from "BaseResourceProperties" to "DefaultResourceProperties"
    +	Type of parameter resourceProperties of interface Datasource is changed from BaseResourceProperties to BaseResourcePropertiesUnion
    +	Type of parameter resourceProperties of interface DatasourceSet is changed from BaseResourceProperties to BaseResourcePropertiesUnion
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 959d6c1fcf6cb85dfe6ecfa9a692b4d715715f6f. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.DataProtectionBackup [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 959d6c1fcf6cb85dfe6ecfa9a692b4d715715f6f. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-dataprotection [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_trigger_cross_region_restore
      info	[Changelog]   - Added operation BackupInstancesOperations.begin_validate_cross_region_restore
      info	[Changelog]   - Added operation JobsOperations.begin_trigger_cancel
      info	[Changelog]   - Added operation JobsOperations.generate_progress_url
      info	[Changelog]   - Added operation group BackupInstancesExtensionRoutingOperations
      info	[Changelog]   - Added operation group CrossRegionRestoreJobOperations
      info	[Changelog]   - Added operation group CrossRegionRestoreJobsOperations
      info	[Changelog]   - Added operation group SecondaryRPsOperations
      info	[Changelog]   - Model AzureBackupJob has a new parameter source_data_store_type
      info	[Changelog]   - Model JobExtendedInfo has a new parameter warning_details
      info	[Changelog]   - Model KubernetesClusterRestoreCriteria has a new parameter staging_resource_group_id
      info	[Changelog]   - Model KubernetesClusterRestoreCriteria has a new parameter staging_storage_account_id
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 959d6c1fcf6cb85dfe6ecfa9a692b4d715715f6f. 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
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-dataprotection [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 959d6c1fcf6cb85dfe6ecfa9a692b4d715715f6f. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/dataprotection/armdataprotection [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `BaseResourceProperties.ObjectType` has been changed from `*string` to `*ResourcePropertiesObjectType`
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `ResourcePropertiesObjectType` with values `ResourcePropertiesObjectTypeDefaultResourceProperties`
      info	[Changelog] - New function `*BackupInstancesClient.BeginTriggerCrossRegionRestore(context.Context, string, string, CrossRegionRestoreRequestObject, *BackupInstancesClientBeginTriggerCrossRegionRestoreOptions) (*runtime.Poller[BackupInstancesClientTriggerCrossRegionRestoreResponse], error)`
      info	[Changelog] - New function `*BackupInstancesClient.BeginValidateCrossRegionRestore(context.Context, string, string, ValidateCrossRegionRestoreRequestObject, *BackupInstancesClientBeginValidateCrossRegionRestoreOptions) (*runtime.Poller[BackupInstancesClientValidateCrossRegionRestoreResponse], error)`
      info	[Changelog] - New function `NewBackupInstancesExtensionRoutingClient(azcore.TokenCredential, *arm.ClientOptions) (*BackupInstancesExtensionRoutingClient, error)`
      info	[Changelog] - New function `*BackupInstancesExtensionRoutingClient.NewListPager(string, *BackupInstancesExtensionRoutingClientListOptions) *runtime.Pager[BackupInstancesExtensionRoutingClientListResponse]`
      info	[Changelog] - New function `*ClientFactory.NewBackupInstancesExtensionRoutingClient() *BackupInstancesExtensionRoutingClient`
      info	[Changelog] - New function `*ClientFactory.NewCrossRegionRestoreJobClient() *CrossRegionRestoreJobClient`
      info	[Changelog] - New function `*ClientFactory.NewCrossRegionRestoreJobsClient() *CrossRegionRestoreJobsClient`
      info	[Changelog] - New function `*ClientFactory.NewSecondaryRPsClient() *SecondaryRPsClient`
      info	[Changelog] - New function `NewCrossRegionRestoreJobClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CrossRegionRestoreJobClient, error)`
      info	[Changelog] - New function `*CrossRegionRestoreJobClient.Get(context.Context, string, string, CrossRegionRestoreJobRequest, *CrossRegionRestoreJobClientGetOptions) (CrossRegionRestoreJobClientGetResponse, error)`
      info	[Changelog] - New function `NewCrossRegionRestoreJobsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CrossRegionRestoreJobsClient, error)`
      info	[Changelog] - New function `*CrossRegionRestoreJobsClient.NewListPager(string, string, CrossRegionRestoreJobsRequest, *CrossRegionRestoreJobsClientListOptions) *runtime.Pager[CrossRegionRestoreJobsClientListResponse]`
      info	[Changelog] - New function `*DefaultResourceProperties.GetBaseResourceProperties() *BaseResourceProperties`
      info	[Changelog] - New function `*JobsClient.GenerateProgressURL(context.Context, string, string, string, *JobsClientGenerateProgressURLOptions) (JobsClientGenerateProgressURLResponse, error)`
      info	[Changelog] - New function `*JobsClient.BeginTriggerCancel(context.Context, string, string, string, *JobsClientBeginTriggerCancelOptions) (*runtime.Poller[JobsClientTriggerCancelResponse], error)`
      info	[Changelog] - New function `NewSecondaryRPsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SecondaryRPsClient, error)`
      info	[Changelog] - New function `*SecondaryRPsClient.NewFetchPager(string, string, FetchSecondaryRPsRequestParameters, *SecondaryRPsClientFetchOptions) *runtime.Pager[SecondaryRPsClientFetchResponse]`
      info	[Changelog] - New struct `AzureBackupJobProgressURL`
      info	[Changelog] - New struct `CrossRegionRestoreDetails`
      info	[Changelog] - New struct `CrossRegionRestoreJobRequest`
      info	[Changelog] - New struct `CrossRegionRestoreJobsRequest`
      info	[Changelog] - New struct `CrossRegionRestoreRequestObject`
      info	[Changelog] - New struct `DefaultResourceProperties`
      info	[Changelog] - New struct `FetchSecondaryRPsRequestParameters`
      info	[Changelog] - New struct `UserAssignedIdentityDetails`
      info	[Changelog] - New struct `UserFacingWarningDetail`
      info	[Changelog] - New struct `ValidateCrossRegionRestoreRequestObject`
      info	[Changelog] - New field `SourceDataStoreType` in struct `AzureBackupJob`
      info	[Changelog] - New field `WarningDetails` in struct `JobExtendedInfo`
      info	[Changelog] - New field `StagingResourceGroupID`, `StagingStorageAccountID` in struct `KubernetesClusterRestoreCriteria`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 42 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 959d6c1fcf6cb85dfe6ecfa9a692b4d715715f6f. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-dataprotection [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group BackupInstancesExtensionRouting
      info	[Changelog]   - Added operation group CrossRegionRestoreJob
      info	[Changelog]   - Added operation group CrossRegionRestoreJobs
      info	[Changelog]   - Added operation group SecondaryRPs
      info	[Changelog]   - Added operation BackupInstances.beginTriggerCrossRegionRestore
      info	[Changelog]   - Added operation BackupInstances.beginTriggerCrossRegionRestoreAndWait
      info	[Changelog]   - Added operation BackupInstances.beginValidateCrossRegionRestore
      info	[Changelog]   - Added operation BackupInstances.beginValidateCrossRegionRestoreAndWait
      info	[Changelog]   - Added operation Jobs.beginTriggerCancel
      info	[Changelog]   - Added operation Jobs.beginTriggerCancelAndWait
      info	[Changelog]   - Added operation Jobs.generateProgressUrl
      info	[Changelog]   - Added Interface AzureBackupJobProgressUrl
      info	[Changelog]   - Added Interface BackupInstancesExtensionRoutingListNextOptionalParams
      info	[Changelog]   - Added Interface BackupInstancesExtensionRoutingListOptionalParams
      info	[Changelog]   - Added Interface BackupInstancesTriggerCrossRegionRestoreHeaders
      info	[Changelog]   - Added Interface BackupInstancesTriggerCrossRegionRestoreOptionalParams
      info	[Changelog]   - Added Interface BackupInstancesValidateCrossRegionRestoreHeaders
      info	[Changelog]   - Added Interface BackupInstancesValidateCrossRegionRestoreOptionalParams
      info	[Changelog]   - Added Interface CrossRegionRestoreDetails
      info	[Changelog]   - Added Interface CrossRegionRestoreJobGetOptionalParams
      info	[Changelog]   - Added Interface CrossRegionRestoreJobRequest
      info	[Changelog]   - Added Interface CrossRegionRestoreJobsListNextOptionalParams
      info	[Changelog]   - Added Interface CrossRegionRestoreJobsListOptionalParams
      info	[Changelog]   - Added Interface CrossRegionRestoreJobsRequest
      info	[Changelog]   - Added Interface CrossRegionRestoreRequestObject
      info	[Changelog]   - Added Interface DefaultResourceProperties
      info	[Changelog]   - Added Interface FetchSecondaryRPsRequestParameters
      info	[Changelog]   - Added Interface JobsGenerateProgressUrlOptionalParams
      info	[Changelog]   - Added Interface JobsTriggerCancelHeaders
      info	[Changelog]   - Added Interface JobsTriggerCancelOptionalParams
      info	[Changelog]   - Added Interface SecondaryRPsFetchNextOptionalParams
      info	[Changelog]   - Added Interface SecondaryRPsFetchOptionalParams
      info	[Changelog]   - Added Interface UserAssignedIdentityDetails
      info	[Changelog]   - Added Interface UserFacingWarningDetail
      info	[Changelog]   - Added Interface ValidateCrossRegionRestoreRequestObject
      info	[Changelog]   - Added Type Alias BackupInstancesExtensionRoutingListNextResponse
      info	[Changelog]   - Added Type Alias BackupInstancesExtensionRoutingListResponse
      info	[Changelog]   - Added Type Alias BackupInstancesTriggerCrossRegionRestoreResponse
      info	[Changelog]   - Added Type Alias BackupInstancesValidateCrossRegionRestoreResponse
      info	[Changelog]   - Added Type Alias BaseResourcePropertiesUnion
      info	[Changelog]   - Added Type Alias CrossRegionRestoreJobGetResponse
      info	[Changelog]   - Added Type Alias CrossRegionRestoreJobsListNextResponse
      info	[Changelog]   - Added Type Alias CrossRegionRestoreJobsListResponse
      info	[Changelog]   - Added Type Alias JobsGenerateProgressUrlResponse
      info	[Changelog]   - Added Type Alias JobsTriggerCancelResponse
      info	[Changelog]   - Added Type Alias ResourcePropertiesObjectType
      info	[Changelog]   - Added Type Alias SecondaryRPsFetchNextResponse
      info	[Changelog]   - Added Type Alias SecondaryRPsFetchResponse
      info	[Changelog]   - Interface AzureBackupJob has a new optional parameter sourceDataStoreType
      info	[Changelog]   - Interface JobExtendedInfo has a new optional parameter warningDetails
      info	[Changelog]   - Interface KubernetesClusterRestoreCriteria has a new optional parameter stagingResourceGroupId
      info	[Changelog]   - Interface KubernetesClusterRestoreCriteria has a new optional parameter stagingStorageAccountId
      info	[Changelog]   - Added Enum KnownResourcePropertiesObjectType
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Type of parameter objectType of interface BaseResourceProperties is changed from "BaseResourceProperties" to "DefaultResourceProperties"
      info	[Changelog]   - Type of parameter resourceProperties of interface Datasource is changed from BaseResourceProperties to BaseResourcePropertiesUnion
      info	[Changelog]   - Type of parameter resourceProperties of interface DatasourceSet is changed from BaseResourceProperties to BaseResourcePropertiesUnion
    ️❌ azure-powershell failed [Detail]
    • Code Generator Failed [Logs] Generate from 959d6c1fcf6cb85dfe6ecfa9a692b4d715715f6f. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      error	Script return with result [failed] code [2] signal [null] cwd [azure-powershell]: sh ./tools/SwaggerCI/init.sh
      warn	File azure-powershell_tmp/initOutput.json not found to read
      error	Fatal error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
      ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
      Error: ENOENT: no such file or directory, open 'azure-powershell_tmp/generateInput.json'
          at Object.openSync (node:fs:590:3)
          at Object.writeFileSync (node:fs:2202:35)
          at Object.exports.writeTmpJsonFile (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/utils/fsUtils.js:121:18)
          at workflowCallGenerateScript (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:474:15)
          at workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:205:46)
          at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:94:9)
          at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:193:13)
          at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 10, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/dataprotection/armdataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-dataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-dataprotection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    .Net Azure.ResourceManager.DataProtectionBackup Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Swagger Microsoft.DataProtection Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @microsoft-github-policy-service microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Aug 10, 2023
    @microsoft-github-policy-service
    Copy link
    Contributor

    Thank you for your contribution soumyapattnaik! We will review the pull request and get back to you soon.

    @openapi-workflow-bot
    Copy link

    Hi @soumyapattnaik! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic ValidationFix-SemanticValidation-ErrorHigh
    Model ValidationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffHigh

    If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

    @openapi-workflow-bot
    Copy link

    Hi @soumyapattnaik! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
    For more details refer to the wiki.

    @TimLovellSmith
    Copy link
    Member

    Please fill in the PR template/questionnaire like purpose of the PR and due diligence.

    @TimLovellSmith
    Copy link
    Member

    Please also review the linter errors and address any that you can: especially those under [must fix]The following errors/warnings are introduced by current PR:
    https://github.com/Azure/azure-rest-api-specs/pull/25264/checks?check_run_id=15777161296

    @openapi-workflow-bot
    Copy link

    Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    This will notify the reviewer to have another look.
    If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
    Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 19, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 19, 2023

    Next Steps to Merge

    ⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

    Next steps that must be taken to merge this PR:
    • ❌ Your PR is in purview of ARM review (label: ARMReview). Please ensure your PR is on the ARM PR review queue - see instructions in steps 1 and 2 in the PR description diagram.
    • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

    @TimLovellSmith
    Copy link
    Member

    There appear to be some typos to fix there

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels Aug 25, 2023
    @soumyapattnaik
    Copy link
    Contributor Author

    Please also review the linter errors and address any that you can: especially those under [must fix]The following errors/warnings are introduced by current PR: https://github.com/Azure/azure-rest-api-specs/pull/25264/checks?check_run_id=15777161296

    This is not something i am changing currently. It is from older swagger 2023-04-01-preview.
    #23391

    There appear to be some typos to fix there

    fixed typos as part of commit 8480723

    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Aug 28, 2023
    @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 Aug 28, 2023
    @sjanamma
    Copy link

        "x-ms-long-running-operation-options": {
    

    options not required to set for control plane operations


    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json:1279 in 0b3bf4b. [](commit_id = 0b3bf4b, deletion_comment = False)

    @sjanamma
    Copy link

    Please address the swagger linter errors


    In reply to: 1684837331

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 30, 2023
    @hiaga
    Copy link
    Member

    hiaga commented Sep 19, 2023

    Please address the swagger linter errors

    In reply to: 1684837331

    @sjanamma I don't see any linter errors now. can you pls recheck

    @hiaga
    Copy link
    Member

    hiaga commented Sep 19, 2023

        "x-ms-long-running-operation-options": {
    

    options not required to set for control plane operations

    Refers to: specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-06-01-preview/dataprotection.json:1279 in 0b3bf4b. [](commit_id = 0b3bf4b, deletion_comment = False)

    x-ms-long-running-operation-options wasn't added in this PR. It is present in latest stable - https://github.com/Azure/azure-rest-api-specs/pull/24715/files

    Also this PR is targetting management plane APIs and not control plane APIs

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-MissingBaseCommit customer-reported Issues that are reported by GitHub users external to the Azure organization. new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    8 participants