Rename FunctionsDeployment.storageType to FunctionsDeployment.functionsDeploymentStorageType #29214

v-hongli1 · 2024-05-23T02:07:01Z

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 review workflow diagram

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

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 created in adherence to OpenAPI specs PR creation guidance).
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.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
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 ARM review (PR workflow diagram Step 2), 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.

openapi-pipeline-app · 2024-05-23T02:07:04Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
To unblock this PR, follow the process at aka.ms/brch.
❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

openapi-pipeline-app · 2024-05-23T02:07:05Z

Swagger Validation Report

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

Compared specs (v0.10.8)	new version	base version
CommonDefinitions.json	2023-12-01(88d0944)	2023-12-01(main)

Rule	Message
`❌` 1047 - XmsEnumChanged	The new version has a different x-ms-enum 'name' than the previous one. New: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3620:13 Old: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3620:13

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2023-12	package-2023-12(88d0944)	package-2023-12(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'Recommendations_ListRecommendedRulesForHostingEnvironment' does not match the response definition in the individual GET operation 'Recommendations_GetRuleDetailsByHostingEnvironment' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'Recommendations_ListRecommendedRulesForWebApp' does not match the response definition in the individual GET operation 'Recommendations_GetRuleDetailsByWebApp' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListRelayServiceConnections' does not match the response definition in the individual GET operation 'WebApps_GetRelayServiceConnection' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListRelayServiceConnectionsSlot' does not match the response definition in the individual GET operation 'WebApps_GetRelayServiceConnectionSlot' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListPremierAddOns' does not match the response definition in the individual GET operation 'WebApps_GetPremierAddOn' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GetCollectionResponseSchema	The response in the GET collection operation 'WebApps_ListPremierAddOnsSlot' does not match the response definition in the individual GET operation 'WebApps_GetPremierAddOnSlot' . Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L17
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L684
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L713
`❌` ProvisioningStateValidation	ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L981
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1024
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1800
`❌` NestedResourcesMustHaveListOperation	The nested resource 'HybridConnection' does not have list operation, please add it. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1819
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L1978
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2252
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2733
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2733
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2754
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2758
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2939
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2939
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L2939
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3050
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3097
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3443
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3465
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L3599
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L4141
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L4185
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L4185
`❌` NestedResourcesMustHaveListOperation	The nested resource 'VnetGateway' does not have list operation, please add it. Location: Microsoft.Web/stable/2023-12-01/CommonDefinitions.json#L4308

️️✔️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?}

openapi-pipeline-app · 2024-05-23T02:07:05Z