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

Release web 2023 12 01 #28268

Merged
merged 18 commits into from
Apr 20, 2024
Merged

Release web 2023 12 01 #28268

merged 18 commits into from
Apr 20, 2024

Conversation

naveedaz
Copy link
Contributor

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.

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

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!

  • New resource provider.
  • New API version for an existing resource provider. (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 OpenAPI spec 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
suppressions guide 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.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • 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.

naveedaz and others added 13 commits December 21, 2023 17:53
…tch service parameter (#27317)

Co-authored-by: Xingyang Li <xingyangli@microsoft.com>
Co-authored-by: Chris Rosenblatt <crosenblatt@microsoft.com>
* 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

* Remove response body

* update examples

* Add headers

---------

Co-authored-by: Vishal Gupta <vishgupta@microsoft.com>
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

* 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.
* 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
* 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
Copy link

openapi-pipeline-app bot commented Mar 14, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Mar 14, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
Compared specs (v0.10.7) new version base version
CommonDefinitions.json 2023-01-01(dcc0882) 2023-01-01(main)
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
Compared specs (v0.10.7) new version base version
AppServiceCertificateOrders.json 2023-12-01(dcc0882) 2023-01-01(main)
CertificateOrdersDiagnostics.json 2023-12-01(dcc0882) 2023-01-01(main)
CertificateRegistrationProvider.json 2023-12-01(dcc0882) 2023-01-01(main)
DomainRegistrationProvider.json 2023-12-01(dcc0882) 2023-01-01(main)
Domains.json 2023-12-01(dcc0882) 2023-01-01(main)
TopLevelDomains.json 2023-12-01(dcc0882) 2023-01-01(main)
AppServiceEnvironments.json 2023-12-01(dcc0882) 2023-01-01(main)
AppServicePlans.json 2023-12-01(dcc0882) 2023-01-01(main)
Certificates.json 2023-12-01(dcc0882) 2023-01-01(main)
CommonDefinitions.json 2023-12-01(dcc0882) 2023-01-01(main)
ContainerApps.json 2023-12-01(dcc0882) 2023-01-01(main)
ContainerAppsRevisions.json 2023-12-01(dcc0882) 2023-01-01(main)
DeletedWebApps.json 2023-12-01(dcc0882) 2023-01-01(main)
Diagnostics.json 2023-12-01(dcc0882) 2023-01-01(main)
Global.json 2023-12-01(dcc0882) 2023-01-01(main)
KubeEnvironments.json 2023-12-01(dcc0882) 2023-01-01(main)
Provider.json 2023-12-01(dcc0882) 2023-01-01(main)
Recommendations.json 2023-12-01(dcc0882) 2023-01-01(main)
ResourceHealthMetadata.json 2023-12-01(dcc0882) 2023-01-01(main)
ResourceProvider.json 2023-12-01(dcc0882) 2023-01-01(main)
StaticSites.json 2023-12-01(dcc0882) 2023-01-01(main)
WebApps.json 2023-12-01(dcc0882) 2023-01-01(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️️✔️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.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️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 Mar 14, 2024

Swagger Generation Artifacts

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

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 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 failed [Detail]

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

️⚠️ 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 Mar 14, 2024

Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@vivekjilla
Copy link

          "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource"

Is this a breaking change?

Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/StaticSites.json:3067 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

@xingyangli1278 Can you please help with this comment

@vivekjilla
Copy link

    "dnsRetryAttemptTimeout": {

It's better to include the time unit in the property name. E.g. ...TimeoutSeconds.

Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json:3840 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

@tbhartia can you please help with this and other comments related to dnsconfig

@vivekjilla
Copy link

    "responses": {

Are PUT response sync or async? If async, make sure you set x-ms-long-running-operation and return the Azure-AsyncOperation header. https://azure.github.io/autorest/extensions/#x-ms-long-running-operation

Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json:8734 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

@DJagwani Can you please help address the sync vs async comments around sitecontainer APIs

@DJagwani
Copy link
Contributor

    "responses": {

Are PUT response sync or async? If async, make sure you set x-ms-long-running-operation and return the Azure-AsyncOperation header. https://azure.github.io/autorest/extensions/#x-ms-long-running-operation
Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/WebApps.json:8734 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

@DJagwani Can you please help address the sync vs async comments around sitecontainer APIs

These are sync APIs only.

@xingyangli1278
Copy link
Contributor

          "$ref": "./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource"

Is this a breaking change?
Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/StaticSites.json:3067 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

@xingyangli1278 Can you please help with this comment

@vivekjilla
This was a "breaking change" but this was a bugfix to change the response body to the correct format. This change has already been approved and merged for all previous api versions for Microsoft.Web.

@tbhartia
Copy link
Contributor

    "dnsRetryAttemptTimeout": {

It's better to include the time unit in the property name. E.g. ...TimeoutSeconds.

Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json:3840 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

These properties have already been rolled-out and we are adding them to the swagger now. Unfortunately, we can't change the name of the properties now as it will be a breaking change but we really appreciate the suggestion and will keep that in mind in future.

@tbhartia
Copy link
Contributor

    "dnsLegacySortOrder": {

ARM recommends enums over booleans for future proof APIs.

Standard guidance is: replace boolean/switch properties with a more meaningful enum whenever possible.

A boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

Refers to: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/CommonDefinitions.json:3855 in 0db58f3. [](commit_id = 0db58f3, deletion_comment = False)

There is no possibility for this property to have more than 2 values in future as well, so we decided to use boolean here.

@raosuhas raosuhas removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 18, 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 Apr 18, 2024
@raosuhas
Copy link

All commits have already been reviewed here :

https://github.com/Azure/azure-rest-api-specs/pull/28268/commits

@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 18, 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 Apr 18, 2024
@kazrael2119
Copy link
Contributor

need merge this pr before reivew sdk breaking changes #28751

* create sdk-suppression.yaml

* add azure-sdk-for-go suppression

---------

Co-authored-by: Alancere <804873052@qq.com>
@jocawtho
Copy link
Member

need merge this pr before reivew sdk breaking changes #28751

This is complete now.

@JackTn
Copy link
Member

JackTn commented Apr 19, 2024

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

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 rkmanda merged commit 72f52bc into main Apr 20, 2024
29 of 32 checks passed
@rkmanda rkmanda deleted the release-web-2023-12-01 branch April 20, 2024 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Go-Sdk-Suppression BreakingChange-Go-Sdk-Suppression-Approved BreakingChange-JavaScript-Sdk-Suppression BreakingChange-JavaScript-Sdk-Suppression-Approved new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.