Skip to content

Conversation

@xiaoxuqi-ms
Copy link
Member

@xiaoxuqi-ms xiaoxuqi-ms commented Apr 4, 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 Apr 4, 2023

    Swagger Validation Report

    ️❌BreakingChange: 12 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    Configurations.json 2021-12-01-preview(f45cc4a) 2021-12-01-preview(main)
    FlexibleServers.json 2021-12-01-preview(f45cc4a) 2021-12-01-preview(main)
    Rule Message
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L697:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L692:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L706:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L701:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L671:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L666:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L743:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L738:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L1048:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L1043:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L577:5
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L574:5
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L864:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L859:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L991:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L986:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L590:5
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L586:5
    1039 - AddedOperation The new version is adding an operation that was not found in the old version.
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L38:7
    1045 - AddedOptionalProperty The new version has a new optional property 'currentValue' that was not found in the old version.
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L321:7
    Old: Configurations/preview/2021-12-01-preview/Configurations.json#L257:7
    1045 - AddedOptionalProperty The new version has a new optional property 'documentationLink' that was not found in the old version.
    New: Configurations/preview/2021-12-01-preview/Configurations.json#L321:7
    Old: Configurations/preview/2021-12-01-preview/Configurations.json#L257:7
    ️❌Breaking Change(Cross-Version): 94 Errors, 53 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    AzureADAdministrator.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    Backups.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    Configurations.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    Databases.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    FirewallRules.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    FlexibleServers.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    LogFiles.json 2022-01-01(f45cc4a) 2021-12-01-preview(main)
    ServiceOperations.json 2022-01-01(f45cc4a) 2021-12-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
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L729:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L692:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L738:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L701:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L703:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L666:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L775:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L738:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L1080:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L1043:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L609:5
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L574:5
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L896:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L859:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L1023:9
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L986:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L622:5
    Old: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L586:5
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'code' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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 'code' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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 'code' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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 'code' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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: common-types/resource-management/v2/types.json#L331: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 'code' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331:7
    Old: common-types/resource-management/v1/types.json#L289:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌LintDiff: 8 Errors, 0 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-flexibleserver-2021-12-01-preview package-flexibleserver-2021-12-01-preview(f45cc4a) package-flexibleserver-2021-12-01-preview(main)
    package-flexibleserver-2022-01-01 package-flexibleserver-2022-01-01(f45cc4a) default(main)

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

    Rule Message Related RPC [For API reviewers]
    CreateOperationAsyncResponseValidation An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options'
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38
    RPC-Async-V1-01
    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
    RPC-Async-V1-01
    CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L75
    RPC-Async-V1-01
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L82
    RPC-Async-V1-01
    CreateOperationAsyncResponseValidation An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options'
    Location: Configurations/stable/2022-01-01/Configurations.json#L38
    RPC-Async-V1-01
    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/stable/2022-01-01/Configurations.json#L38
    RPC-Async-V1-01
    CreateOperationAsyncResponseValidation An async PUT operation must return 201.
    Location: Configurations/stable/2022-01-01/Configurations.json#L75
    RPC-Async-V1-01
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Configurations/stable/2022-01-01/Configurations.json#L82
    RPC-Async-V1-01


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: AAD/stable/2022-01-01/AzureADAdministrator.json#L38
    LongRunningResponseStatusCode A 'put' operation 'AzureADAdministrators_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: AAD/stable/2022-01-01/AzureADAdministrator.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: AAD/stable/2022-01-01/AzureADAdministrator.json#L88
    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
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L129
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L129
    LroLocationHeader A 202 response should include an Location response header.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L146
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L202
    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#L203
    LroLocationHeader A 202 response should include an Location response header.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L244
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: Configurations/preview/2021-12-01-preview/Configurations.json#L260
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Configurations/stable/2022-01-01/Configurations.json#L129
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Configurations/stable/2022-01-01/Configurations.json#L129
    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/stable/2022-01-01/Configurations.json#L208
    ResourceNameRestriction The resource name parameter 'databaseName' should be defined with a 'pattern' restriction.
    Location: Databases/stable/2022-01-01/Databases.json#L37
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Databases/stable/2022-01-01/Databases.json#L38
    LongRunningResponseStatusCode A 'put' operation 'Databases_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Databases/stable/2022-01-01/Databases.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Databases/stable/2022-01-01/Databases.json#L88
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Firewall/stable/2022-01-01/FirewallRules.json#L38
    LongRunningResponseStatusCode A 'put' operation 'FirewallRules_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Firewall/stable/2022-01-01/FirewallRules.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Firewall/stable/2022-01-01/FirewallRules.json#L88
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L37
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: FlexibleServers/preview/2021-12-01-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/2021-12-01-preview/FlexibleServers.json#L38
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L94
    LroLocationHeader A 202 response should include an Location response header.
    Location: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L94
    LroLocationHeader A 202 response should include an Location response header.
    Location: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L153
    LroLocationHeader A 202 response should include an Location response header.
    Location: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L194
    ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
    Location: FlexibleServers/preview/2021-12-01-preview/FlexibleServers.json#L337
    ️❌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 Apr 4, 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
    +	Field `AdditionalInfo` of struct `ErrorResponse` has been removed
    +	Field `Code` of struct `ErrorResponse` has been removed
    +	Field `Details` of struct `ErrorResponse` has been removed
    +	Field `Message` of struct `ErrorResponse` has been removed
    +	Field `Target` of struct `ErrorResponse` has been removed

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5bcf0a7. 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 5bcf0a7. 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 model ErrorResponseAutoGenerated
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5bcf0a7. 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
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `AdditionalInfo` of struct `ErrorResponse` has been removed
      info	[Changelog] - Field `Code` of struct `ErrorResponse` has been removed
      info	[Changelog] - Field `Details` of struct `ErrorResponse` has been removed
      info	[Changelog] - Field `Message` of struct `ErrorResponse` has been removed
      info	[Changelog] - Field `Target` of struct `ErrorResponse` has been removed
      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 `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 `*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.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 `NewLogFilesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*LogFilesClient, error)`
      info	[Changelog] - New function `*LogFilesClient.NewListByServerPager(string, string, *LogFilesClientListByServerOptions) *runtime.Pager[LogFilesClientListByServerResponse]`
      info	[Changelog] - New struct `AdministratorListResult`
      info	[Changelog] - New struct `AdministratorProperties`
      info	[Changelog] - New struct `AzureADAdministrator`
      info	[Changelog] - New struct `ErrorDetail`
      info	[Changelog] - New struct `LogFile`
      info	[Changelog] - New struct `LogFileListResult`
      info	[Changelog] - New struct `LogFileProperties`
      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 `Error` in struct `ErrorResponse`
      info	[Changelog] - New field `Version` in struct `ServerPropertiesForUpdate`
      info	[Changelog] - New field `AutoIoScaling` 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), 42 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5bcf0a7. 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 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5bcf0a7. 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] WARN 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
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 5bcf0a7. 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 Apr 4, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/mysql/armmysql There is no API change compared with the previous version
    Go sdk/resourcemanager/mysql/armmysqlflexibleservers https://apiview.dev/Assemblies/Review/608d66e9f9274e3f906edc93b3291d49
    Java azure-resourcemanager-mysqlflexibleserver https://apiview.dev/Assemblies/Review/afaa89ca6f00416d995e9b66118a44d4
    .Net Azure.ResourceManager.MySql https://apiview.dev/Assemblies/Review/41898e9a71784823ad19de3b6a175fff

    @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 Apr 4, 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).

    @xiaoxuqi-ms
    Copy link
    Member Author

    This pr is to add new version 2021-12-01 based on 2021-12-01-preview for Terraform release only

    @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

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Apr 7, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Apr 11, 2023
    @xiaoxuqi-ms xiaoxuqi-ms changed the title Convert 2021-12-01-preview into stable version 2021-12-01 (no API change) Convert 2021-12-01-preview into stable version 2022-01-01 (no new API) Apr 12, 2023
    @mikekistler
    Copy link
    Member

    Approving breaking changes as all are to address errors/omissions from the REST API definition and not service behavior changes.

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

    @Azure/arm-api-review-board The service team has asked to expedite this PR. Could the on-call please review and approve or provide feedback?

    @xiaoxuqi-ms
    Copy link
    Member Author

    TF release requires a stable version, so we convert 2021-12-01-preview to 2022-01-01 for TF release only. There are still some linter issues but we are not fixing these for the following reasons:

    1. to update status codes need backend to support, but we will not touch 2021-12-01 backend, it will be a tremendous breaking change.
    2. 2021-12-01/2022-01-01 is an old version, we are working on new version for now. So these linter issues might be fixed in a new version.

    @xiaoxuqi-ms
    Copy link
    Member Author

    the prettier check fails due to new constraint pattern of Database name.
    image
    and Mysql supports both single server and flexible server, so we need multi default in readme. this Avocado error is not brought by this pr.

    @haolingdong-msft
    Copy link
    Member

    @josefree , this pr has CI failure, but the author provides reasons, mainly because they are changing an old preview version to stable, and they don't want to change the old version service, they will fix the failures in new version. Could you please advice if this is acceptable to merge? Thanks!

    @josefree
    Copy link
    Member

    @josefree , this pr has CI failure, but the author provides reasons, mainly because they are changing an old preview version to stable, and they don't want to change the old version service, they will fix the failures in new version. Could you please advice if this is acceptable to merge? Thanks!

    Based on Mike's approval on breaking change and Xiaoxu's statement, I think we can accept to merge this PR. Thanks.

    @xiaoxuqi-ms xiaoxuqi-ms merged commit 5bcf0a7 into main Apr 13, 2023
    @xiaoxuqi-ms xiaoxuqi-ms deleted the mysql20211202 branch April 13, 2023 03:46
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    Azure#23426)
    
    * add 2021-12-01 base
    
    * update api version
    
    * update readme
    
    * fix pattern for linter
    
    * fix 202 for linter
    
    * fix linter lro
    
    * update pattern for backup
    
    * fix swagger kpi issue
    
    * use 2022-01-01 as version
    
    * fix errorResponse
    
    * remove pattern for prettier check
    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 MySQL new-api-version resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    7 participants