-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[Hub Generated] Review request for Microsoft.Network to add version stable/2023-11-01 #25989
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
Draft
disreedh
wants to merge
11
commits into
main
Choose a base branch
from
disreedh-frontdoor-Microsoft.Network-2023-11-01
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
network.json | 2023-11-01(23c041c) | 2022-05-01(main) |
network.json | 2023-11-01(23c041c) | 2019-03-01-preview(main) |
webapplicationfirewall.json | 2023-11-01(23c041c) | 2022-05-01(main) |
webapplicationfirewall.json | 2023-11-01(23c041c) | 2019-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-11 | package-2023-11(23c041c) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L525 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
OperationsAPIImplementation |
Operations API must be implemented for 'Microsoft.Network'. Location: Microsoft.Network/stable/2023-11-01/network.json#L1 |
MissingTypeObject |
The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/network.json#L40 |
MissingTypeObject |
The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/network.json#L53 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-11-01/network.json#L64 |
MissingTypeObject |
The schema 'AzureAsyncOperationResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/network.json#L75 |
MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/network.json#L96 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Network/stable/2023-11-01/network.json#L117 |
MissingTypeObject |
The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/network.json#L128 |
MissingTypeObject |
The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/network.json#L138 |
PropertiesTypeObjectNoDefinition |
Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience. Location: Microsoft.Network/stable/2023-11-01/network.json#L140 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Network/stable/2023-11-01/network.json#L152 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Network/stable/2023-11-01/network.json#L159 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L62 |
ResourceNameRestriction |
The resource name parameter 'policyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L118 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L146 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L159 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L201 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L207 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L210 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L221 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L250 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L257 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L260 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L271 |
MissingDefaultResponse |
Operation is missing a default response. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L291 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L291 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L295 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets' Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L310 |
DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L332 |
MissingTypeObject |
The schema 'WebApplicationFirewallPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L351 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/frontdoor/resource-manager/readme.md tag: specification/frontdoor/resource-manager/readme.md#tag-package-2023-11 |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
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]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Sep 27, 2023
This was referenced Sep 27, 2023
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
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] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] 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!
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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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
and https://aka.ms/ci-fix.