-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Storage RP 2022-09-01 Swagger Api version #21500
Conversation
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. vscswagger@microsoft.com |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @HimanshuChhabra, Your PR has some issues. Please fix the CI sequentially by following the order of
|
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 |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi, @HimanshuChhabra your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
specification/storage/resource-manager/Microsoft.Storage/stable/2022-09-01/storage.json
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes generally look good to me.
Only one comment for maxpagesize of list encryption scope.
@yifanz0 Do you see any issue when run the .net SDK generated from the swagger?
@blueww I've tried the SDK with the LCM changes and no issues are found so far |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
blob.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
blob.json | 2022-09-01(fb7cb60) | 2020-08-01-preview(main) |
common.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
common.json | 2022-09-01(fb7cb60) | 2020-08-01-preview(main) |
file.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
file.json | 2022-09-01(fb7cb60) | 2020-08-01-preview(main) |
privatelinks.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
privatelinks.json | 2022-09-01(fb7cb60) | 2020-08-01-preview(main) |
queue.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
queue.json | 2022-09-01(fb7cb60) | 2020-08-01-preview(main) |
storage.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
storage.json | 2022-09-01(fb7cb60) | 2020-08-01-preview(main) |
table.json | 2022-09-01(fb7cb60) | 2022-05-01(main) |
table.json | 2022-09-01(fb7cb60) | 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: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-09 | package-2022-09(fb7cb60) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L19 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L45 |
PathResourceTypeNameCamelCase |
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 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L58 |
ResourceNameRestriction |
The resource name parameter 'BlobServicesName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L58 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L102 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L139 |
GetCollectionResponseSchema |
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 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L149 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L204 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L217 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L217 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L261 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L297 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L297 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L313 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L354 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L391 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L401 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L401 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L442 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L452 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L452 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L490 |
ResourceNameRestriction |
The resource name parameter 'accountName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L500 |
ResourceNameRestriction |
The resource name parameter 'containerName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L500 |
ResourceNameRestriction |
The resource name parameter 'immutabilityPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Storage/stable/2022-09-01/blob.json#L500 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L550 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2022-09-01/blob.json#L603 |
DeleteOperationResponses |
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 succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 137 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 90, untested: 0, failed: 84, passed: 6
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
"statusCode: 400, errorCode: UnsupportedEdgeZone, errorMessage: Edge zone 'losangeles001' not found. The available edge zones in location 'westcentralus' are ''." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '400' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: PatchResourceNotFound, errorMessage: The resource '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-YVXcVq-21500/providers/Microsoft.Storage/storageAccounts/accountnam6u178f' was not found when evaluating policies for a PATCH operation." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnam6u178f' not found." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnam6u178f' not found." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Storage/storageAccounts/accountnam6u178f' under resource group 'apiTest-YVXcVq-21500' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnam6u178f' not found." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnam6u178f' not found." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnam6u178f' not found." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
CLIENT_ERROR |
"statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'accountnam6u178f' not found." |
INVALID_RESPONSE_CODE |
"The swagger file does not define '404' response code" |
️❌
~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
* Full copy from 2022-05-01 to 2022-09-01 without any changes * Update Swagger API version for each swagger and readme files * Update the API version for existing Test cases * Feature: Storage Account Soft Failover * Feature: List Encryption scopes, add OData Filter Conditions * Feature : Add TierToCold and TierToHot Support * Run Prettier check * Adding Location header to EXISTING Async API Examples. * Run Prettier check * Change $maxpagesize to integer type for ListEncryptionScope API
* Full copy from 2022-05-01 to 2022-09-01 without any changes * Update Swagger API version for each swagger and readme files * Update the API version for existing Test cases * Feature: Storage Account Soft Failover * Feature: List Encryption scopes, add OData Filter Conditions * Feature : Add TierToCold and TierToHot Support * Run Prettier check * Adding Location header to EXISTING Async API Examples. * Run Prettier check * Change $maxpagesize to integer type for ListEncryptionScope API
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.