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

Updating existing CRR APIs with ArchiveV1 feature #12683

Merged
merged 2 commits into from
Jan 29, 2021
Merged

Updating existing CRR APIs with ArchiveV1 feature #12683

merged 2 commits into from
Jan 29, 2021

Conversation

anjorsh
Copy link
Member

@anjorsh anjorsh commented Jan 28, 2021

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. Feb 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. Jan 2021
  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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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, @anjorsh 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 28, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 5 Warnings warning [Detail]

    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: moveReadyRPOnly
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L2111
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isReadyForMove
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L4191
    ⚠️ R4021 - DescriptionAndTitleMissing 'RecoveryPointMoveReadinessInfo' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L4188
    ⚠️ R4021 - DescriptionAndTitleMissing 'isReadyForMove' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L4191
    ⚠️ R4021 - DescriptionAndTitleMissing 'additionalInfo' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L4194
    ️⚠️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-2020-12
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 28, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c704031. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️recoveryservices/mgmt/2020-12-01/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️recoveryservices/mgmt/2020-02-02/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2019-06-15/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2019-05-13/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2017-07-01/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️recoveryservices/mgmt/2016-12-01/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️recoveryservices/mgmt/2016-06-01/backup [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c704031. 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] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
      cmderr	[automation_init.sh]   Failed building wheel for yarl
      cmderr	[automation_init.sh]   Failed building wheel for wrapt
      cmderr	[automation_init.sh]   Failed building wheel for multidict
      cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
      cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
      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]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model BMSRPQueryObject has a new parameter move_ready_rp_only
      info	[Changelog]   - Model AzureWorkloadRecoveryPoint has a new parameter recovery_point_move_readiness_info
      info	[Changelog]   - Model AzureWorkloadRecoveryPoint has a new parameter recovery_point_tier_details
      info	[Changelog]   - Model AzureWorkloadSQLPointInTimeRecoveryPoint has a new parameter recovery_point_move_readiness_info
      info	[Changelog]   - Model AzureWorkloadSQLPointInTimeRecoveryPoint has a new parameter recovery_point_tier_details
      info	[Changelog]   - Model AzureWorkloadPointInTimeRecoveryPoint has a new parameter recovery_point_move_readiness_info
      info	[Changelog]   - Model AzureWorkloadPointInTimeRecoveryPoint has a new parameter recovery_point_tier_details
      info	[Changelog]   - Model RecoveryPointTierInformation has a new parameter extended_info
      info	[Changelog]   - Model AzureWorkloadSAPHanaRecoveryPoint has a new parameter recovery_point_move_readiness_info
      info	[Changelog]   - Model AzureWorkloadSAPHanaRecoveryPoint has a new parameter recovery_point_tier_details
      info	[Changelog]   - Model AzureWorkloadSQLRecoveryPoint has a new parameter recovery_point_move_readiness_info
      info	[Changelog]   - Model AzureWorkloadSQLRecoveryPoint has a new parameter recovery_point_tier_details
      info	[Changelog]   - Model AzureWorkloadSAPHanaPointInTimeRecoveryPoint has a new parameter recovery_point_move_readiness_info
      info	[Changelog]   - Model AzureWorkloadSAPHanaPointInTimeRecoveryPoint has a new parameter recovery_point_tier_details
      info	[Changelog]   - Model IaasVMRecoveryPoint has a new parameter recovery_point_move_readiness_info
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c704031. 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-01-29 07:20:15 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-recoveryservicesbackup"
      cmderr	[generate.py] 2021-01-29 07:20:15 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-01-29 07:20:15 INFO autorest --version=3.0.6350 --use=@autorest/[email protected] --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-01-29 07:21:31 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-01-29 07:21:31 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-01-29 07:21:31 INFO [POM][Skip] pom already has module azure-resourcemanager-recoveryservicesbackup
      cmderr	[generate.py] 2021-01-29 07:21:31 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-01-29 07:21:31 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-01-29 07:21:31 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] 2021-01-29 07:23:48 ERROR [COMPILE] Maven build fail
    • ️✔️azure-resourcemanager-recoveryservicesbackup [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-01-29 07:24:56 DEBUG Got artifact_id: azure-resourcemanager-recoveryservicesbackup
      cmderr	[Inst] 2021-01-29 07:24:56 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-01-29 07:24:56 DEBUG Got artifact: azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-29 07:24:56 DEBUG Match jar package: azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-29 07:24:56 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12683/azure-sdk-for-java/azure-resourcemanager-recoveryservicesbackup/azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.1.jar\" -o azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.1.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.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c704031. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --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.1s
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c704031. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/[email protected] --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/readme.md
    • ️✔️recoveryservicesbackup [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] WARN [email protected] No repository field.
      cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
      cmderr	[resource-manager]  ELIFECYCLE
      cmderr	[resource-manager] npm ERR! errno 17
      cmderr	[resource-manager]  [email protected] test: `mocha -r ts-node/register tests.ts`
      cmderr	[resource-manager] npm ERR! Exit status 17
      cmderr	[resource-manager] npm ERR!
      cmderr	[resource-manager] npm ERR! Failed at the [email protected] test script.
      cmderr	[resource-manager] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
      cmderr	[resource-manager]  A complete log of this run can be found in:
      cmderr	[resource-manager] npm ERR!     /home/vsts/.npm/_logs/2021-01-29T07_22_53_344Z-debug.log
      cmderr	[resource-manager] Error: Command failed: npm run test --prefix tools
      cmderr	[resource-manager]     at checkExecSyncError (child_process.js:635:11)
      cmderr	[resource-manager]     at Object.execSync (child_process.js:671:15)
      cmderr	[resource-manager]     at Object.<anonymous> (/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas/sdkauto_afterscript.js:13:28)
      cmderr	[resource-manager]     at Module._compile (internal/modules/cjs/loader.js:999:30)
      cmderr	[resource-manager]     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
      cmderr	[resource-manager]     at Module.load (internal/modules/cjs/loader.js:863:32)
      cmderr	[resource-manager]     at Function.Module._load (internal/modules/cjs/loader.js:708:14)
      cmderr	[resource-manager]     at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:60:12)
      cmderr	[resource-manager]     at internal/main/run_main_module.js:17:47 {
      cmderr	[resource-manager]   status: 17,
      cmderr	[resource-manager]   signal: null,
      cmderr	[resource-manager]   output: [ null, null, null ],
      cmderr	[resource-manager]   pid: 3271,
      cmderr	[resource-manager]   stdout: null,
      cmderr	[resource-manager]   stderr: null
      cmderr	[resource-manager] }
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @anjorsh, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    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.

    LGTM.

    If anything is readonly, mark so.

    For change on enum, consider using modelAsString=true in future api-version, as adding new enum in service to modelAsString=false enum would result in runtime failure to old SDK.

    @@ -6663,7 +6663,8 @@
    "enum": [
    "Invalid",
    "InstantRP",
    "HardenedRP"
    "HardenedRP",
    "ArchivedRP"

    Choose a reason for hiding this comment

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

    Add enum value to modelAsString=false.

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

    Successfully merging this pull request may close these issues.

    2 participants