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] Add 200 OK to PATCH apis #18977

Conversation

jonathan-innis
Copy link
Contributor

@jonathan-innis jonathan-innis commented May 9, 2022

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

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. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

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

@openapi-workflow-bot
Copy link

Hi, @jonathan-innis 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 May 9, 2022

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.KubernetesConfiguration/stable/2022-03-01/extensions.json#L271:11
    1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L211:11
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceDelete
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/extensions.json#L192
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceDelete
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L264
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceDelete
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L264
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: insecure
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L568
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: insecure
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L568
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: insecure
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L614
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: insecure
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L614
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: prune
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L687
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: prune
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L687
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L692
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L692
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: prune
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L736
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: prune
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L736
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L741
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force
    Location: Microsoft.KubernetesConfiguration/stable/2022-03-01/fluxconfiguration.json#L741
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 9, 2022

    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-track2 - armkubernetesconfiguration - 0.5.1
    azure-sdk-for-python-track2 - track2_azure-mgmt-kubernetesconfiguration - 2.0.0
    ️✔️azure-sdk-for-go - kubernetesconfiguration/mgmt/2022-03-01/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - kubernetesconfiguration/mgmt/2021-09-01/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - kubernetesconfiguration/mgmt/2021-03-01/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2022-04-02-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2022-01-15-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2022-01-01-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2021-11-01-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2021-05-01-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2020-10-01-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2020-07-01-preview/kubernetesconfiguration - v64.0.0
    ️✔️azure-sdk-for-go - preview/kubernetesconfiguration/mgmt/2019-11-01-preview/kubernetesconfiguration - v64.0.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 62dc786. 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
    • ️✔️track2_azure-mgmt-kubernetesconfiguration [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      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 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]
      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 ExtensionVersionList no longer has parameter versions
      info	[Changelog]   - Removed operation OperationStatusOperations.list
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 62dc786. 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
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    • ️✔️azure-resourcemanager-kubernetesconfiguration [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 62dc786. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️kubernetesconfiguration/mgmt/2022-03-01/kubernetesconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️kubernetesconfiguration/mgmt/2021-09-01/kubernetesconfiguration [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️kubernetesconfiguration/mgmt/2021-03-01/kubernetesconfiguration [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/kubernetesconfiguration/mgmt/2022-04-02-preview/kubernetesconfiguration [View full logs
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New field `SystemData` in struct `ResourceModelWithAllowedPropertySet`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
    • ️✔️preview/kubernetesconfiguration/mgmt/2022-01-15-preview/kubernetesconfiguration [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/kubernetesconfiguration/mgmt/2022-01-01-preview/kubernetesconfiguration [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/kubernetesconfiguration/mgmt/2021-11-01-preview/kubernetesconfiguration [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/kubernetesconfiguration/mgmt/2021-05-01-preview/kubernetesconfiguration [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/kubernetesconfiguration/mgmt/2020-10-01-preview/kubernetesconfiguration [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/kubernetesconfiguration/mgmt/2020-07-01-preview/kubernetesconfiguration [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    • ️✔️preview/kubernetesconfiguration/mgmt/2019-11-01-preview/kubernetesconfiguration [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 62dc786. 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
    • ️✔️armkubernetesconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 62dc786. 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
      cmderr	[automation_init.sh]  read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh]  @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 62dc786. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]  old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    • ️✔️kubernetesconfiguration [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 62dc786. 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.SourceControlConfiguration [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @jonathan-innis, 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 @jonathan-innis, 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.

    @jonathan-innis
    Copy link
    Contributor Author

    @jianyexi We are making the change to add 200 to our PATCH apis as this is already being returned in our service but is not documented correctly in our Swagger. This PR is to fix the documentation to be up-to-date with the service and to fix S360 Swagger Correctness errors.

    @jianyexi
    Copy link
    Contributor

    @jonathan-innis could you please follow the #18977 (comment) to get approval , this is required duing PR review

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 11, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    …8977)
    
    * Add response codes to patch apis
    
    * Examples for patch of extension and configuration
    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 FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants