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

[recoveryservicessiterecovery] resolving compeleteness issues for API version 2023-01-01 #22741

Conversation

hiaga
Copy link
Member

@hiaga hiaga commented Feb 22, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @hiaga 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 22, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    service.json 2023-01-01(4575f31) 2022-10-01(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 126 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L631:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationFabrics_Purge.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L679:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationFabrics_CheckConsistency.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L727:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationFabrics_MigrateToAad.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L787:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationFabrics_ReassociateGateway.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L835:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationFabrics_Delete.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L895:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationFabrics_RenewCertificate.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L1356:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationNetworkMappings_Delete.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L1428:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationNetworkMappings_Update.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L1670:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L1725:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectionContainers_Delete.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2003:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_Delete.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2075:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_Update.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2152:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_Migrate.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2359:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_PauseReplication.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2436:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_ResumeReplication.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2513:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_Resync.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2590:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_TestMigrate.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L2667:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3060:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_Purge.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3132:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_Update.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3209:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_AddDisks.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3286:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3351:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_FailoverCancel.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3416:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_FailoverCommit.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3493:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_PlannedFailover.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3699:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_Delete.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3773:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_RemoveDisks.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3838:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_RepairReplication.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3915:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_Reprotect.json
    LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.RecoveryServices/stable/2023-01-01/service.json#L3992:22
    ExampleUrl: stable/2023-01-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 22, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from ff9a9a72da0700899bad4dcebf05c6974febe1a5. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.5.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.0>
      cmderr	[automation_generate.sh] npmnotice Run `npm install -g npm@9.5.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-recoveryservicessiterecovery [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from ff9a9a72da0700899bad4dcebf05c6974febe1a5. 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/recoveryservices/armrecoveryservicessiterecovery [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from ff9a9a72da0700899bad4dcebf05c6974febe1a5. 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
      cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
    • ️✔️@azure/arm-recoveryservices-siterecovery [View full logs]  [Preview SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from ff9a9a72da0700899bad4dcebf05c6974febe1a5. 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
    • ️✔️recoveryservicessiterecovery [View full logs]  [Preview Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from ff9a9a72da0700899bad4dcebf05c6974febe1a5. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.SiteRecovery [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 22, 2023

    Generated ApiView

    Language Package Name ApiView Link
    swagger Microsoft.RecoveryServices https://apiview.dev/Assemblies/Review/aee8b30c968a4e3da42af787523aba0f
    Go sdk/resourcemanager/recoveryservices/armrecoveryservicessiterecovery https://apiview.dev/Assemblies/Review/189ef98dc2a64af6925563abe92ee2ce
    Java azure-resourcemanager-recoveryservicessiterecovery There is no API change compared with the previous version
    .Net Azure.ResourceManager.RecoveryServicesSiteRecovery There is no API change compared with the previous version
    JavaScript @azure/arm-recoveryservices-siterecovery There is no API change compared with the previous version

    @openapi-workflow-bot
    Copy link

    Hi, @hiaga, 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. Or you could onboard API spec pipeline

    @openapi-workflow-bot
    Copy link

    Hi @hiaga, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @hiaga
    Copy link
    Member Author

    hiaga commented Feb 22, 2023

    @weidongxu-microsoft This PR is just a refresh from the last stable API version 2022-10-01 to 2023-01-01. Nothing changed

    Copy link
    Member

    @weidongxu-microsoft weidongxu-microsoft left a comment

    Choose a reason for hiding this comment

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

    Please either fix ModelValidation error, or apply for suppression.

    I cannot merge when required CI failed.

    @NetRock NetRock added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 23, 2023
    @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 Feb 23, 2023
    @hiaga
    Copy link
    Member Author

    hiaga commented Feb 24, 2023

    @weidongxu-microsoft will check on this and get back

    @hiaga
    Copy link
    Member Author

    hiaga commented Mar 2, 2023

    @weidongxu-microsoft I see the modelValidation failed and suppressed in the last PR too - #20998 and no additional changes were made in this PR, please let me know how to suppress it

    @hiaga hiaga closed this Mar 3, 2023
    @hiaga
    Copy link
    Member Author

    hiaga commented Mar 3, 2023

    closing since another PR fixes this - #22076

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

    Successfully merging this pull request may close these issues.

    4 participants