Add AzureStorageProtocol field to AzureStorageInfoValue in latest API version#28289
Merged
naveedaz merged 1 commit intorelease-web-2023-12-01from Mar 30, 2024
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 Validation Report
|
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| CommonDefinitions.json | 2023-12-01(6cd97c9) | 2023-01-01(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2023-12 | package-2023-12(6cd97c9) | package-2023-12(release-web-2023-12-01) |
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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Mar 15, 2024
naveedaz
approved these changes
Mar 30, 2024
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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
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!
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 ApiViewcomment 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 PRandDue diligence checklist.Next Steps to Mergecomment. 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.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.