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

Adding Azure-AsyncOperation header #12080

Merged
merged 3 commits into from
Dec 15, 2020
Merged

Adding Azure-AsyncOperation header #12080

merged 3 commits into from
Dec 15, 2020

Conversation

juhee0202
Copy link
Contributor

@juhee0202 juhee0202 commented Dec 11, 2020

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.
    The API is not public yet. There are no real customers calling the CalculateExchange & Exchange API's today.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    12/18/2020
  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-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 11, 2020

Swagger Validation Report

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

️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.

️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/reservations/resource-manager/readme.md
tag: specification/reservations/resource-manager/readme.md#tag-package-2020-11-preview
️️✔️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 Dec 11, 2020

Swagger Generation Artifacts

️⚠️ azure-sdk-for-net warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 216e7ae. 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/reservations/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.Reservations [View full logs]  [Release SDK Changes]
️❌ azure-sdk-for-js failed [Detail]
  • Failed [Logs]Release - Generate from 216e7ae. 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/reservations/resource-manager/readme.md
  • @azure/arm-reservations [View full logs]  [Release SDK Changes]
    error	Script return with result [failed] code [2] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/reservations/arm-reservations]: npm pack --silent
️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 216e7ae. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	python3 -m venv venv
    command	pip install --upgrade setuptools wheel pip
    command	pip install pathlib jinja2 msrestazure
    command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/reservations/resource-manager/readme.md
  • ️✔️azure-mgmt-reservations [View full logs]  [Release SDK Changes] Breaking Change Detected
    cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-reservations
    cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
    cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
    cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-reservations
    cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.reservations
    cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.reservations
    cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.reservations
    cmderr	[changelogReport] INFO:__main__:Report written to sdk/reservations/azure-mgmt-reservations/code_reports/latest/report.json
    cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-reservations on PyPI
    cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0', '0.2.1', '0.3.0', '0.3.1', '0.3.2', '0.4.0', '0.5.0', '0.6.0', '0.7.0', '0.8.0', '1.0.0b1']
    cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
    cmderr	[changelogReportLatest] INFO:__main__:Installing version 1.0.0b1 of azure-mgmt-reservations in a venv
    cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
    cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.reservations
    cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.reservations
    cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.reservations
    cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/reservations/azure-mgmt-reservations/code_reports/1.0.0b1/report.json
    cmdout	[Changelog] Size of delta 49.956% size of original (original: 21439 chars, delta: 10710 chars)
    cmdout	[Changelog] **Features**
    cmdout	[Changelog]   - Model ReservationResponse has a new parameter kind
    cmdout	[Changelog]   - Model Catalog has a new parameter size
    cmdout	[Changelog]   - Model Catalog has a new parameter tier
    cmdout	[Changelog]   - Model Catalog has a new parameter capabilities
    cmdout	[Changelog]   - Added operation QuotaOperations.create_or_update
    cmdout	[Changelog]   - Added operation QuotaOperations.update
    cmdout	[Changelog]   - Added operation ReservationOperations.split
    cmdout	[Changelog]   - Added operation ReservationOperations.update
    cmdout	[Changelog]   - Added operation ReservationOperations.merge
    cmdout	[Changelog] **Breaking changes**
    cmdout	[Changelog]   - Operation QuotaRequestStatusOperations.list has a new signature
    cmdout	[Changelog]   - Operation QuotaRequestStatusOperations.get has a new signature
    cmdout	[Changelog]   - Operation QuotaOperations.list has a new signature
    cmdout	[Changelog]   - Operation QuotaOperations.get has a new signature
    cmdout	[Changelog]   - Operation AzureReservationAPIOperationsMixin.get_applied_reservation_list has a new signature
    cmdout	[Changelog]   - Operation AzureReservationAPIOperationsMixin.get_catalog has a new signature
    cmdout	[Changelog]   - Operation OperationOperations.list has a new signature
    cmdout	[Changelog]   - Model ReservationOrderResponse no longer has parameter billing_plan
    cmdout	[Changelog]   - Model ReservationOrderResponse no longer has parameter plan_information
    cmdout	[Changelog]   - Model Patch no longer has parameter name
    cmdout	[Changelog]   - Model Patch no longer has parameter renew_properties
    cmdout	[Changelog]   - Model Patch no longer has parameter instance_flexibility
    cmdout	[Changelog]   - Model Patch no longer has parameter renew
    cmdout	[Changelog]   - Model Catalog no longer has parameter billing_plans
    cmdout	[Changelog]   - Model Catalog no longer has parameter sku_properties
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter billing_scope_id
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter instance_flexibility
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter reserved_resource_type
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter renew_properties
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter renew_source
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter sku_description
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter renew_destination
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter renew
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter term
    cmdout	[Changelog]   - Model ReservationProperties no longer has parameter billing_plan
    cmdout	[Changelog]   - Removed operation QuotaOperations.begin_update
    cmdout	[Changelog]   - Removed operation QuotaOperations.begin_create_or_update
    cmdout	[Changelog]   - Removed operation ReservationOrderOperations.calculate
    cmdout	[Changelog]   - Removed operation ReservationOrderOperations.change_directory
    cmdout	[Changelog]   - Removed operation ReservationOrderOperations.begin_purchase
    cmdout	[Changelog]   - Removed operation ReservationOperations.begin_update
    cmdout	[Changelog]   - Removed operation ReservationOperations.begin_available_scopes
    cmdout	[Changelog]   - Removed operation ReservationOperations.begin_merge
    cmdout	[Changelog]   - Removed operation ReservationOperations.begin_split
    cmdout	[Changelog]   - Removed operation group CalculateExchangeOperations
    cmdout	[Changelog]   - Removed operation group AutoQuotaIncreaseOperations
    cmdout	[Changelog]   - Removed operation group ExchangeOperations
    warn	Breaking change found in changelog
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 216e7ae. 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
  • ️✔️reservations/mgmt/2020-10-25/reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] This is a new package
  • ️✔️preview/reservations/mgmt/2019-07-19-preview/reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/reservations/mgmt/2019-04-01/reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/reservations/mgmt/2018-06-01/reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️reservations/mgmt/2017-11-01/reservations [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 216e7ae. 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.6320 --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/reservations/resource-manager/readme.md
  • ️✔️reservations [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] npm WARN template-schema-validation-tools@1.0.0 No repository field.
    cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.2 (node_modules/fsevents):
    cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
️️✔️[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, @juhee0202 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

    @juhee0202
    Copy link
    Contributor Author

    hi @fengzhou-msft - can this be merged?

    @fengzhou-msft fengzhou-msft merged commit 216e7ae into Azure:master Dec 15, 2020
    giromm2ms pushed a commit to giromm2ms/azure-rest-api-specs that referenced this pull request Dec 20, 2020
    josuhazure pushed a commit to josuhazure/azure-rest-api-specs that referenced this pull request Jan 6, 2021
    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.

    2 participants