Skip to content

Conversation

@xiaoxuqi-ms
Copy link
Member

@xiaoxuqi-ms xiaoxuqi-ms commented Mar 24, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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.
  • 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, @xiaoxuqi-ms 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 24, 2023

    Swagger Validation Report

    ️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    Configurations.json 2021-12-01-preview(01e3f23) 2021-12-01-preview(main)
    common-types.json 2022-09-30-preview(01e3f23) 2022-09-30-preview(main)
    Rule Message
    1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L92:13
    Old: Configurations/preview/2021-12-01-preview/Configurations.json#L92:13
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'code' renamed or removed?
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L498:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'message' renamed or removed?
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L498:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'target' renamed or removed?
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L498:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'details' renamed or removed?
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L498:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'additionalInfo' renamed or removed?
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L498:7
    Old: common-types/resource-management/v1/types.json#L289:7
    1041 - AddedPropertyInResponse The new version has a new property 'error' in response that was not found in the old version.
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L498:7
    Old: common-types/resource-management/v1/types.json#L289:7
    ️❌Breaking Change(Cross-Version): 1 Errors, 16 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    Backups.json 2022-09-30-preview(01e3f23) 2022-01-01(main)
    Backups.json 2022-09-30-preview(01e3f23) 2021-12-01-preview(main)
    FlexibleServers.json 2022-09-30-preview(01e3f23) 2022-01-01(main)
    FlexibleServers.json 2022-09-30-preview(01e3f23) 2021-12-01-preview(main)

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

    Rule Message
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L1184:9
    Old: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L1104:9


    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: Backups/preview/2022-09-30-preview/Backups.json#L49:9
    Old: Backups/preview/2021-12-01-preview/Backups.json#L49:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Backups/preview/2022-09-30-preview/Backups.json#L92:9
    Old: Backups/preview/2021-12-01-preview/Backups.json#L92:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Backups/preview/2022-09-30-preview/Backups.json#L137:9
    Old: Backups/preview/2021-12-01-preview/Backups.json#L137:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.DBforMySQL/common-types/v1/common-types.json#L16:5
    Old: Backups/preview/2021-12-01-preview/Backups.json#L242:5
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Backups/preview/2022-09-30-preview/Backups.json#L242:5
    Old: Backups/preview/2021-12-01-preview/Backups.json#L250:5
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L58:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L58:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L128:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L123:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L186:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L176:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L241:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L226:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L364:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L349:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L412:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L392:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L469:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L444:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L517:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L487:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L625:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L530:9
    ⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.DBforMySQL/common-types/v1/common-types.json#L16:5
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L1128:5
    ⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
    New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L1184:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L1072:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌LintDiff: 1 Errors, 15 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-flexibleserver-2022-09-30-preview-privatelink package-flexibleserver-2022-09-30-preview-privatelink(01e3f23) package-flexibleserver-2022-09-30-preview-privatelink(main)
    package-flexibleserver-2022-09-30-preview package-flexibleserver-2022-09-30-preview(01e3f23) default(main)

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

    Rule Message Related RPC [For API reviewers]
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L554
    RPC-Async-V1-11
    ⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'backupandexport' in:'BackupAndExport_Create'. Consider updating the operationId
    Location: Backups/preview/2022-09-30-preview/BackupAndExport.json#L29
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Backups/preview/2022-09-30-preview/BackupAndExport.json#L36
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Backups/preview/2022-09-30-preview/BackupAndExport.json#L104
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L58
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L128
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L186
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L241
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L283
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L325
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L364
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L412
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L469
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L517
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L565
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L625


    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 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37
    ResourceNameRestriction The resource name parameter 'configurationName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37
    ResourceNameRestriction The resource name parameter 'configurationName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38
    LongRunningResponseStatusCode A 'put' operation 'Configurations_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38
    LongRunningResponseStatusCode A 'put' operation 'Configurations_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38
    CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L75
    CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L75
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L82
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L82
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126
    LroLocationHeader A 202 response should include an Location response header.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L143
    LroLocationHeader A 202 response should include an Location response header.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L143
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L199
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L199
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L200
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L200
    LroLocationHeader A 202 response should include an Location response header.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L241
    LroLocationHeader A 202 response should include an Location response header.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L241
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L257
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L257
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L38
    LongRunningResponseStatusCode A 'put' operation 'Servers_Create' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L94
    DeleteOperationAsyncResponseValidation An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L175
    ️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
    Rule Message
    MULTIPLE_DEFAULT_TAGS The readme file has more than one default tag.
    readme: specification/mysql/resource-manager/readme.md
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/mysql/resource-manager/readme.md
    tag: specification/mysql/resource-manager/readme.md#tag-package-2020-01-01
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView 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).
    ️️✔️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 Mar 24, 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-go - sdk/resourcemanager/mysql/armmysqlflexibleservers - 2.0.0-beta.1
    +	Type of `Identity.Type` has been changed from `*string` to `*ManagedServiceIdentityType`
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f9be216. 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.MySql [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f9be216. 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] notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.4
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.4>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.4` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-rdbms [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group BackupAndExportOperations
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f9be216. 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/mysql/armmysql [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️sdk/resourcemanager/mysql/armmysqlflexibleservers [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 60 items here, please refer to log for details.
      info	[Changelog] - Type of `Identity.Type` has been changed from `*string` to `*ManagedServiceIdentityType`
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `AdministratorName` with values `AdministratorNameActiveDirectory`
      info	[Changelog] - New enum type `AdministratorType` with values `AdministratorTypeActiveDirectory`
      info	[Changelog] - New enum type `BackupFormat` with values `BackupFormatCollatedFormat`, `BackupFormatNone`
      info	[Changelog] - New enum type `ManagedServiceIdentityType` with values `ManagedServiceIdentityTypeUserAssigned`
      info	[Changelog] - New enum type `OperationStatus` with values `OperationStatusCancelInProgress`, `OperationStatusCanceled`, `OperationStatusFailed`, `OperationStatusInProgress`, `OperationStatusPending`, `OperationStatusSucceeded`
      info	[Changelog] - New enum type `ResetAllToDefault` with values `ResetAllToDefaultFalse`, `ResetAllToDefaultTrue`
      info	[Changelog] - New function `NewAzureADAdministratorsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AzureADAdministratorsClient, error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.BeginCreateOrUpdate(context.Context, string, string, AdministratorName, AzureADAdministrator, *AzureADAdministratorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzureADAdministratorsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.BeginDelete(context.Context, string, string, AdministratorName, *AzureADAdministratorsClientBeginDeleteOptions) (*runtime.Poller[AzureADAdministratorsClientDeleteResponse], error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.Get(context.Context, string, string, AdministratorName, *AzureADAdministratorsClientGetOptions) (AzureADAdministratorsClientGetResponse, error)`
      info	[Changelog] - New function `*AzureADAdministratorsClient.NewListByServerPager(string, string, *AzureADAdministratorsClientListByServerOptions) *runtime.Pager[AzureADAdministratorsClientListByServerResponse]`
      info	[Changelog] - New function `NewBackupAndExportClient(string, azcore.TokenCredential, *arm.ClientOptions) (*BackupAndExportClient, error)`
      info	[Changelog] - New function `*BackupAndExportClient.BeginCreate(context.Context, string, string, BackupAndExportRequest, *BackupAndExportClientBeginCreateOptions) (*runtime.Poller[BackupAndExportClientCreateResponse], error)`
      info	[Changelog] - New function `*BackupAndExportClient.ValidateBackup(context.Context, string, string, *BackupAndExportClientValidateBackupOptions) (BackupAndExportClientValidateBackupResponse, error)`
      info	[Changelog] - New function `*BackupStoreDetails.GetBackupStoreDetails() *BackupStoreDetails`
      info	[Changelog] - New function `*BackupsClient.Put(context.Context, string, string, string, *BackupsClientPutOptions) (BackupsClientPutResponse, error)`
      info	[Changelog] - New function `NewCheckNameAvailabilityWithoutLocationClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CheckNameAvailabilityWithoutLocationClient, error)`
      info	[Changelog] - New function `*CheckNameAvailabilityWithoutLocationClient.Execute(context.Context, NameAvailabilityRequest, *CheckNameAvailabilityWithoutLocationClientExecuteOptions) (CheckNameAvailabilityWithoutLocationClientExecuteResponse, error)`
      info	[Changelog] - New function `*ClientFactory.NewAzureADAdministratorsClient() *AzureADAdministratorsClient`
      info	[Changelog] - New function `*ClientFactory.NewBackupAndExportClient() *BackupAndExportClient`
      info	[Changelog] - New function `*ClientFactory.NewCheckNameAvailabilityWithoutLocationClient() *CheckNameAvailabilityWithoutLocationClient`
      info	[Changelog] - New function `*ClientFactory.NewLogFilesClient() *LogFilesClient`
      info	[Changelog] - New function `*ConfigurationsClient.BeginCreateOrUpdate(context.Context, string, string, string, Configuration, *ConfigurationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConfigurationsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*FullBackupStoreDetails.GetBackupStoreDetails() *BackupStoreDetails`
      info	[Changelog] - New function `NewLogFilesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*LogFilesClient, error)`
      info	[Changelog] - New function `*LogFilesClient.NewListByServerPager(string, string, *LogFilesClientListByServerOptions) *runtime.Pager[LogFilesClientListByServerResponse]`
      info	[Changelog] - New function `*ServersClient.BeginResetGtid(context.Context, string, string, ServerGtidSetParameter, *ServersClientBeginResetGtidOptions) (*runtime.Poller[ServersClientResetGtidResponse], error)`
      info	[Changelog] - New struct `AdministratorListResult`
      info	[Changelog] - New struct `AdministratorProperties`
      info	[Changelog] - New struct `AzureADAdministrator`
      info	[Changelog] - New struct `BackupAndExportRequest`
      info	[Changelog] - New struct `BackupAndExportResponse`
      info	[Changelog] - New struct `BackupAndExportResponseProperties`
      info	[Changelog] - New struct `BackupRequestBase`
      info	[Changelog] - New struct `BackupSettings`
      info	[Changelog] - New struct `FullBackupStoreDetails`
      info	[Changelog] - New struct `LogFile`
      info	[Changelog] - New struct `LogFileListResult`
      info	[Changelog] - New struct `LogFileProperties`
      info	[Changelog] - New struct `ServerGtidSetParameter`
      info	[Changelog] - New struct `ValidateBackupResponse`
      info	[Changelog] - New struct `ValidateBackupResponseProperties`
      info	[Changelog] - New field `ResetAllToDefault` in struct `ConfigurationListForBatchUpdate`
      info	[Changelog] - New field `CurrentValue` in struct `ConfigurationProperties`
      info	[Changelog] - New field `DocumentationLink` in struct `ConfigurationProperties`
      info	[Changelog] - New field `Keyword` in struct `ConfigurationsClientListByServerOptions`
      info	[Changelog] - New field `Page` in struct `ConfigurationsClientListByServerOptions`
      info	[Changelog] - New field `PageSize` in struct `ConfigurationsClientListByServerOptions`
      info	[Changelog] - New field `Tags` in struct `ConfigurationsClientListByServerOptions`
      info	[Changelog] - New field `Version` in struct `ServerPropertiesForUpdate`
      info	[Changelog] - New field `AutoIoScaling` in struct `Storage`
      info	[Changelog] - New field `LogOnDisk` in struct `Storage`
      info	[Changelog] - New field `Location` in struct `VirtualNetworkSubnetUsageResult`
      info	[Changelog] - New field `SubscriptionID` in struct `VirtualNetworkSubnetUsageResult`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 77 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f9be216. 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
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from f9be216. 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]  old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
      Server Error
      HttpError: Server Error
          at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit+request@5.6.3_encoding@0.1.13/node_modules/@octokit/request/dist-node/index.js:86:21
          at processTicksAndRejections (node:internal/process/task_queues:96:5)
          at async workflowPkgUpdatePR (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:377:9)
          at async Object.exports.workflowPkgMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:63:5)
          at async workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:216:9)
          at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:98:13)
          at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:191:13)
          at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    • ️✔️mysql [View full logs
      error	Fatal error: Server Error
      error	The following packages are still pending:
      error		mysql
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f9be216. 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
    • ️✔️Az.mysql.DefaultTag [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 24, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/mysql/armmysql https://apiview.dev/Assemblies/Review/40fad6ae2ad444e3b48739592156feb3
    Go sdk/resourcemanager/mysql/armmysqlflexibleservers https://apiview.dev/Assemblies/Review/b13b2d1a9ab64637b2500a2a5a3b538d
    Java azure-resourcemanager-mysqlflexibleserver https://apiview.dev/Assemblies/Review/c74cfa0821e54f468d30737f749dc278
    .Net Azure.ResourceManager.MySql https://apiview.dev/Assemblies/Review/eeb386d09f87436f9791e020191cc1fc

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 24, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @xiaoxuqi-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-workflow-bot
    Copy link

    Hi @xiaoxuqi-ms, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot
    Copy link

    Hi @xiaoxuqi-ms, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi, @xiaoxuqi-ms, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 14, 2023
    @zizw123
    Copy link

    zizw123 commented Apr 14, 2023

    Signing off, please make sure to open a track item for next version to fix the 202

    @zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 14, 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 Apr 14, 2023
    @weidongxu-microsoft
    Copy link
    Member

    weidongxu-microsoft commented Apr 14, 2023

    I cannot find a proper diff on 2022-09-30-preview/FlexibleServers.json via commit history, could you provide one for easy to review on what is changed compared to previous preview?

    Also you need to fix Avocado.

    @xiaoxuqi-ms xiaoxuqi-ms added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Apr 14, 2023
    @xiaoxuqi-ms xiaoxuqi-ms removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Apr 17, 2023
    @openapi-pipeline-app openapi-pipeline-app bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Apr 17, 2023
    @xiaoxuqi-ms xiaoxuqi-ms removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Apr 17, 2023
    @openapi-pipeline-app openapi-pipeline-app bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Apr 17, 2023
    @weidongxu-microsoft weidongxu-microsoft merged commit f9be216 into main Apr 17, 2023
    @weidongxu-microsoft weidongxu-microsoft deleted the mysql20220930preview branch April 17, 2023 07:31
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    * add base folder 2022-09-30-preview from 2021-12-01-preview
    
    * update version and add new file backupandexport.json
    
    * update readme
    
    * add common-types
    
    * fix readme
    
    * copy 2021-12-01-preview folder to init 2022-09-30-preview
    
    * update version, readme and add new api in FlexibleServers.json
    
    * fix spell check
    
    * fix linter
    
    * fix linter
    
    * fix linter for flexible server
    
    * add location in header to fix linter
    
    * add base for serviceoperation
    
    * update api version
    
    * add new api for service operation
    
    * update readme
    
    * fix model validation
    
    * fix prettier
    
    * update to v5 for apiVersionParameter and resourceGroupName
    
    * fix linter
    
    * fix lro errorResponse
    
    * enableScaling and revert configuration
    
    * fix enableStatusEnum
    
    * sync backupExport
    
    * update readme
    
    * remove service operation
    
    * update backups
    
    * udpate backup name
    
    * fix final-state-via
    
    * fix lro option
    
    * revert replication role
    
    * use cloudError
    
    * Update readme.python.md
    
    * fix customer word
    
    * add default value for EnableStatusEnum
    
    * add logondisk
    
    * fix description
    
    ---------
    
    Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-Avocado Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-FixRequiredOnFailure CI-MissingBaseCommit DoNotMerge <valid label in PR review process> use to hold merge after approval MySQL new-api-version resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    9 participants