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

Remove long running tag from get operations #12547

Merged
merged 2 commits into from
Jan 26, 2021
Merged

Remove long running tag from get operations #12547

merged 2 commits into from
Jan 26, 2021

Conversation

arpja
Copy link
Contributor

@arpja arpja commented Jan 21, 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.
  3. When you expect to publish swagger? 01/25
  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, @arpja 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 21, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

    Rule Message
    ❌ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupAadProperties/default' removed or restructured?
    Old: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L21:5
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L21:5
    ️⚠️LintDiff: 4 Warnings warning [Detail]

    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'CrrOperationResults_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L239
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'BMSPrepareDataMove' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    New: Microsoft.RecoveryServices/stable/2020-12-01/bms.json#L541
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'BMSPrepareDataMoveOperationResult_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    New: Microsoft.RecoveryServices/stable/2020-12-01/bms.json#L595
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AadPropertiesModel'. Consider using the plural form of 'AadProperties' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.RecoveryServices/stable/2018-12-20/bms.json#L27
    ️⚠️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 21, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6ba452b. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.RecoveryServices.Backup [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6ba452b. 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 wrapt
cmderr	[automation_init.sh]   Failed building wheel for yarl
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]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6ba452b. 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-26 05:27:00 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-recoveryservicesbackup"
cmderr	[generate.py] 2021-01-26 05:27:00 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-01-26 05:27:00 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --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-26 05:28:14 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-01-26 05:28:14 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-01-26 05:28:14 INFO [POM][Skip] pom already has module azure-resourcemanager-recoveryservicesbackup
cmderr	[generate.py] 2021-01-26 05:28:14 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-01-26 05:28:14 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-01-26 05:28:14 INFO [POM][Success] Write to root pom
cmderr	[generate.py] 2021-01-26 05:30:23 ERROR [COMPILE] Maven build fail
    • ️✔️azure-resourcemanager-recoveryservicesbackup [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-01-26 05:31:24 DEBUG Got artifact_id: azure-resourcemanager-recoveryservicesbackup
cmderr	[Inst] 2021-01-26 05:31:24 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-01-26 05:31:24 DEBUG Got artifact: azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-26 05:31:24 DEBUG Match jar package: azure-resourcemanager-recoveryservicesbackup-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-26 05:31:24 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12547/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-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6ba452b. 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-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6ba452b. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --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 6ba452b. Schema Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6351 --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 template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
cmderr	[resource-manager]  ELIFECYCLE
cmderr	[resource-manager] npm ERR! errno 17
cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 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 template-schema-validation-tools@1.0.0 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-26T05_27_37_472Z-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: 2987,
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

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

    This was referenced Jan 21, 2021
    Closed
    Closed
    Closed
    Closed
    @arpja
    Copy link
    Contributor Author

    arpja commented Jan 21, 2021 •
    edited
    Loading

    Hi @PhoenixHe-msft
    This PR is to fix a bug in the rest API specs.
    For 2 GET operations we had by mistake put the 'x-ms-long-running-operation' tag which failed the C# SDK generation for these versions.
    Also the URL in the AadPropertiesGet API has an extra 'default' at the end which was a bug, this will not cause a breaking change issue because the python and C# SDK have been already published with this 'default' removed.

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 21, 2021
    Closed
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 25, 2021
    @arpja
    Copy link
    Contributor Author

    arpja commented Jan 25, 2021

    Thank you @JeffreyRichter for your review and approval.
    Hi @PhoenixHe-msft,
    Now that we have the breaking change approval, could you please review, approve and merge PR if all looks good?

    @PhoenixHe-NV PhoenixHe-NV merged commit 6ba452b into Azure:master Jan 26, 2021
    This was referenced Jan 26, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    This was referenced Jan 26, 2021
    Closed
    Closed
    Closed
    @anjorsh anjorsh mentioned this pull request Jan 27, 2021
    Merged
    25 tasks
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @arpja @mkarmark
    Remove long running tag from get operations (Azure#12547)
    39e1b85 
    * removed long running tag from get operations

* removed long running tag from get operation
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @JeffreyRichter JeffreyRichter JeffreyRichter approved these changes

    @PhoenixHe-NV PhoenixHe-NV Awaiting requested review from PhoenixHe-NV

    Assignees

    @leniatgh leniatgh

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @arpja @JeffreyRichter @PhoenixHe-NV @leniatgh