StorageCache 2023 01 01 API #22056
Closed
StorageCache 2023 01 01 API #22056
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
…2-05-01 to version 2023-01-01
|
Hi, @rebecca337 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 |
|
Hi, @rebecca337 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| storagecache.json | 2023-01-01(03972d9) | 2022-05-01(main) |
| storagecache.json | 2023-01-01(03972d9) | 2019-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L554:11 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L518:7 Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L508:7 |
| The '$ref' property points to different models in the old and new versions. New: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L3351:9 Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L3132:9 |
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-2023-01 | package-2023-01(03972d9) | 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 |
|---|---|
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L305 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L350 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L351 |
|
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-01-01/storagecache.json#L351 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L451 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L493 |
|
A 202 response should include an Location response header. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L493 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L538 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L538 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L538 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L593 |
|
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-01-01/storagecache.json#L594 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L655 |
|
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-01-01/storagecache.json#L656 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L717 |
|
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-01-01/storagecache.json#L718 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L779 |
|
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-01-01/storagecache.json#L780 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L841 |
|
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-01-01/storagecache.json#L842 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L903 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L951 |
|
Tracked resource 'StorageTarget' must have patch operation that at least supports the update of tags. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L951 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L952 |
|
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-01-01/storagecache.json#L952 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1065 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1110 |
|
A 202 response should include an Location response header. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1110 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2023-01-01/storagecache.json#L1139 |
|
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-01-01/storagecache.json#L1140 |
️️✔️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.StorageCache' for api version '2023-01-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'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @rebecca337, 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. |
|
Hi, @rebecca337, 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 |
This was referenced Jan 4, 2023
v4 types are current and recommended. Comment applies throughout. Refers to: specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-01-01/storagecache.json:530 in 03972d9. [](commit_id = 03972d9, deletion_comment = False) |
You don't need to declare headers in the API spec. Comment applies throughout. Refers to: specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-01-01/storagecache.json:375 in 03972d9. [](commit_id = 03972d9, deletion_comment = False) |
|
@rebecca337 - I didn't see any breaking changes so I went ahead with ARM review. You may need to investigate why breaking change review required label was applied. @leni-msft, any idea? I also noticed the CI-MissingBaseCommit appears to be incorrectly applied, maybe related to the breaking change detection? |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
|
@mentat9 Regarding the comment about the "headers" in the API spec. We have "headers" tag in our previous API version that was approved. Are you saying this is incorrect? Do we remove all "headers" and the "location"/"azure-async-operation" tags? |
No, it's not incorrect. We have actually just been discussing what the guidance for header declarations should be. For now, we are recommending including it for async APIs as you have done (although it's not required), so feel free to ignore my comment. |
The breaking change review required label was added because of the 2 errors detected in "Cross-Version breaking changes". +@ruowan to help check why CI-MissingBaseCommit was added. |
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.