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

swagger 20230201 adding resource guid #24154

Conversation

sssharma24
Copy link
Member

@sssharma24 sssharma24 commented May 24, 2023

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @sssharma24 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 24, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 51 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    networkManager.json 2023-02-01(98e0a43) 2022-11-01(main)
    networkManager.json 2023-02-01(98e0a43) 2022-04-01-preview(main)
    networkManagerConnectivityConfiguration.json 2023-02-01(98e0a43) 2022-11-01(main)
    networkManagerConnectivityConfiguration.json 2023-02-01(98e0a43) 2022-04-01-preview(main)
    networkManagerGroup.json 2023-02-01(98e0a43) 2022-11-01(main)
    networkManagerGroup.json 2023-02-01(98e0a43) 2022-04-01-preview(main)
    networkManagerSecurityAdminConfiguration.json 2023-02-01(98e0a43) 2022-11-01(main)
    networkManagerSecurityAdminConfiguration.json 2023-02-01(98e0a43) 2022-04-01-preview(main)

    The following breaking changes are detected by comparison with the latest preview version:

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

    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/networkManagers/{networkManagerName}/listEffectiveVirtualNetworks' removed or restructured?
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L418:5
    ⚠️ 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/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/listEffectiveVirtualNetworks' removed or restructured?
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L240:5
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'EffectiveVirtualNetworksParameter' removed or renamed?
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L422:3
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L476:3
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'SecurityUser' from the old version.
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L504:11
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L558:11
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'SecurityUser' from the old version.
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L576:9
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L625:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'SecurityUser' from the old version.
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L613:11
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L661:11
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'SecurityUser' from the old version.
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L676:9
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L724:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'SecurityUser' from the old version.
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L687:5
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L735:5
    ⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: Microsoft.Network/stable/2023-02-01/networkManager.json#L556:7
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManager.json#L605:7
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerConnectivityConfiguration.json#L64:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerConnectivityConfiguration.json#L64:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerConnectivityConfiguration.json#L92:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerConnectivityConfiguration.json#L92:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerConnectivityConfiguration.json#L101:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerConnectivityConfiguration.json#L101:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerConnectivityConfiguration.json#L107:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerConnectivityConfiguration.json#L107:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerConnectivityConfiguration.json#L227:11
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerConnectivityConfiguration.json#L227:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerConnectivityConfiguration.json#L239:5
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerConnectivityConfiguration.json#L239:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L64:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L64:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L92:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L92:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L109:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L109:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L121:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L121:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L439:11
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L506:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L270:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L324:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L298:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L352:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L307:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L361:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L313:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L367:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L497:11
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L566:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L413:5
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L480:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerGroup.json#L471:5
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerGroup.json#L540:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerSecurityAdminConfiguration.json#L664:11
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerSecurityAdminConfiguration.json#L659:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerSecurityAdminConfiguration.json#L114:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerSecurityAdminConfiguration.json#L114:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Network/stable/2023-02-01/networkManagerSecurityAdminConfiguration.json#L142:13
    Old: Microsoft.Network/preview/2022-04-01-preview/networkManagerSecurityAdminConfiguration.json#L142:13
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.1.2) new version base version
    package-2023-02 package-2023-02(98e0a43) package-2023-02(release-network-Microsoft.Network-official-2023-02-01)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️CadlAPIView 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.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 24, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-java warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️❌ azure-powershell failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 24, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.Network Create ApiView failed. Please ask PR assignee for help
    Go sdk/resourcemanager/network/armnetwork https://apiview.dev/Assemblies/Review/a19df74f9c594bfdb2a9f1a3d6e7ced4
    Java azure-resourcemanager-network-generated https://apiview.dev/Assemblies/Review/c612baca210e4243acab648f5da06313
    JavaScript @azure/arm-network https://apiview.dev/Assemblies/Review/02503c55e6024b79b9fd84677b1b9c0f

    @ankhyk
    Copy link
    Contributor

    ankhyk commented May 30, 2023

    @qiaozha please review the JS breaking change
    @msyyc please review the Python breaking change

    @msyyc
    Copy link
    Member

    msyyc commented May 31, 2023

    approved for python since breaking is not caused by this PR

    @ankhyk ankhyk added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 31, 2023
    @lirenhe lirenhe merged commit 3bea9ad into Azure:release-network-Microsoft.Network-official-2023-02-01 May 31, 2023
    msyyc pushed a commit that referenced this pull request Jun 13, 2023
    * Adds base for updating Microsoft.Network from version stable/2022-11-01 to version 2023-02-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fixed double header issue (#23896)
    
    * Edited description for additional nics (#24071)
    
    * swagger 20230201 adding resource guid (#24154)
    
    * Appgw: Remove 499 status code from custom error page (#24095)
    
    * Add AdminState Property to Virtual Network Gateway Resource Properties (#23978)
    
    * add adminstate
    
    * update description
    
    * add headers to 202
    
    * prettier fix
    
    * AppGW: Add default predefined ssl policy field in resource (#24094)
    
    * Fix examples (#24274)
    
    ---------
    
    Co-authored-by: Mikhail <[email protected]>
    Co-authored-by: JainRah <[email protected]>
    Co-authored-by: sssharma24 <[email protected]>
    Co-authored-by: Prateek Sachan <[email protected]>
    Co-authored-by: nimaller <[email protected]>
    Co-authored-by: Sindhu Aluguvelli <[email protected]>
    harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023
    * Adds base for updating Microsoft.Network from version stable/2022-11-01 to version 2023-02-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fixed double header issue (Azure#23896)
    
    * Edited description for additional nics (Azure#24071)
    
    * swagger 20230201 adding resource guid (Azure#24154)
    
    * Appgw: Remove 499 status code from custom error page (Azure#24095)
    
    * Add AdminState Property to Virtual Network Gateway Resource Properties (Azure#23978)
    
    * add adminstate
    
    * update description
    
    * add headers to 202
    
    * prettier fix
    
    * AppGW: Add default predefined ssl policy field in resource (Azure#24094)
    
    * Fix examples (Azure#24274)
    
    ---------
    
    Co-authored-by: Mikhail <[email protected]>
    Co-authored-by: JainRah <[email protected]>
    Co-authored-by: sssharma24 <[email protected]>
    Co-authored-by: Prateek Sachan <[email protected]>
    Co-authored-by: nimaller <[email protected]>
    Co-authored-by: Sindhu Aluguvelli <[email protected]>
    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.

    6 participants