-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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.StorageCache to add version stable/2023-05-01 #23563
[Hub Generated] Review request for Microsoft.StorageCache to add version stable/2023-05-01 #23563
Conversation
Hi, @tibanyas 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 Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
amlfilesystem.json | 2023-05-01(c9fec1c) | 2023-03-01-preview(main) |
storagecache.json | 2023-05-01(c9fec1c) | 2023-01-01(main) |
storagecache.json | 2023-05-01(c9fec1c) | 2023-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 3 Errors, 2 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-05 | package-2023-05(c9fec1c) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
LongRunningResponseStatusCode |
A 'delete' operation 'amlFilesystems_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json#L126 |
RPC-Async-V1-01 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json#L320 |
RPC-Patch-V1-11 |
PatchSkuProperty |
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json#L320 |
RPC-Patch-V1-09 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json#L633 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json#L761 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L297 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L342 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L343 |
LongRunningResponseStatusCode |
A 'delete' operation 'Caches_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L343 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L443 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L486 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L486 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L531 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L531 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L531 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L586 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L587 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L648 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L649 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L710 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L711 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L772 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L773 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L834 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L835 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L896 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L944 |
TrackedResourcePatchOperation |
Tracked resource 'StorageTarget' must have patch operation that at least supports the update of tags. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L944 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L945 |
LongRunningResponseStatusCode |
A 'delete' operation 'StorageTargets_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L945 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L1058 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L1104 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L1104 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L1133 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-05-01/storagecache.json#L1134 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.StorageCache' for api version '2023-05-01'. The supported api-versions are '2019-08-01-preview, 2019-11-01, 2020-03-01, 2020-10-01, 2021-03-01, 2021-05-01, 2021-09-01, 2021-10-01-preview, 2021-11-01-preview, 2022-01-01, 2022-05-01, 2022-09-01-preview, 2023-01-01, 2023-03-01-preview'." |
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @tibanyas, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Breaking changes previously reviewed and approved in #19724 |
This PR is for the new 2023-05-01 stable API version for Microsoft.StorageCache and is based off of the Approved 2023-03-01-preview API version. The most recent stable API version is 2023-01-01, and the main difference between 2023-03-01-preview and 2023-01-01 is the support for the amlFilesystem resource, which went public preview with the 2023-03-01-preview API version. The amlFilesystem resource is planning to go GA with the 2023-05-01 API version and this is the main difference with the most recent stable API version (2023-01-01). After creating 2023-05-01, based off of 2023-03-01-preview, the following changes were made: 1. Remove reference to scalingFactor and scalableSkus from storageCache.json and associated examples.
2. Added a new clientInfo structure in amlfilesystem.json.
Link to Breaking Changes Scenario work item: https://msazure.visualstudio.com/One/_workitems/edit/17974426 Note Regarding Commits:
|
The Swagger LintDiff errors were all present and noted in our previous review for 2023-03-01-preview; see this PR: They were all noted and approved at that time. Nothing is new here related to LintDiff |
@tibanyas do your service has plan to resolve all the lint error? We bypassed the lint error based on the promise that service will handle them in next version. |
SDK breaking changes is possibly from m4 bug. Need to handle when SDK release. @MaryGao |
} | ||
} | ||
}, | ||
"AmlFilesystemUpdate": { |
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.
Track resource update must be able to update sku along with tags
https://github.com/Azure/azure-openapi-validator/blob/main/docs/patch-sku-property.md
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.
@sjanamma ,
A SKU cannot be modified in our service; this is intentional. We have it's mutability classified accordingly as shown below:
"SkuName": {
"x-ms-mutability": [
"read",
"create"
],
You are introducing a new version and breaking changes have been approved. This is the good opportunity for you to address the LintDiff issues |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Regarding the LintDiff errors, The following errors/warnings are false alarms:
The other two errors listed are:
As is the case with Sku, our service doesn't support modifying the Identity object, and we have its mutability classified accordingly as shown below: "AmlFilesystemIdentity": { Thanks, |
…ion stable/2023-05-01 (Azure#23563) * Adds base for updating Microsoft.StorageCache from version preview/2023-03-01-preview to version 2023-05-01 * Updates readme * Updates API version in new specs and examples * Update files with new API changes * Fix Lint Errors * Fix SpellCheck and PrettierCheck Errors
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.