Skip to content

[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
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

disreedh
Copy link
Contributor

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.

diagram

[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!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • 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:

Breaking changes review (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.

ARM API changes review (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.

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 27, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for go (label: CI-BreakingChange-Go). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ Your PR has breaking changes in the generated SDK for javascript (label: CI-BreakingChange-JavaScript). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 27, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 5 Warnings warning [Detail]
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:

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies' removed or restructured?
Old: Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json#L37:5
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L805:9
Old: Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json#L616:9
⚠️ 1036 - ConstraintChanged The new version has a different 'maximum' value than the previous one.
New: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L607:9
Old: Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json#L441:9
⚠️ 1036 - ConstraintChanged The new version has a different 'minimum' value than the previous one.
New: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L607:9
Old: Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json#L441:9
⚠️ 1036 - ConstraintChanged The new version has a different 'minimum' value than the previous one.
New: Microsoft.Network/stable/2023-11-01/webapplicationfirewall.json#L613:9
Old: Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json#L445:9
️️✔️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]
⚠️ AvoidNestedProperties 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
⚠️ MULTIPLE_API_VERSION 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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 27, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking


azure-sdk-for-js - @azure/arm-frontdoor - 6.0.0
+	Class FrontDoorManagementClient has a new signature

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from d8908192d2797418626e3890255ca421217d973b. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.FrontDoor [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️❌ azure-sdk-for-python-track2 failed [Detail]
  • Code Generator Failed [Logs] Generate from d8908192d2797418626e3890255ca421217d973b. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh]  New major version of npm available! 9.8.1 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
    cmderr	[automation_generate.sh]  13823904 bytes remaining to read
    cmderr	[automation_generate.sh] xz: (stdin): Unexpected end of input
    cmderr	[automation_generate.sh] tar: Unexpected EOF in archive
    cmderr	[automation_generate.sh] tar: Unexpected EOF in archive
    cmderr	[automation_generate.sh] tar: Error is not recoverable: exiting now
    cmderr	[automation_generate.sh]   Error: failed to download archive for 16.15.0
    cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
    warn	Skip package processing as generation is failed
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from d8908192d2797418626e3890255ca421217d973b. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/frontdoor/armfrontdoor [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New enum type `ScrubbingRuleEntryMatchOperator` with values `ScrubbingRuleEntryMatchOperatorEquals`, `ScrubbingRuleEntryMatchOperatorEqualsAny`
    info	[Changelog] - New enum type `ScrubbingRuleEntryMatchVariable` with values `ScrubbingRuleEntryMatchVariableQueryStringArgNames`, `ScrubbingRuleEntryMatchVariableRequestBodyJSONArgNames`, `ScrubbingRuleEntryMatchVariableRequestBodyPostArgNames`, `ScrubbingRuleEntryMatchVariableRequestCookieNames`, `ScrubbingRuleEntryMatchVariableRequestHeaderNames`, `ScrubbingRuleEntryMatchVariableRequestIPAddress`, `ScrubbingRuleEntryMatchVariableRequestURI`
    info	[Changelog] - New enum type `ScrubbingRuleEntryState` with values `ScrubbingRuleEntryStateDisabled`, `ScrubbingRuleEntryStateEnabled`
    info	[Changelog] - New enum type `WebApplicationFirewallScrubbingState` with values `WebApplicationFirewallScrubbingStateDisabled`, `WebApplicationFirewallScrubbingStateEnabled`
    info	[Changelog] - New struct `PolicySettingsLogScrubbing`
    info	[Changelog] - New struct `WebApplicationFirewallScrubbingRules`
    info	[Changelog] - New field `LogScrubbing` in struct `PolicySettings`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 22 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from d8908192d2797418626e3890255ca421217d973b. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-frontdoor [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added Interface PolicySettingsLogScrubbing
    info	[Changelog]   - Added Interface WebApplicationFirewallScrubbingRules
    info	[Changelog]   - Added Type Alias ScrubbingRuleEntryMatchOperator
    info	[Changelog]   - Added Type Alias ScrubbingRuleEntryMatchVariable
    info	[Changelog]   - Added Type Alias ScrubbingRuleEntryState
    info	[Changelog]   - Added Type Alias WebApplicationFirewallScrubbingState
    info	[Changelog]   - Interface PolicySettings has a new optional parameter logScrubbing
    info	[Changelog]   - Added Enum KnownScrubbingRuleEntryMatchOperator
    info	[Changelog]   - Added Enum KnownScrubbingRuleEntryMatchVariable
    info	[Changelog]   - Added Enum KnownScrubbingRuleEntryState
    info	[Changelog]   - Added Enum KnownWebApplicationFirewallScrubbingState
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Class FrontDoorManagementClient has a new signature
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from d8908192d2797418626e3890255ca421217d973b. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️frontdoor [View full logs]  [Preview Schema Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 27, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/frontdoor/armfrontdoor https://apiview.dev/Assemblies/Review/10c1edcb81e54eaaa679f9a47a441491
.Net Azure.ResourceManager.FrontDoor https://apiview.dev/Assemblies/Review/a3e21414232c43b78783235295f479de
JavaScript @azure/arm-frontdoor https://apiview.dev/Assemblies/Review/8c4df30d30694a0e93f7c5cc711c794a
Swagger Microsoft.Network https://apiview.dev/Assemblies/Review/d13e0adcfca64274995db3ec8fc9adc2

@disreedh disreedh marked this pull request as ready for review September 27, 2023 19:08
@disreedh disreedh marked this pull request as draft September 27, 2023 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants