-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Make PUT/PATCH api async for function on aca #27612
Make PUT/PATCH api async for function on aca #27612
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Generation Artifacts
|
Generated ApiView
|
b45fbbc
to
bd4efdd
Compare
bd4efdd
to
00137e9
Compare
specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json
Outdated
Show resolved
Hide resolved
Please address or respond to feedback from the ARM API reviewer. |
The delete API can still return 200 for sync operations. |
Your APIs should not be sometimes sync and sometimes async on the same method. If DELETE is async, it should always be async. That's why 200 is no longer used for DELETE response. |
Is the rule different for delete API, there are other PUT APIs with both 200, 202. Line 198 in a30f310
Also, this delete API internally calls Microsoft.App RP delete API which has both 202, 200. https://learn.microsoft.com/en-us/rest/api/containerapps/container-apps/delete?view=rest-containerapps-2023-05-01&tabs=HTTP |
please get BreakingChange approval before reviewing sdk breaking changes |
#27251 |
cd214ae
into
Azure:release-web-2023-12-01
"202": { | ||
"description": "Asynchronous operation in progress.", | ||
"headers": { | ||
"location": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ARM's guidance is here:
https://armwiki.azurewebsites.net/rpaas/async.html#creating-or-updating-resources-put
Put/Patch/Post
Seems like the header to use is Azure-AsyncOperation
. Should we use that?
I noticed that the examples all use Azure-AsyncOperation for some reason
* Introduce Microsoft.Web API version 2023-12-01 (#27100) * Add VnetBackupRestoreEnabled property to the latest API Version (#27175) * changed ApproveRejectSitePrivateEndpointConnection request body to match service parameter (#27317) Co-authored-by: Xingyang Li <xingyangli@microsoft.com> * e2e encryption (#27226) Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com> * Adding Vnet-related APIs to Swagger (#27251) * Add function app config to latest Web API (#27358) * Add functionAppConfig definition * Add create or update function app Flex Consumption example * Add create or update function app Flex Consumption with details example * Update CommonDefinitions.json to reference the new examples * Make PUT/PATCH api async for function on aca (#27612) * Make PUT/PATCH api async for function on aca * Remove response body * update examples * Add headers --------- Co-authored-by: Vishal Gupta <vishgupta@microsoft.com> * Add FlexConsumption to the list of supported skus (#27951) * Add TLS1.3 to valid TLS Versions (#27885) Authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>. I'm completing this since it was asked for and Chris is OOF atm * Added Linux SiteContainer APIs (#27942) * Added Linux SiteContainer APIs * Resolved validation failures. * Added SiteContainer and SiteContainerCollection * Fixed LintDiff errors * Fixed spellings * Updated params order. * Resolving comments. * Resolving comments. * Added volumeMounts and envVariables. * Resolving comments * Resolving comments * Removed type and metadata. * Haochidu/release web 2023 12 01/aseregion hotfix (#28018) * Update ResourceProvider.json hot fix API will return with the correct body but also with a nextLink with a URL instead of just null. I did a little more research and it seems like since my API does not return next links I think the fix should just be set the nextlinkname to null in the swagger specification. * Update ResourceProvider.json * Revert "Adding Vnet-related APIs to Swagger (#27251)" (#28249) This reverts commit 0765e9d. * Add DnsConfiguration site property to Microsoft.Web API Specs (#27378) * Add DnsConfiguration property to WebApps.json * Add SiteDnsConfig to CommonDefinitions.json * Updated dnslegacy property description * Update CommonDefinitions.json * Undo previous update to CommonDefinitions.json * Update CommonDefinitions.json: added readonly: true for dnsLegacySortOrder * Add AzureStorageProtocol field to AzureStorageInfoValue definition. (#28289) Co-authored-by: Amber Renton <amberrenton@microsoft.com> * Update create function app examples for Flex Consumption (#28566) * Revert "Make PUT/PATCH api async for function on aca (#27612)" (#28568) This reverts commit cd214ae. * Revert "Haochidu/release web 2023 12 01/aseregion hotfix (#28018)" (#28738) This reverts commit ec1d84f. * create sdk-suppression.yaml (#28751) * create sdk-suppression.yaml * add azure-sdk-for-go suppression --------- Co-authored-by: Alancere <804873052@qq.com> --------- Co-authored-by: Ashok Kumar Karasala <106590066+vkarasala@users.noreply.github.com> Co-authored-by: xingyangli1278 <xingyangli1278@gmail.com> Co-authored-by: Xingyang Li <xingyangli@microsoft.com> Co-authored-by: Chris Rosenblatt <rosench13@gmail.com> Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com> Co-authored-by: hdmimsft <137456285+hdmimsft@users.noreply.github.com> Co-authored-by: Francisco Gamino <Francisco-Gamino@users.noreply.github.com> Co-authored-by: Vishal Gupta <vishalgupta7991@gmail.com> Co-authored-by: Vishal Gupta <vishgupta@microsoft.com> Co-authored-by: DJagwani <122347490+DJagwani@users.noreply.github.com> Co-authored-by: Haochi <136372741+ha0ch1@users.noreply.github.com> Co-authored-by: tbhartia <149726222+tbhartia@users.noreply.github.com> Co-authored-by: Amber Renton <136374263+amberrenton@users.noreply.github.com> Co-authored-by: Amber Renton <amberrenton@microsoft.com> Co-authored-by: jocawtho <jocawtho@microsoft.com> Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Alancere <804873052@qq.com>
* Introduce Microsoft.Web API version 2023-12-01 (#27100) * Add VnetBackupRestoreEnabled property to the latest API Version (#27175) * changed ApproveRejectSitePrivateEndpointConnection request body to match service parameter (#27317) Co-authored-by: Xingyang Li <xingyangli@microsoft.com> * e2e encryption (#27226) Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com> * Adding Vnet-related APIs to Swagger (#27251) * Add function app config to latest Web API (#27358) * Add functionAppConfig definition * Add create or update function app Flex Consumption example * Add create or update function app Flex Consumption with details example * Update CommonDefinitions.json to reference the new examples * Make PUT/PATCH api async for function on aca (#27612) * Make PUT/PATCH api async for function on aca * Remove response body * update examples * Add headers --------- Co-authored-by: Vishal Gupta <vishgupta@microsoft.com> * Add FlexConsumption to the list of supported skus (#27951) * Add TLS1.3 to valid TLS Versions (#27885) Authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>. I'm completing this since it was asked for and Chris is OOF atm * Added Linux SiteContainer APIs (#27942) * Added Linux SiteContainer APIs * Resolved validation failures. * Added SiteContainer and SiteContainerCollection * Fixed LintDiff errors * Fixed spellings * Updated params order. * Resolving comments. * Resolving comments. * Added volumeMounts and envVariables. * Resolving comments * Resolving comments * Removed type and metadata. * Haochidu/release web 2023 12 01/aseregion hotfix (#28018) * Update ResourceProvider.json hot fix API will return with the correct body but also with a nextLink with a URL instead of just null. I did a little more research and it seems like since my API does not return next links I think the fix should just be set the nextlinkname to null in the swagger specification. * Update ResourceProvider.json * Revert "Adding Vnet-related APIs to Swagger (#27251)" (#28249) This reverts commit 0765e9d. * Add DnsConfiguration site property to Microsoft.Web API Specs (#27378) * Add DnsConfiguration property to WebApps.json * Add SiteDnsConfig to CommonDefinitions.json * Updated dnslegacy property description * Update CommonDefinitions.json * Undo previous update to CommonDefinitions.json * Update CommonDefinitions.json: added readonly: true for dnsLegacySortOrder * Add AzureStorageProtocol field to AzureStorageInfoValue definition. (#28289) Co-authored-by: Amber Renton <amberrenton@microsoft.com> * Update create function app examples for Flex Consumption (#28566) * Revert "Make PUT/PATCH api async for function on aca (#27612)" (#28568) This reverts commit cd214ae. * Revert "Haochidu/release web 2023 12 01/aseregion hotfix (#28018)" (#28738) This reverts commit ec1d84f. * create sdk-suppression.yaml (#28751) * create sdk-suppression.yaml * add azure-sdk-for-go suppression --------- Co-authored-by: Alancere <804873052@qq.com> --------- Co-authored-by: Ashok Kumar Karasala <106590066+vkarasala@users.noreply.github.com> Co-authored-by: xingyangli1278 <xingyangli1278@gmail.com> Co-authored-by: Xingyang Li <xingyangli@microsoft.com> Co-authored-by: Chris Rosenblatt <rosench13@gmail.com> Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com> Co-authored-by: hdmimsft <137456285+hdmimsft@users.noreply.github.com> Co-authored-by: Francisco Gamino <Francisco-Gamino@users.noreply.github.com> Co-authored-by: Vishal Gupta <vishalgupta7991@gmail.com> Co-authored-by: Vishal Gupta <vishgupta@microsoft.com> Co-authored-by: DJagwani <122347490+DJagwani@users.noreply.github.com> Co-authored-by: Haochi <136372741+ha0ch1@users.noreply.github.com> Co-authored-by: tbhartia <149726222+tbhartia@users.noreply.github.com> Co-authored-by: Amber Renton <136374263+amberrenton@users.noreply.github.com> Co-authored-by: Amber Renton <amberrenton@microsoft.com> Co-authored-by: jocawtho <jocawtho@microsoft.com> Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: Alancere <804873052@qq.com>
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PR
andDue diligence checklist
.Next Steps to Merge
comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.