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

Add function app config to latest Web API #27358

Conversation

Francisco-Gamino
Copy link
Contributor

@Francisco-Gamino Francisco-Gamino commented Jan 11, 2024

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.

PR Description

This PR contains the following changes:

  • Added functionAppConfig definition
  • Added CreateOrUpdateFunctionApp.json example

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

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:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    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)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    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
Swagger-Suppression-Process
to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the 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.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in 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.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

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

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
CommonDefinitions.json 2023-12-01(a1af2b4) 2023-01-01(main)
WebApps.json 2023-12-01(a1af2b4) 2023-01-01(main)
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

Swagger Generation Artifacts

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

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

️⚠️SDK Breaking Change Tracking warning [Detail]

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

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

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

️⚠️ azure-sdk-for-python-track2 warning [Detail]

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

️⚠️ azure-sdk-for-java warning [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 succeeded [Detail] [Expand]

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

️🔄 azure-resource-manager-schemas inProgress [Detail]
️⚠️ azure-powershell warning [Detail]

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

Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

@Francisco-Gamino Francisco-Gamino marked this pull request as ready for review January 11, 2024 20:11
@Francisco-Gamino Francisco-Gamino changed the title Add function app config Add function app config to latest Web API Jan 11, 2024
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 11, 2024
@Francisco-Gamino Francisco-Gamino removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required new-api-version labels Jan 11, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 11, 2024
@TimLovellSmith
Copy link
Member

@Francisco-Gamino This is an unreleased API, correct?

@TimLovellSmith
Copy link
Member

There are a bunch of breaking change and model validation issues.

Model Validation issues need to be fixed, no matter where they are from.

Are the breaking changes from your changes, or the other changes in your development branch?

"properties": {
"type": {
"description": "Property to select Azure Storage Type. Available option: blobContainer.",
"type": "string"
Copy link
Member

Choose a reason for hiding this comment

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

is the implication that this is an enum? What are all the valid values, if not?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently, we only plan to support blobContainer. However, we might support other types in the future. Based on this, should this still be an enum?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated deployment storage type to be an enum.

@raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 24, 2024
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 24, 2024
@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 25, 2024
@openapi-workflow-bot openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 25, 2024
@@ -0,0 +1,378 @@
{
"parameters": {
Copy link
Member

Choose a reason for hiding this comment

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

This file seems to include all that can be possibly set for a function app regardless of SKU. Is that how it's meant to be? It'd be great to have a separate file specific for Flex Consumption that shows only what's posssible and won't be blocked for a FC app. For example: this sample has both LinuxFxVersion and a bunch of app settings, has the "Reserved" setting and others, etc. Not sure who looks at this sample but just calling it out

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated the example to make it Flex Consumption specific.

@davidmrdavid @nzthiago -- Could you please take another look? Thank you.

"version": "3.11"
},
"scaleAndConcurrency": {
"alwaysReady": null,
Copy link
Member

Choose a reason for hiding this comment

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

This should not be here if it’s not required, could we delete this line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. Fixed.

"alwaysReady": null,
"maximumInstanceCount": 100,
"instanceMemoryMB": 2048,
"triggers": null
Copy link
Member

Choose a reason for hiding this comment

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

This should not be here if it’s not required, could we delete this line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Feb 2, 2024
@Francisco-Gamino Francisco-Gamino merged commit 56abc43 into Azure:release-web-2023-12-01 Feb 3, 2024
24 of 27 checks passed
catalinaperalta pushed a commit that referenced this pull request Apr 20, 2024
* 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>
rkmanda pushed a commit that referenced this pull request Apr 20, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants