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

Aneeshakella/scalable gateway swagger changes #25107

Conversation

aneeshakella-microsoft
Copy link
Contributor

@aneeshakella-microsoft aneeshakella-microsoft commented Aug 2, 2023

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] public repo review queue, private repo review queue
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

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.)
  • [ X] 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:

ARM API changes review

  • If you want for the ARM team to review this PR, you must add the ARMReview label.
  • The automation may automatically add the ARMReview label, if appropriate.
    If this happens, proceed according to guidance given in GitHub comments also added by the automation.

Breaking change review

If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.

Getting help

@openapi-workflow-bot
Copy link

Hi, @aneeshakella-microsoft! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • 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.
  • @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 2, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    virtualNetworkGateway.json 2023-05-01(499fc66) 2023-04-01(main)
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.4) new version base version
    package-2023-05 package-2023-05(499fc66) package-2023-05(release-network-Microsoft.Network-official-2023-05-01)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L2869


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L37
    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-05-01/virtualNetworkGateway.json#L91
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L191
    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-05-01/virtualNetworkGateway.json#L200
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L252
    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-05-01/virtualNetworkGateway.json#L264
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L325
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L378
    ParametersInPost gatewayVip is a query parameter. Post operation must not contain any query parameter other than api-version.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L385
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L415
    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-05-01/virtualNetworkGateway.json#L427
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L442
    LroPostReturn 200 response for a LRO POST operation must have a response schema specified.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L443
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L475
    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-05-01/virtualNetworkGateway.json#L481
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L496
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L541
    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-05-01/virtualNetworkGateway.json#L547
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L562
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L607
    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-05-01/virtualNetworkGateway.json#L613
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L628
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L664
    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-05-01/virtualNetworkGateway.json#L670
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L685
    ParametersInPost peer is a query parameter. Post operation must not contain any query parameter other than api-version.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L692
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L728
    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-05-01/virtualNetworkGateway.json#L734
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L749
    ResourceNameRestriction The resource name parameter 'virtualNetworkGatewayName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2023-05-01/virtualNetworkGateway.json#L799
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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 Aug 2, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-network - Approved - 24.0.0
    +	Removed operation group NspLinkReconcileOperations
    +	Removed operation group NspLinkReferenceReconcileOperations
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 361a0695b6521fb2537ec7eb5823b2c03240bcbd. 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.Network [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] Breaking Changes:
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 361a0695b6521fb2537ec7eb5823b2c03240bcbd. 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] npm notice New minor version of npm available! 9.6.7 -> 9.8.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-network [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Removed operation group NspLinkReconcileOperations
      info	[Changelog]   - Removed operation group NspLinkReferenceReconcileOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 361a0695b6521fb2537ec7eb5823b2c03240bcbd. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-network-generated [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 361a0695b6521fb2537ec7eb5823b2c03240bcbd. 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/network/armnetwork [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `ApplicationGatewaySKUNameBasic` added to enum type `ApplicationGatewaySKUName`
      info	[Changelog] - New value `ApplicationGatewayTierBasic` added to enum type `ApplicationGatewayTier`
      info	[Changelog] - New enum type `SyncMode` with values `SyncModeAutomatic`, `SyncModeManual`
      info	[Changelog] - New function `*LoadBalancersClient.MigrateToIPBased(context.Context, string, string, *LoadBalancersClientMigrateToIPBasedOptions) (LoadBalancersClientMigrateToIPBasedResponse, error)`
      info	[Changelog] - New struct `MigrateLoadBalancerToIPBasedRequest`
      info	[Changelog] - New struct `MigratedPools`
      info	[Changelog] - New struct `VirtualNetworkGatewayAutoScaleBounds`
      info	[Changelog] - New struct `VirtualNetworkGatewayAutoScaleConfiguration`
      info	[Changelog] - New field `SyncMode` in struct `BackendAddressPoolPropertiesFormat`
      info	[Changelog] - New field `AutoScaleConfiguration` in struct `VirtualNetworkGatewayPropertiesFormat`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 16 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 361a0695b6521fb2537ec7eb5823b2c03240bcbd. 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-network [View full logs]  [Preview SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation LoadBalancers.migrateToIpBased
      info	[Changelog]   - Added Interface LoadBalancersMigrateToIpBasedOptionalParams
      info	[Changelog]   - Added Interface MigratedPools
      info	[Changelog]   - Added Interface MigrateLoadBalancerToIpBasedRequest
      info	[Changelog]   - Added Interface VirtualNetworkGatewayAutoScaleBounds
      info	[Changelog]   - Added Interface VirtualNetworkGatewayAutoScaleConfiguration
      info	[Changelog]   - Added Type Alias LoadBalancersMigrateToIpBasedResponse
      info	[Changelog]   - Added Type Alias SyncMode
      info	[Changelog]   - Interface BackendAddressPool has a new optional parameter syncMode
      info	[Changelog]   - Interface VirtualNetworkGateway has a new optional parameter autoScaleConfiguration
      info	[Changelog]   - Added Enum KnownSyncMode
      info	[Changelog]   - Enum KnownApplicationGatewaySkuName has a new value Basic
      info	[Changelog]   - Enum KnownApplicationGatewayTier has a new value Basic
    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs] Generate from 361a0695b6521fb2537ec7eb5823b2c03240bcbd. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ⚠️Az.network.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.network.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 2, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/network/armnetwork https://apiview.dev/Assemblies/Review/e6315a53829c4944817092ddfdbb4bf8
    Java azure-resourcemanager-network-generated https://apiview.dev/Assemblies/Review/ee959d29d74c4116a5e689e88a89acab
    JavaScript @azure/arm-network https://apiview.dev/Assemblies/Review/121aac2467244531a5196642013fb4db
    .Net Azure.ResourceManager.Network https://apiview.dev/Assemblies/Review/7c03b37adb9a48ed9795a42f2274c916

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 2, 2023
    @openapi-workflow-bot
    Copy link

    Hi @aneeshakella-microsoft! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic ValidationFix-SemanticValidation-ErrorHigh
    Model ValidationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffHigh

    If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.

    @zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 3, 2023
    @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 Aug 3, 2023
    @konrad-jamrozik
    Copy link

    /pr RequestMerge

    @rkmanda rkmanda merged commit af6f9b1 into Azure:release-network-Microsoft.Network-official-2023-05-01 Aug 11, 2023
    rkmanda pushed a commit that referenced this pull request Aug 21, 2023
    * Adds base for updating Microsoft.Network from version stable/2023-04-01 to version 2023-05-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Aneeshakella/scalable gateway swagger changes (#25107)
    
    * Added additional scalable gateway changes
    
    * small formatting change
    
    * made documents prettier
    
    * prettier changes
    
    * added references to fix avocado
    
    * testing a fix
    
    * another test
    
    * added new test
    
    * new changes
    
    * removed update
    
    * new changes
    
    * updated specs
    
    * updated specs
    
    * [Public] Adding support for Developer Bastion (#25132)
    
    * Public Preview Developer Bastion
    
    * Public Preview Developer Bastion
    
    * Bastion Developer Sku
    
    * updated firewall policy and rcg object by adding size property to it (#25220)
    
    * Update Subnet property defaultOutboundAccess in swagger (#25181)
    
    * Subnet property defaultOutboundAccess added
    
    * NIT update
    
    * NIT Fix description
    
    ---------
    
    Co-authored-by: unknown <[email protected]>
    
    ---------
    
    Co-authored-by: aneeshakella-microsoft <[email protected]>
    Co-authored-by: anvrao1 <[email protected]>
    Co-authored-by: navya-ganta <[email protected]>
    Co-authored-by: anjbal <[email protected]>
    Co-authored-by: unknown <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants