Skip to content

Conversation

@wiboris
Copy link
Member

@wiboris wiboris commented Jun 20, 2024

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

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

spec_pr_review_workflow_diagram

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 20, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 20, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 32 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.9) new version base version
BatchService.json 2024-07-01(f593020) 2024-02-01.19.0(main)

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

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

Rule Message
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'applicationLicenses' renamed or removed?
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L12615:7
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L12325:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'applicationLicenses' renamed or removed?
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L14955:7
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L14619:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'applicationLicenses' renamed or removed?
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L14693:7
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L14349:7
1034 - AddedRequiredProperty The new version has new required property 'deallocated' that was not found in the old version.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L17718:7
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L17254:7
1034 - AddedRequiredProperty The new version has new required property 'deallocating' that was not found in the old version.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L17718:7
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L17254:7
1034 - AddedRequiredProperty The new version has new required property 'deallocated, deallocating' that was not found in the old version.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L17702:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L17238:9
1034 - AddedRequiredProperty The new version has new required property 'deallocated, deallocating' that was not found in the old version.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L17706:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L17242:9
1034 - AddedRequiredProperty The new version has new required property 'deallocated, deallocating' that was not found in the old version.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L17716:5
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L17252:5
1042 - ChangedParameterOrder The order of parameter 'timeout' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'client-request-id' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'return-client-request-id' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'ocp-date' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'If-Match' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'If-None-Match' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'If-Modified-Since' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'If-Unmodified-Since' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L2681:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L2681:9
1042 - ChangedParameterOrder The order of parameter 'timeout' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'client-request-id' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'return-client-request-id' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'ocp-date' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'If-Match' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'If-None-Match' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'If-Modified-Since' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'If-Unmodified-Since' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L3617:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L3606:9
1042 - ChangedParameterOrder The order of parameter 'timeout' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L4039:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L4019:9
1042 - ChangedParameterOrder The order of parameter 'client-request-id' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L4039:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L4019:9
1042 - ChangedParameterOrder The order of parameter 'return-client-request-id' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L4039:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L4019:9
1042 - ChangedParameterOrder The order of parameter 'ocp-date' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L4039:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L4019:9
1042 - ChangedParameterOrder The order of parameter 'If-Match' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L4039:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L4019:9
1042 - ChangedParameterOrder The order of parameter 'If-None-Match' was changed.
New: Microsoft.Batch/stable/2024-07-01/BatchService.json#L4039:9
Old: Microsoft.Batch/stable/2024-02-01.19.0/BatchService.json#L4019:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️️✔️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.
️️✔️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 Jun 20, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 20, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger Microsoft.Batch https://apiview.dev/Assemblies/Review/85a2658fa59441d2bfe325d29d1d9b90?revisionId=84504debc61f4c03b4f0d31c3d75f3db

@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jun 20, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Jun 21, 2024
@wiboris wiboris force-pushed the release-batch-Microsoft.Batch/2024-07-01 branch 3 times, most recently from 657f0a7 to e3e1df7 Compare June 21, 2024 19:14
@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jun 21, 2024
@wiboris wiboris force-pushed the release-batch-Microsoft.Batch/2024-07-01 branch from 581782f to f593020 Compare June 21, 2024 19:36
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Jul 8, 2024
@wiboris wiboris force-pushed the release-batch-Microsoft.Batch/2024-07-01 branch from f785495 to 045d8e9 Compare July 16, 2024 17:33
@wiboris wiboris force-pushed the release-batch-Microsoft.Batch/2024-07-01 branch from 7731e7c to 585de04 Compare July 16, 2024 21:08
@mikekistler mikekistler linked an issue Jul 16, 2024 that may be closed by this pull request
@mikekistler mikekistler added the BreakingChange-Approved-UserImpact Changes are not backward compatible and may cause customer disruption. label Jul 17, 2024
@mikekistler mikekistler requested a review from johanste July 17, 2024 02:10
@wiboris wiboris requested a review from dpwatrous July 17, 2024 02:22
@wiboris wiboris added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Jul 17, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Aug 5, 2024
@wiboris wiboris removed the no-recent-activity There has been no recent activity on this issue. label Aug 5, 2024
@wiboris wiboris force-pushed the release-batch-Microsoft.Batch/2024-07-01 branch from 500abfe to 04c1fee Compare August 8, 2024 00:06
@wiboris wiboris requested a review from wanghoppe August 8, 2024 17:24
@johanste johanste added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Aug 9, 2024
@wiboris wiboris force-pushed the release-batch-Microsoft.Batch/2024-07-01 branch from 2b4ef5a to 9adcdcd Compare August 15, 2024 06:14
@wiboris
Copy link
Member Author

wiboris commented Aug 15, 2024

Suppression Justification: This PR adds a LroExtension suppression because there were two new apis added, /pools/{poolId}/nodes/{nodeId}/start and /pools/{poolId}/nodes/{nodeId}/deallocate, which return 202 without having a x-ms-long-running-operation: true. These 2 new api follow the same pattern as 14 other existing api's in this service so it was a case of this services design forces this behavior.

@wiboris wiboris merged commit 87b8cd5 into main Aug 20, 2024
@wiboris wiboris deleted the release-batch-Microsoft.Batch/2024-07-01 branch August 20, 2024 18:29
wanghoppe added a commit to Azure/azure-sdk-for-js that referenced this pull request Aug 30, 2024
### Packages impacted by this PR
@azure/batch

### Issues associated with this PR
N/A

### Describe the problem that is addressed by this PR
Release a new version of JS SDK according to Azure Batch's new API
version (2024-07-01)

### What are the possible designs available to address the problem? If
there are more than one possible design, why was the one in this PR
chosen?
N/A\

### Are there test cases added in this PR? _(If not, why?)_
Yes

### Provide a list of related PRs _(if any)_
Spec PR: Azure/azure-rest-api-specs#29533

### Command used to generate this PR:**_(Applicable only to SDK release
request PRs)_

### Checklists
- [ ] Added impacted package name to the issue description
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [ ] Added a changelog (if necessary)

---------

Co-authored-by: Hoppe Wang <[email protected]>
cheukchuen pushed a commit that referenced this pull request Jan 24, 2025
* Base commit (data plane)

* 2024-07-01 updates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. Approved-Suppression Batch BreakingChange-Approved-UserImpact Changes are not backward compatible and may cause customer disruption. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers. SuppressionReviewRequired

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Azure Batch - Batch] API Review

7 participants