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] Review request for Microsoft.Batch to add version stable/2023-05-01 #25564

Merged
merged 2 commits into from
Sep 14, 2023

Conversation

wiboris
Copy link
Member

@wiboris wiboris commented Aug 28, 2023

Get responses to contain values that the Put requests did not have that got identified by S360 https://openapihub.azure-devex-tools.com/amekpis/correctness/detail?errorId=95CCEFF6-39EC-450A-8C82-E94C9382B314

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, per this wiki doc.)
  • 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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 28, 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 Aug 28, 2023

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
BatchManagement.json 2023-05-01(73f8081) 2023-05-01(main)
Rule Message
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4925:9
Old: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4923:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4364:9
Old: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4363:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L5492:9
Old: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L5487:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4177:9
Old: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4177:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4973:9
Old: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L4970:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L5122:9
Old: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L5118:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-2023-05 package-2023-05(73f8081) package-2023-05(main)

The following errors/warnings exist before current PR submission:

Rule Message
⚠️ RequiredReadOnlySystemData The response of operation:'BatchAccount_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L38
⚠️ RequiredReadOnlySystemData The response of operation:'BatchAccount_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L124
⚠️ RequiredReadOnlySystemData The response of operation:'BatchAccount_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L231
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'syncautostoragekeys' in:'BatchAccount_SynchronizeAutoStorageKeys'. Consider updating the operationId
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L361
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'regeneratekeys' in:'BatchAccount_RegenerateKey'. Consider updating the operationId
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L400
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listkeys' in:'BatchAccount_GetKeys'. Consider updating the operationId
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L452
⚠️ RequiredReadOnlySystemData The response of operation:'Application_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L548
⚠️ RequiredReadOnlySystemData The response of operation:'Application_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L643
⚠️ RequiredReadOnlySystemData The response of operation:'Application_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L686
⚠️ RequiredReadOnlySystemData The response of operation:'ApplicationPackage_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L740
⚠️ RequiredReadOnlySystemData The response of operation:'ApplicationPackage_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L841
⚠️ RequiredReadOnlySystemData The response of operation:'Certificate_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1323
⚠️ RequiredReadOnlySystemData The response of operation:'Certificate_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1403
⚠️ RequiredReadOnlySystemData The response of operation:'Certificate_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1533
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'canceldelete' in:'Certificate_CancelDeletion'. Consider updating the operationId
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1594
⚠️ RequiredReadOnlySystemData The response of operation:'BatchAccount_GetDetector' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1684
⚠️ RequiredReadOnlySystemData The response of operation:'PrivateLinkResource_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1779
⚠️ RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnection_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1877
⚠️ RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnection_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L1920
⚠️ RequiredReadOnlySystemData The response of operation:'Pool_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L2127
⚠️ RequiredReadOnlySystemData The response of operation:'Pool_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L2226
⚠️ RequiredReadOnlySystemData The response of operation:'Pool_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Batch/stable/2023-05-01/BatchManagement.json#L2361
️️✔️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 Aug 28, 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-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 7a7ee13. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.Batch [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 7a7ee13. 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 major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-batch [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 7a7ee13. 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.2.1
    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.2.1
    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-batch [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 7a7ee13. 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/batch/armbatch [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 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 7a7ee13. 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
    cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
  • ️✔️@azure/arm-batch [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 7a7ee13. 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.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.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
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from 7a7ee13. 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.batch.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.batch.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 28, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/batch/armbatch https://apiview.dev/Assemblies/Review/2679d4afe85042838d6899fe93289232
.Net Azure.ResourceManager.Batch There is no API change compared with the previous version
JavaScript @azure/arm-batch There is no API change compared with the previous version
Java azure-resourcemanager-batch There is no API change compared with the previous version

@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Aug 28, 2023
@wiboris wiboris marked this pull request as ready for review August 28, 2023 23:02
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels Aug 28, 2023
@openapi-workflow-bot
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 11, 2023
@wiboris wiboris removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 11, 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 Sep 11, 2023
@wiboris
Copy link
Member Author

wiboris commented Sep 11, 2023

/pr RequestMerge

@rkmanda
Copy link
Member

rkmanda commented Sep 12, 2023

You are at step 2. Its too early for you to request a merge. Please request a merge once you get to step 4

@wiboris
Copy link
Member Author

wiboris commented Sep 13, 2023

@rkmanda I got the approval from the SDK team for the breaking change. two days ago [JeffreyRichter] added the Approved-BreakingChange. I though this would put me at stage 4

@TimLovellSmith TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 14, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 14, 2023
@TimLovellSmith
Copy link
Member

In hindsight, this might not have really needed ARM review. But anyway, signed it off now.

@TimLovellSmith
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@TimLovellSmith TimLovellSmith merged commit 7a7ee13 into main Sep 14, 2023
29 of 30 checks passed
@TimLovellSmith TimLovellSmith deleted the wiboris-batch-Microsoft.Batch-2023-05-01 branch September 14, 2023 16:55
@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
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 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 FixS360 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.

6 participants