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.

Sign up for GitHub

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

Jump to bottom

Recovery services backup october release #16710

Closed
wants to merge 12 commits into from
Closed

Recovery services backup october release #16710

wants to merge 12 commits into from

Conversation

pratimaupadhyay02
Copy link
Contributor

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

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. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.

  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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.

abhishek-goyal1 and others added 4 commits October 13, 2021 10:22
@abhishek-goyal1
RecoveryServicesBackup: Added ValidateOperationAsync APIs to new API …
bd593ed 
…version 2021-10-01 (#16291)

* Added base for new API version 2021-10-01 from previous 2021-08-01

* Updates Readme

* Updates API version in new specs and examples

* Updated CRR related API in readme

* Added PreCheckAsync new APIs

* Removed incorrect long-running-operation tag

* Renamed API as per PR review
@abhishek-goyal1
RecoveryServicesBackup: Minor update to new ValidateOperation async A…
0d31f20 
…PI (#16402)

* Added long running operation tag to async API

* Updated examples with renamed tracking API
@abhinitkumar01
Recovery services backup october release (#16303)
2e67345 
* Adds base for updating Microsoft.RecoveryServices from version stable/2021-08-01 to 2021-10-01

* Update Swagger spec and examples

* Update readme

* Resolve Avocado and PrettierCheck issues

* Resolve Model Validation issues
@pratimaupadhyay02
Adding package for active and passive stamp
49f8b7f
@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 Nov 9, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌LintDiff: 2 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ❌ AutoRest exception "readme":"recoveryservicesbackup/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"swagger-document/individual/schema-validator - FAILED"
    ❌ AutoRest exception "readme":"recoveryservicesbackup/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"Error: [OperationAbortedException] Error occurred. Exiting."
    ️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
    readme: specification/recoveryservicesbackup/resource-manager/readme.md
    json: Microsoft.RecoveryServices/stable/2016-06-01/registeredIdentities.json
    ️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.RecoveryServices' for api version '2021-10-01'. The supported api-versions are '2021-08-01,
    2021-07-01,
    2021-06-01,
    2021-04-01,
    2021-03-01,
    2021-02-10,
    2021-02-01-preview,
    2021-02-01,
    2021-01-01,
    2020-12-01,
    2020-10-01,
    2020-07-01,
    2020-07-01-preview,
    2020-02-02,
    2020-02-02-preview,
    2019-06-15,
    2019-05-13-preview,
    2019-05-13,
    2018-07-10-preview,
    2018-07-10,
    2018-01-10,
    2017-09-01,
    2017-07-01-preview,
    2017-07-01,
    2016-12-01,
    2016-08-10,
    2016-06-01,
    2015-12-15,
    2015-12-10,
    2015-11-10,
    2015-08-15,
    2015-08-10,
    2015-06-10,
    2015-03-15'."
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️❌SemanticValidation: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: default
    JsonUrl: Microsoft.RecoveryServices/stable/2021-10-01/bms.json#L246
    ❌ OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: $ref
    JsonUrl: Microsoft.RecoveryServices/stable/2021-10-01/bms.json#L246
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: default
    JsonUrl: Microsoft.RecoveryServices/stable/2021-10-01/bms.json#L195
    ❌ OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: $ref
    JsonUrl: Microsoft.RecoveryServices/stable/2021-10-01/bms.json#L195
    ️❌Cross-Version Breaking Changes: 2 Errors, 0 Warnings failed [Detail] The following breaking changes are detected by comparison with the latest stable version:
    Rule Message
    ❌ Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/3d4988817f98c87837b51e8da5c8468840c3ba2e/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-08-01/bms.json",
    "details":"Command failed: node /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@Azure+oad@0.9.1/node_modules/autorest/dist/app.js --input-file=specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///home/vsts/work/1/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json:246:10 ($.paths["/subscriptions/subscriptionId/providers/Microsoft.RecoveryServices/locations/azureRegion/backupStatus"].post.responses["200"])\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///home/vsts/work/1/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json:195:10 ($.paths["/subscriptio"


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

    Rule Message
    ❌ Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/3d4988817f98c87837b51e8da5c8468840c3ba2e/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2021-02-01-preview/bms.json",
    "details":"Command failed: node /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@Azure+oad@0.9.1/node_modules/autorest/dist/app.js --input-file=specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///home/vsts/work/1/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json:246:10 ($.paths["/subscriptions/subscriptionId/providers/Microsoft.RecoveryServices/locations/azureRegion/backupStatus"].post.responses["200"])\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///home/vsts/work/1/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json:195:10 ($.paths["/subscriptio"
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ HowToFix Code style issues found
    path: 2021-10-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️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 Nov 9, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌SDK Breaking Change Tracking failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-python failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-python-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-java failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-js failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-resource-manager-schemas failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @pratimaupadhyay02, 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."

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Nov 9, 2021
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Nov 9, 2021
    Draft
    This was referenced Nov 9, 2021
    Draft
    Draft
    Draft
    Draft
    @pratimaupadhyay02
    Copy link
    Contributor Author

    Hi @jianyexi . In this PR we are seeing a lot of lintdiff failures with the below issue. Is it mandatory to add the field?
    ❌ R4009 - RequiredReadOnlySystemData | The response of operation:'ProtectionIntent_Get' is defined without 'systemData'. Consider adding the systemData to the response.Location: Microsoft.RecoveryServices/stable/2021-10-01/bms.json#L300

    @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.

    @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.

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Nov 17, 2021
    Draft
    This was referenced Nov 22, 2021
    Draft
    Draft
    @pratimaupadhyay02
    Revert "Fixing failures"
    d8d5c6f 
    This reverts commit 606e029.
    This was referenced Nov 22, 2021
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    @pratimaupadhyay02
    Copy link
    Contributor Author

    Hi @chunyu3 , I resolved the CI failures of my RP but I see that the failures other RPs like Microsoft.DocumentDB and Microsoft.Lab services also present in the checks even after reverting the commit that added prettier fixes for the other RPs. Can you please let me know how we can stop the issues of other RPs getting highlighted in this PR?

    @pratimaupadhyay02
    Copy link
    Contributor Author

    Closing this PR as changes were merged in another PR #16865

    @pratimaupadhyay02 pratimaupadhyay02 deleted the recoveryServices-backup-October-release branch November 30, 2021 09:42
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ahamad-MS ahamad-MS Awaiting requested review from ahamad-MS

    @dkulkarni-ms dkulkarni-ms Awaiting requested review from dkulkarni-ms

    @giakas giakas Awaiting requested review from giakas

    @grizzlytheodore grizzlytheodore Awaiting requested review from grizzlytheodore

    @haagha haagha Awaiting requested review from haagha

    @hyonholee hyonholee Awaiting requested review from hyonholee

    @Kishp01 Kishp01 Awaiting requested review from Kishp01

    @madewithsmiles madewithsmiles Awaiting requested review from madewithsmiles

    @MS-syh2qs MS-syh2qs Awaiting requested review from MS-syh2qs

    @Sandido Sandido Awaiting requested review from Sandido

    Assignees

    @chunyu3 chunyu3

    Labels
    CI-BreakingChange-Go CI-BreakingChange-Go-V2 CI-FixRequiredOnFailure
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @pratimaupadhyay02 @chunyu3 @abhishek-goyal1 @abhinitkumar01