Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Microsoft.KubernetesConfiguration to add preview and stable version 2023-05-01 #23676

Merged
merged 18 commits into from
May 17, 2023

Conversation

bavneetsingh16
Copy link
Contributor

@bavneetsingh16 bavneetsingh16 commented Apr 21, 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, @bavneetsingh16 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 21, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 30 Errors, 42 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    definitions.json 2023-05-01-preview(60598e9) 2022-03-01(main)
    parameters.json 2023-05-01-preview(60598e9) 2022-03-01(main)
    extensionTypes.json 2023-05-01-preview(60598e9) 2022-01-15-preview(main)
    extensions.json 2023-05-01(60598e9) 2022-11-01(main)
    extensions.json 2023-05-01(60598e9) 2022-04-02-preview(main)
    fluxconfiguration.json 2023-05-01(60598e9) 2022-11-01(main)
    fluxconfiguration.json 2023-05-01(60598e9) 2022-01-01-preview(main)
    kubernetesconfiguration.json 2023-05-01(60598e9) 2022-11-01(main)
    kubernetesconfiguration.json 2023-05-01(60598e9) 2022-01-01-preview(main)
    operations.json 2023-05-01(60598e9) 2022-11-01(main)
    operations.json 2023-05-01(60598e9) 2022-01-01-preview(main)

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

    Rule Message
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/common/2023-05-01-preview/parameters.json#L37:5
    Old: Microsoft.KubernetesConfiguration/common/2022-03-01/parameters.json#L37:5
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/common/2023-05-01-preview/parameters.json#L46:5
    Old: Microsoft.KubernetesConfiguration/common/2022-03-01/parameters.json#L45:5


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

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

    Rule Message
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ExtensionLocationParameter' removed or renamed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L750:3
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L354:3
    1008 - ModifiedOperationId The operation id has been changed from 'ClusterExtensionType_Get' to 'ExtensionTypes_Get'. This will impact generated code.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L359:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L38:7
    1008 - ModifiedOperationId The operation id has been changed from 'ClusterExtensionTypes_List' to 'ExtensionTypes_List'. This will impact generated code.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L279:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L86:7
    1008 - ModifiedOperationId The operation id has been changed from 'ExtensionTypeVersions_List' to 'ExtensionTypes_ListVersions'. This will impact generated code.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L159:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L134:7
    1008 - ModifiedOperationId The operation id has been changed from 'LocationExtensionTypes_List' to 'ExtensionTypes_LocationList'. This will impact generated code.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L38:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L176:7
    1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L546:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L242:7
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L689:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L223:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L697:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L230:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L708:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L292:9
    1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L716:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L314:9
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'releaseTrains' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L549:11
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L263:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'clusterTypes' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L549:11
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L263:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'allowMultipleInstances' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L616:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L342:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'defaultReleaseNamespace' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L616:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L342:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'systemData' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L546:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L242:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'releaseTrain' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L642:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L297:13
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'versions' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L642:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L297:13
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'systemData' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L707:7
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L291:7
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L371:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L46:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L291:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L94:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L171:9
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L142:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L751:5
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L363:5
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/common/2023-05-01-preview/parameters.json#L46:5
    Old: Microsoft.KubernetesConfiguration/common/2022-01-01-preview/parameters.json#L61:5
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.KubernetesConfiguration/common/2023-05-01-preview/parameters.json#L37:5
    Old: Microsoft.KubernetesConfiguration/common/2022-01-01-preview/parameters.json#L45:5
    1049 - RemovedXmsEnum The new version is missing a 'x-ms-enum' found in the old version.
    Old: Microsoft.KubernetesConfiguration/preview/2022-01-15-preview/extensionTypes.json#L46:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 30 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.1) new version base version
    package-preview-2023-05 package-preview-2023-05(60598e9) default(main)
    package-2023-05 package-2023-05(60598e9) default(main)

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

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KubernetesConfiguration/common/2023-05-01-preview/definitions.json#L76
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L38
    ⚠️ GetInOperationName 'GET' operation 'ExtensionTypes_LocationList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L44
    ⚠️ RequiredReadOnlySystemData The response of operation:'ExtensionTypes_LocationGet' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L116
    ⚠️ GetInOperationName 'GET' operation 'ExtensionTypes_LocationGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L122
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L202
    ⚠️ RequiredReadOnlySystemData The response of operation:'ExtensionTypes_GetVersion' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L233
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Extension Type Versions
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L240
    ⚠️ RequiredReadOnlySystemData The response of operation:'ExtensionTypes_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L359
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Extension Types
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L366
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L411
    ⚠️ GetInOperationName 'GET' operation 'ExtensionTypes_ClusterListVersions' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L417
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Extension Type Versions
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L418
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L456
    ⚠️ RequiredReadOnlySystemData The response of operation:'ExtensionTypes_ClusterGetVersion' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L487
    ⚠️ GetInOperationName 'GET' operation 'ExtensionTypes_ClusterGetVersion' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L493
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Extension Type Versions
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L494
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L547
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L549
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L550
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L554
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L621
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L622
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L643
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KubernetesConfiguration/preview/2023-05-01-preview/extensionTypes.json#L645


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L37
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L37
    ResourceNameRestriction The resource name parameter 'extensionName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L37
    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: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L163
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L208
    PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L260
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L271
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L296
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L296
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L348
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L348
    ResourceNameRestriction The resource name parameter 'extensionName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/extensions.json#L348
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L37
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L37
    ResourceNameRestriction The resource name parameter 'fluxConfigurationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L37
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L205
    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: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L229
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L274
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L293
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L293
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L345
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L345
    ResourceNameRestriction The resource name parameter 'fluxConfigurationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/fluxconfiguration.json#L345
    ResourceNameRestriction The resource name parameter 'clusterResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/kubernetesconfiguration.json#L37
    ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KubernetesConfiguration/stable/2023-05-01/kubernetesconfiguration.json#L37
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.KubernetesConfiguration' for api version '2023-05-01'. The supported api-versions are '2019-11-01-preview,
    2020-07-01-preview,
    2020-10-01-preview,
    2021-03-01,
    2021-05-01-preview,
    2021-06-01-preview,
    2021-09-01,
    2021-11-01-preview,
    2021-12-01-preview,
    2022-01-01-preview,
    2022-03-01,
    2022-11-01'."
    ️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]

    Tag package-2023-05; Prod region: Not deployed; Canary region: Not deployed

    ️️✔️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 21, 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/kubernetesconfiguration/armkubernetesconfiguration - Approved - 2.0.0
    +	Field `InstalledVersion` of struct `ExtensionProperties` has been removed
    azure-sdk-for-js - @azure/arm-kubernetesconfiguration - Approved - 6.0.0
    +	Interface Extension no longer has parameter installedVersion
    azure-sdk-for-python-track2 - track2_azure-mgmt-kubernetesconfiguration - Approved - 2.0.0
    +	Model ClusterScopeSettings no longer has parameter id
    +	Model ClusterScopeSettings no longer has parameter name
    +	Model ClusterScopeSettings no longer has parameter type
    +	Model Extension no longer has parameter installed_version
    +	Model ExtensionVersionList no longer has parameter versions
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 433f115. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-kubernetesconfiguration [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group PrivateEndpointConnectionsOperations
      info	[Changelog]   - Added operation group PrivateLinkResourcesOperations
      info	[Changelog]   - Added operation group PrivateLinkScopesOperations
      info	[Changelog]   - Model Extension has a new parameter current_version
      info	[Changelog]   - Model Extension has a new parameter is_system_extension
      info	[Changelog]   - Model Extension has a new parameter plan
      info	[Changelog]   - Model ExtensionType has a new parameter id
      info	[Changelog]   - Model ExtensionType has a new parameter name
      info	[Changelog]   - Model ExtensionType has a new parameter type
      info	[Changelog]   - Model ExtensionVersionList has a new parameter value
      info	[Changelog]   - Model FluxConfiguration has a new parameter azure_blob
      info	[Changelog]   - Model FluxConfiguration has a new parameter reconciliation_wait_duration
      info	[Changelog]   - Model FluxConfiguration has a new parameter wait_for_reconciliation
      info	[Changelog]   - Model FluxConfigurationPatch has a new parameter azure_blob
      info	[Changelog]   - Model KustomizationDefinition has a new parameter post_build
      info	[Changelog]   - Model KustomizationDefinition has a new parameter wait
      info	[Changelog]   - Model KustomizationPatchDefinition has a new parameter post_build
      info	[Changelog]   - Model KustomizationPatchDefinition has a new parameter wait
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model ClusterScopeSettings no longer has parameter id
      info	[Changelog]   - Model ClusterScopeSettings no longer has parameter name
      info	[Changelog]   - Model ClusterScopeSettings no longer has parameter type
      info	[Changelog]   - Model Extension no longer has parameter installed_version
      info	[Changelog]   - Model ExtensionVersionList no longer has parameter versions
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 433f115. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-kubernetesconfiguration [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 433f115. 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/kubernetesconfiguration/armkubernetesconfiguration [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `InstalledVersion` of struct `ExtensionProperties` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `SourceKindTypeAzureBlob` added to enum type `SourceKindType`
      info	[Changelog] - New struct `AzureBlobDefinition`
      info	[Changelog] - New struct `AzureBlobPatchDefinition`
      info	[Changelog] - New struct `ManagedIdentityDefinition`
      info	[Changelog] - New struct `ManagedIdentityPatchDefinition`
      info	[Changelog] - New struct `Plan`
      info	[Changelog] - New struct `PostBuildDefinition`
      info	[Changelog] - New struct `ServicePrincipalDefinition`
      info	[Changelog] - New struct `ServicePrincipalPatchDefinition`
      info	[Changelog] - New struct `SubstituteFromDefinition`
      info	[Changelog] - New field `Plan` in struct `Extension`
      info	[Changelog] - New field `CurrentVersion`, `IsSystemExtension` in struct `ExtensionProperties`
      info	[Changelog] - New field `AzureBlob` in struct `FluxConfigurationPatchProperties`
      info	[Changelog] - New field `AzureBlob`, `ReconciliationWaitDuration`, `WaitForReconciliation` in struct `FluxConfigurationProperties`
      info	[Changelog] - New field `PostBuild`, `Wait` in struct `KustomizationDefinition`
      info	[Changelog] - New field `PostBuild`, `Wait` in struct `KustomizationPatchDefinition`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 25 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 433f115. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-kubernetesconfiguration [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface AzureBlobDefinition
      info	[Changelog]   - Added Interface AzureBlobPatchDefinition
      info	[Changelog]   - Added Interface ManagedIdentityDefinition
      info	[Changelog]   - Added Interface ManagedIdentityPatchDefinition
      info	[Changelog]   - Added Interface Plan
      info	[Changelog]   - Added Interface PostBuildDefinition
      info	[Changelog]   - Added Interface ServicePrincipalDefinition
      info	[Changelog]   - Added Interface ServicePrincipalPatchDefinition
      info	[Changelog]   - Added Interface SubstituteFromDefinition
      info	[Changelog]   - Interface Extension has a new optional parameter currentVersion
      info	[Changelog]   - Interface Extension has a new optional parameter isSystemExtension
      info	[Changelog]   - Interface Extension has a new optional parameter plan
      info	[Changelog]   - Interface FluxConfiguration has a new optional parameter azureBlob
      info	[Changelog]   - Interface FluxConfiguration has a new optional parameter reconciliationWaitDuration
      info	[Changelog]   - Interface FluxConfiguration has a new optional parameter waitForReconciliation
      info	[Changelog]   - Interface FluxConfigurationPatch has a new optional parameter azureBlob
      info	[Changelog]   - Interface KustomizationDefinition has a new optional parameter postBuild
      info	[Changelog]   - Interface KustomizationDefinition has a new optional parameter wait
      info	[Changelog]   - Interface KustomizationPatchDefinition has a new optional parameter postBuild
      info	[Changelog]   - Interface KustomizationPatchDefinition has a new optional parameter wait
      info	[Changelog]   - Enum KnownSourceKindType has a new value AzureBlob
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface Extension no longer has parameter installedVersion
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 433f115. 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]
      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
    • ️✔️kubernetesconfiguration [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 433f115. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.kubernetesconfiguration.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.kubernetesconfiguration.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration https://apiview.dev/Assemblies/Review/95315835317f4e678a7230f645fc8482
    JavaScript @azure/arm-kubernetesconfiguration https://apiview.dev/Assemblies/Review/595c473ceb1c4e7f95df144b93ef64a8

    @openapi-workflow-bot
    Copy link

    Hi @bavneetsingh16, 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 @bavneetsingh16, 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, @bavneetsingh16, 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

    @bavneetsingh16
    Copy link
    Contributor Author

    bavneetsingh16 commented May 4, 2023

    @bavneetsingh16 - Please address the linter issues created by your PR https://github.com/Azure/azure-rest-api-specs/pull/23676/checks?check_run_id=12988971851
    Once you have fixed the linter errors, please remove the "ARMChangesRequested" label from the PR to make the PR visible to the ARM reviewers.

    @bavneetsingh16 Please fix the linter errors according to comments above. If you have changed, please remove the ARMChangesRequested label from the PR.

    I see that the linter CI check has actually succeeded and I only see the warnings listed. Can you please confirm if it is mandatory to address all of these warnings? Also, to note that they are all for preview api versions.

    @v-xuto
    Copy link
    Member

    v-xuto commented May 5, 2023

    @bavneetsingh16 - Please address the linter issues created by your PR https://github.com/Azure/azure-rest-api-specs/pull/23676/checks?check_run_id=12988971851
    Once you have fixed the linter errors, please remove the "ARMChangesRequested" label from the PR to make the PR visible to the ARM reviewers.

    @bavneetsingh16 Please fix the linter errors according to comments above. If you have changed, please remove the ARMChangesRequested label from the PR.

    I see that the linter CI check has actually succeeded and I only see the warnings listed. Can you please confirm if it is mandatory to address all of these warnings? Also, to note that they are all for preview api versions.

    @sjanamma Do these warnings need to be addressed?

    @v-xuto v-xuto removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 6, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 6, 2023
    @sjanamma sjanamma added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 6, 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 May 6, 2023
    @v-xuto
    Copy link
    Member

    v-xuto commented May 8, 2023

    @qiaozha Please help review JS breaking change.
    @raych1 Please help review Go breaking change.
    @msyyc Please help review Python breaking change.

    @v-xuto
    Copy link
    Member

    v-xuto commented May 10, 2023

    @qiaozha Please help review JS breaking change.
    @raych1 Please help review Go breaking change.

    1 similar comment
    @v-xuto
    Copy link
    Member

    v-xuto commented May 15, 2023

    @qiaozha Please help review JS breaking change.
    @raych1 Please help review Go breaking change.

    @bavneetsingh16
    Copy link
    Contributor Author

    @msyyc , can you please clarify why you removed the preview version from the python readme.md as we need it for our cli support. In this pr, we are introducing 2 api versions, '2023-05-01' and '2023-05-01-preview' and we need both of them in the sdk generated which after your changes has removed the preview version.

    @msyyc
    Copy link
    Member

    msyyc commented May 16, 2023

    @msyyc , can you please clarify why you removed the preview version from the python readme.md as we need it for our cli support. In this pr, we are introducing 2 api versions, '2023-05-01' and '2023-05-01-preview' and we need both of them in the sdk generated which after your changes has removed the preview version.

    Python multiapi package doesn't permit mix of preview and stable in one tag. Hers is recommended configuration: https://github.com/Azure/azure-rest-api-specs/pull/24002/files

    @raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label May 16, 2023
    @bavneetsingh16
    Copy link
    Contributor Author

    bavneetsingh16 commented May 16, 2023

    @msyyc, as I see it I previously had 2 seperate tags each for preview(package-preview-2023-05) and stable(package-2023-05) API version. I could see the 2 api versions in the sdk generated successfully. But the preview tag was removed by your commit in 60598e9.

    Can you please help clarify what was wrong with these 2 different tags for preview and stable API versions and if we need to push another commit to this pr with changes similar to yours?

    @msyyc
    Copy link
    Member

    msyyc commented May 17, 2023

    In python multiapi package, one subfolder shall only contain one kind of api-version. So tag-package-preview-2023-05 contains preview/2023-05-01-preview/extensionTypes.json with "2023-05-01-preview" and stable/2023-05-01/operations.json with "2023-05-01" is not recommended. Instead, tag-package-preview-2023-05-only is better. Now that "stable/2023-05-01/operations.json" is included in package-2023-05, there is no need to add it in preview tag for python

    @msyyc Yuchao Yan FTE, as I see it I previously had 2 seperate tags each for preview(package-preview-2023-05) and stable(package-2023-05) API version. I could see the 2 api versions in the sdk generated successfully. But the preview tag was removed by your commit in 60598e9.

    Can you please help clarify what was wrong with these 2 different tags for preview and stable API versions and if we need to push another commit to this pr with changes similar to yours?

    @v-xuto v-xuto added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 17, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python 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-BreakingChange-JavaScript CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.