Skip to content

feat: fragment support swagger change#25314

Merged
Sneezry merged 1 commit intoAzure:dev-appplatform-2023-09-01-previewfrom
guitarsheng:dev-appplatform-2023-09-01-preview
Aug 16, 2023
Merged

feat: fragment support swagger change#25314
Sneezry merged 1 commit intoAzure:dev-appplatform-2023-09-01-previewfrom
guitarsheng:dev-appplatform-2023-09-01-preview

Conversation

@guitarsheng
Copy link
Contributor

@guitarsheng guitarsheng commented Aug 15, 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.)
  • 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.

Getting help

@openapi-workflow-bot
Copy link

Hi, @guitarsheng! 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 15, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 20 Errors, 5 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    appplatform.json 2023-09-01-preview(627b338) 2022-12-01(main)
    appplatform.json 2023-09-01-preview(627b338) 2023-05-01-preview(main)

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

    Rule Message
    1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L11835:7
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L8613:7
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L9120:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L6522:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1455:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L721:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1498:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L764:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1557:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L823:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1651:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L917:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L6747:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5117:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L6790:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5160:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L6913:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5219:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7106:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5313:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7152:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5359:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7214:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5421:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7266:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5473:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7314:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5521:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7360:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5567:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7422:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5629:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7474:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5681:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L7522:9
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L5729:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L15004:5
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L10751:5
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L15037:5
    Old: Microsoft.AppPlatform/stable/2022-12-01/appplatform.json#L10767:5


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

    Rule Message
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1455:9
    Old: Microsoft.AppPlatform/preview/2023-05-01-preview/appplatform.json#L1404:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1498:9
    Old: Microsoft.AppPlatform/preview/2023-05-01-preview/appplatform.json#L1447:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1557:9
    Old: Microsoft.AppPlatform/preview/2023-05-01-preview/appplatform.json#L1506:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L1651:9
    Old: Microsoft.AppPlatform/preview/2023-05-01-preview/appplatform.json#L1600:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.AppPlatform/preview/2023-09-01-preview/appplatform.json#L15004:5
    Old: Microsoft.AppPlatform/preview/2023-05-01-preview/appplatform.json#L14791:5
    ️🔄LintDiff inProgress [Detail]
    ️️✔️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 pending [Detail]
    ️⌛Automated merging requirements met pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 15, 2023

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=380190&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 128 "
    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Breaking Changes Tracking

    ⚠️azure-sdk-for-go - sdk/resourcemanager/appplatform/armappplatform - 2.0.0-beta.2
    +	Field `Instances`, `ResourceRequests` of struct `DevToolPortalProperties` has been removed
    ⚠️azure-sdk-for-js - @azure/arm-appplatform - 3.0.0-beta.2
    +	Class AppPlatformManagementClient has a new signature
    +	Interface DeploymentsListForClusterNextOptionalParams no longer has parameter version
    +	Interface DeploymentsListNextOptionalParams no longer has parameter version
    +	Type of parameter addonConfigs of interface AppResourceProperties is changed from {
            [propertyName: string]: {
                [propertyName: string]: Record;
            };
        } to {
            [propertyName: string]: Record;
        }
    +	Type of parameter addonConfigs of interface DeploymentSettings is changed from {
            [propertyName: string]: {
                [propertyName: string]: Record;
            };
        } to {
            [propertyName: string]: Record;
        }
    +	Type of parameter bindingParameters of interface BindingResourceProperties is changed from {
            [propertyName: string]: Record;
        } to {
            [propertyName: string]: string;
        }
    ⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-appplatform - 8.0.0
    +	Model DevToolPortalProperties no longer has parameter instances
    +	Model DevToolPortalProperties no longer has parameter resource_requests
    ️🔄 azure-powershell inProgress [Detail]
    ️🔄 azure-sdk-for-python-track2 inProgress [Detail]
    ️🔄 azure-sdk-for-java inProgress [Detail]
    ️🔄 azure-sdk-for-net-track2 inProgress [Detail]
    ️🔄 azure-sdk-for-js inProgress [Detail]
    ️🔄 azure-sdk-for-go inProgress [Detail]
    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 15, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.AppPlatform https://apiview.dev/Assemblies/Review/bbdee0be85234d7184e40001d688471d

    @openapi-workflow-bot
    Copy link

    Hi @guitarsheng! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.

    You cannot proceed with merging this PR until you complete one of the following action items:

    ACTION ITEM ALTERNATIVE A: Fix the breaking change.
    Please consult the documentation provided in the relevant validation failures.

    ACTION ITEM ALTERNATIVE B: Request approval.
    Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the breaking changes process.
    This case 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.

    @Sneezry
    Copy link
    Member

    Sneezry commented Aug 16, 2023

    /azp run

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2023

    Next Steps to Merge

    ⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

    Next steps that must be taken to merge this PR:
    • ❌ Your PR has breaking changes (label: BreakingChangeReviewRequired). See the PR description for help.

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @Sneezry Sneezry merged commit 576c2d1 into Azure:dev-appplatform-2023-09-01-preview Aug 16, 2023
    yuwzho pushed a commit that referenced this pull request Aug 24, 2023
    yuwzho pushed a commit that referenced this pull request Aug 24, 2023
    rkmanda pushed a commit that referenced this pull request Sep 12, 2023
    * Adds base for updating Microsoft.AppPlatform from version preview/2023-07-01-preview to version 2023-09-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * feat: fragment support swagger change (#25314)
    
    * Add apiTryOutEnabledState properties for api portal for 2023-09-01-preview api (#25322)
    
    * support war file deployment (#25312)
    
    Co-authored-by: Yi Li <yili7@microsoft.com>
    
    * Fix exmaple for api portal api try-out feature (#25337)
    
    * Add property `autoSync` in `KeyVaultCertificateProperties` (#25331)
    
    * Add gateway apm reference (#25408)
    
    * Add expand parameter for list deployment (#25411)
    
    * Add expand parameter for list deployments API (#25471)
    
    * change order of expand (#25587)
    
    * Update readme.go.md (#25634)
    
    * Update readme.go.md
    
    * Update readme.python.md
    
    * Update readme.ruby.md
    
    * Revert api portal try out feature (#25677)
    
    Fix exmaple for api portal api try-out feature (#25337)"
    
    * add API to list all server versions (#25720)
    
    * add API to list all server versions
    
    * refine list supported server version API
    
    * refine description
    
    ---------
    
    Co-authored-by: Yi Li <yili7@microsoft.com>
    
    * use enum for autoSync (#25722)
    
    * Update appplatform.json (#25724)
    
    * certificate - rename enum (#25723)
    
    * use enum for autoSync
    
    * rename enum
    
    * rename enum
    
    ---------
    
    Co-authored-by: guitarsheng <85543793+guitarsheng@users.noreply.github.com>
    Co-authored-by: Mason Chen <jiec@microsoft.com>
    Co-authored-by: Yi Li <109205537+yilims@users.noreply.github.com>
    Co-authored-by: Yi Li <yili7@microsoft.com>
    Co-authored-by: Jeff <1830237+domainname@users.noreply.github.com>
    Co-authored-by: ninpan-ms <71061174+ninpan-ms@users.noreply.github.com>
    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    * Adds base for updating Microsoft.AppPlatform from version preview/2023-07-01-preview to version 2023-09-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * feat: fragment support swagger change (#25314)
    
    * Add apiTryOutEnabledState properties for api portal for 2023-09-01-preview api (#25322)
    
    * support war file deployment (#25312)
    
    Co-authored-by: Yi Li <yili7@microsoft.com>
    
    * Fix exmaple for api portal api try-out feature (#25337)
    
    * Add property `autoSync` in `KeyVaultCertificateProperties` (#25331)
    
    * Add gateway apm reference (#25408)
    
    * Add expand parameter for list deployment (#25411)
    
    * Add expand parameter for list deployments API (#25471)
    
    * change order of expand (#25587)
    
    * Update readme.go.md (#25634)
    
    * Update readme.go.md
    
    * Update readme.python.md
    
    * Update readme.ruby.md
    
    * Revert api portal try out feature (#25677)
    
    Fix exmaple for api portal api try-out feature (#25337)"
    
    * add API to list all server versions (#25720)
    
    * add API to list all server versions
    
    * refine list supported server version API
    
    * refine description
    
    ---------
    
    Co-authored-by: Yi Li <yili7@microsoft.com>
    
    * use enum for autoSync (#25722)
    
    * Update appplatform.json (#25724)
    
    * certificate - rename enum (#25723)
    
    * use enum for autoSync
    
    * rename enum
    
    * rename enum
    
    ---------
    
    Co-authored-by: guitarsheng <85543793+guitarsheng@users.noreply.github.com>
    Co-authored-by: Mason Chen <jiec@microsoft.com>
    Co-authored-by: Yi Li <109205537+yilims@users.noreply.github.com>
    Co-authored-by: Yi Li <yili7@microsoft.com>
    Co-authored-by: Jeff <1830237+domainname@users.noreply.github.com>
    Co-authored-by: ninpan-ms <71061174+ninpan-ms@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants