Storage RP 2022-09-01 Swagger API Spec #21442
Closed
Conversation
This file contains hidden or 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
|
Hi, @HimanshuChhabra Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| blob.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| blob.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
| common.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| common.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
| file.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| file.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
| privatelinks.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| privatelinks.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
| queue.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| queue.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
| storage.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| storage.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
| table.json | 2022-09-01(64a8849) | 2022-05-01(main) |
| table.json | 2022-09-01(64a8849) | 2020-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 11 Errors, 6 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(64a8849) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{accountMigrationName} has different responses for PUT/GET/PATCH operations. The PUT/GET/PATCH operations must have same schema response. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L896 |
|
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L896 |
|
|
The resource name parameter 'accountMigrationName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L896 |
|
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L896 |
|
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Storage/stable/2022-09-01/storage.json#L940 |
|
|
An async PUT operation must return 201. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L977 |
|
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L981 |
|
|
A 202 response should include an Location response header. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L981 |
|
|
The schema 'StorageAccountMigration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L5491 |
|
|
The nested resource 'StorageAccountMigration' does not have list operation, please add it. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L5491 |
|
|
The schema 'StorageAccountMigrationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L5508 |
|
| 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: 'AccountMigrations_Put' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.Storage/stable/2022-09-01/storage.json#L940 |
||
| 'PUT' operation 'AccountMigrations_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Storage/stable/2022-09-01/storage.json#L944 |
||
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'AccountMigrations_Put', Response code: '200' Location: Microsoft.Storage/stable/2022-09-01/storage.json#L978 |
||
| 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.Storage/stable/2022-09-01/storage.json#L3937 |
||
| 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.Storage/stable/2022-09-01/storage.json#L3942 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Storage/stable/2022-09-01/storage.json#L5493 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L19 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L45 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L58 |
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L58 |
|
The resource name parameter 'BlobServicesName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L58 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L102 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L139 |
|
The response in the GET collection operation 'BlobContainers_List' does not match the response definition in the individual GET operation 'BlobContainers_Get' . Location: Microsoft.Storage/stable/2022-09-01/blob.json#L149 |
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L149 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L204 |
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L217 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L217 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L261 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L297 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L297 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L313 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L354 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L391 |
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L401 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L401 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L442 |
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L452 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L452 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L490 |
|
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L500 |
|
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L500 |
|
The resource name parameter 'immutabilityPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L500 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L550 |
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L603 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L656 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Storage' for api version '2022-09-01'. The supported api-versions are '2022-05-01, 2021-09-01, 2021-08-01, 2021-06-01, 2021-05-01, 2021-04-01, 2021-02-01, 2021-01-01, 2020-08-01-preview, 2019-06-01, 2019-04-01, 2018-11-01, 2018-07-01, 2018-03-01-preview, 2018-02-01, 2017-10-01, 2017-06-01, 2016-12-01, 2016-05-01, 2016-01-01, 2015-06-15, 2015-05-01-preview'." |
️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]
️❌ModelValidation: 10 Errors, 0 Warnings failed [Detail]
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
resource-manager
WaitForARMFeedback
|
Hi @HimanshuChhabra, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Nov 7, 2022
Closed
HimanshuChhabra
requested review from
msyyc,
Wzb123456789 and
ArcturusZhang
as code owners
|
Hi, @HimanshuChhabra, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
…sion 2022-09-01 (new validation added by the OAV tool)
blueww
reviewed
Nov 9, 2022
| @@ -5530,6 +5540,9 @@ | |||
| } | |||
| } | |||
| }, | |||
| "required": [ | |||
There was a problem hiding this comment.
If we add "targetRegion" support in the future, will "targetSkuName" still be required? (Since with before parameter description, seems the 2 parameters can't be used together.)
Please note it will be breaking change to change a required parameter to optional, and will need Azure’s Breaking Change Review Board review. See details in the last page of Breaking Change Policy
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Created a new PR - #21500 |
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.