[Hub Generated] Review request for Microsoft.StorageSync to add version stable/2022-09-01 #26082
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| types.json | 4.0(e935be8) | 4.0(main) |
️❌Breaking Change(Cross-Version): 84 Errors, 240 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| storagesync.json | 2022-09-01(e935be8) | 2022-06-01(main) |
| storagesync.json | 2022-09-01(e935be8) | 2017-06-05-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 28 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 28 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(e935be8) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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.StorageSync/stable/2022-09-01/storagesync.json#L3608 |
||
| 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.StorageSync/stable/2022-09-01/storagesync.json#L3796 |
||
| 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.StorageSync/stable/2022-09-01/storagesync.json#L3806 |
||
| 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.StorageSync/stable/2022-09-01/storagesync.json#L4396 |
||
| 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.StorageSync/stable/2022-09-01/storagesync.json#L4426 |
||
| 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.StorageSync/stable/2022-09-01/storagesync.json#L4618 |
The following errors/warnings exist before current PR submission:
Only 28 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.StorageSync/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L43 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L44 |
|
The resource name parameter 'locationName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L70 |
|
The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L125 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L126 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'StorageSyncServices_Create' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L126 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L126 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L199 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L341 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L347 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L421 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L454 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L503 |
|
The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L529 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L558 |
|
The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L571 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L571 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L615 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L615 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L687 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L693 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L756 |
|
The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L763 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L796 |
|
The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L822 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L855 |
|
The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L881 |
|
The resource name parameter 'syncGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L881 |
️️✔️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]
Swagger Generation Artifacts
|
Generated ApiView
|
ankushbindlish2
changed the title
AzureRestAPISpecReview
added
ARMReview
new-api-version
resource-manager
WaitForARMFeedback
This was referenced Oct 4, 2023
This was referenced Oct 4, 2023
cd D:\code\azure-rest-api-specs\specification\storagesync npm install npx prettier --check **/*.json npx prettier --write **/*.json
D:\code\azure-rest-api-specs\specification\storagesync>oav validate-example D:\code\azure-rest-api-specs\specification\storagesync\resource-manager\Microsoft.StorageSync\stable\2022-09-01\storagesync.json Issues : Casing in properties Identity request and response type incorrect property name
AzureRestAPISpecReview
added
ARMChangesRequested
|
/pr RequestMerge |
jlindamood
approved these changes
Oct 11, 2023
ankushbindlish2
removed
CI-BreakingChange-Python-Track2
CI-BreakingChange-Go
CI-BreakingChange-JavaScript
ARMReview
BreakingChangeReviewRequired
|
/pr RequestMerge |
openapi-pipeline-app
bot
added
ARMReview
CI-BreakingChange-Python-Track2
CI-BreakingChange-Go
CI-BreakingChange-JavaScript
and removed
CI-BreakingChange-Go
labels
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
/pr RequestMerge |
ms-zhenhua
approved these changes
Oct 11, 2023
ms-zhenhua
deleted the
ankushbindlish2-storagesync-Microsoft.StorageSync-2022-09-01-October
branch
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Oct 11, 2023
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
…on stable/2022-09-01 (#26082) * Adds base for updating Microsoft.StorageSync from version stable/2022-06-01 to version 2022-09-01 * Updates readme * Updates API version in new specs and examples * Update 2022-09-01 Api version with Managed IDentity and FAst Drv2 features * prettier fix cd D:\code\azure-rest-api-specs\specification\storagesync npm install npx prettier --check **/*.json npx prettier --write **/*.json * Model Validation Fix D:\code\azure-rest-api-specs\specification\storagesync>oav validate-example D:\code\azure-rest-api-specs\specification\storagesync\resource-manager\Microsoft.StorageSync\stable\2022-09-01\storagesync.json Issues : Casing in properties Identity request and response type incorrect property name * Location header name fix * Linter fixes * Update storagesync.json * Fix Identity and useidentity linter errors * Update RegisteredServers_Update.json * Update * Fix x-ms-identifiers * Updating identity to put server to unblock sdk build * Update storagesync.json * revert * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update storagesync.json * Update * update * Update storagesync.json * Update storagesync.json
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
[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
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto 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 helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
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:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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 ApiViewcomment 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
and https://aka.ms/ci-fix.