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

[Hub Generated] Publish private branch 'prateekyadavMS-maintenance-prateek-Microsoft.Maintenance-2023-09-01-preview' #26185

Conversation

prateekyadavMS
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

@prateekyadavMS
Copy link
Contributor Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/14097

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 12 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
Maintenance.json 2023-09-01-preview(9e02b66) 2023-04-01(main)
Maintenance.json 2023-09-01-preview(9e02b66) 2022-11-01-preview(main)

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

Rule Message
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MaintenanceConfigurationOverrides' removed or renamed?
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2366:3
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L1777:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'softwareUpdateConfigurationTasks' removed or renamed?
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2366:3
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L1777:3
⚠️ 1011 - AddingResponseCode The new version adds a response code '201'.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L436:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '201'.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L511:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '201'.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L708:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '201'.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L968:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '201'.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1332:11
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'overrides' renamed or removed?
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2643:7
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L2006:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tasks' renamed or removed?
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2737:7
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L2105:7
⚠️ 1042 - ChangedParameterOrder The order of parameter 'providerName' was changed.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L121:9
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L121:9
⚠️ 1042 - ChangedParameterOrder The order of parameter 'resourceParentType' was changed.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L121:9
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L121:9
⚠️ 1042 - ChangedParameterOrder The order of parameter 'resourceParentName' was changed.
New: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L121:9
Old: Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json#L121:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 3 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2023-09 package-preview-2023-09(9e02b66) default(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L285
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L285
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L285


The following errors/warnings exist before current PR submission:

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

Rule Message
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L41
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1130
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1202
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1492
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1542
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1585
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1635
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L1678
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2187
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2272
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L2344
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L30
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L30
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L73
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L73
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L121
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L121
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L121
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L211
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L211
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L211
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L379
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L379
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L379
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L468
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L468
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L468
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L545
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L545
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json#L545
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking



️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fa64058. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    cmderr	[automation_init.sh] WARNING: There was an error checking the latest version of pip.
    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]
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-maintenance [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation ApplyUpdatesOperations.create_or_update_or_cancel
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from fa64058. 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/maintenance/armmaintenance [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `UpdateStatusCancel`, `UpdateStatusCancelled`, `UpdateStatusNoUpdatesPending` added to enum type `UpdateStatus`
    info	[Changelog] - New function `*ApplyUpdatesClient.CreateOrUpdateOrCancel(context.Context, string, string, string, string, string, ApplyUpdate, *ApplyUpdatesClientCreateOrUpdateOrCancelOptions) (ApplyUpdatesClientCreateOrUpdateOrCancelResponse, error)`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 4 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fa64058. 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] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.0` to update!
    cmderr	[initScript.sh] npm notice
    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
  • ️✔️maintenance [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from fa64058. 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.maintenance.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.maintenance.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 12, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/maintenance/armmaintenance https://apiview.dev/Assemblies/Review/bbea085fd05c48838cd264d3f6e1a4b3

@ms-zhenhua ms-zhenhua added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 12, 2023
@prateekyadavMS prateekyadavMS added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Oct 12, 2023
@prateekyadavMS prateekyadavMS requested review from KalpeshChavan12 and removed request for KalpeshChavan12 October 16, 2023 07:33
@prateekyadavMS prateekyadavMS removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Oct 16, 2023
@ms-zhenhua ms-zhenhua merged commit fa64058 into main Oct 16, 2023
29 of 31 checks passed
@ms-zhenhua ms-zhenhua deleted the published/Azure/azure-rest-api-specs-pr/prateekyadavMS-maintenance-prateek-Microsoft.Maintenance-2023-09-01-preview branch October 16, 2023 09:49
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
…ateek-Microsoft.Maintenance-2023-09-01-preview' (#26185)

* Adds base for updating Microsoft.Maintenance from version stable/2023-04-01 to version 2023-09-01-preview

* Updates readme

* Updates API version in new specs and examples

* example add

* Maintenance.json change for put

* changes

* changes

* 201 and 202

* Location + provisioning state

* Removed "404" and 409 due to NoErrorCodeResponses

* LroErrorContent

* Remove "202", provisioning state

* Adding all responses in examples

* "applyUpdate" not "ApplyUpdate"

* "status" not "Status"

* Example to cover VMSS with new version

* prettier changes on new example file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review 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.

5 participants