Azure
Microsoft storage cache api 2023 01 01
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:
- What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. End of January 2023
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. End of January 2023
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[x] 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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.
-
[x] 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.
Hi, @rebecca337 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @rebecca337 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Swagger Validation Report
️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| storagecache.json | 2022-01-01(eef50a2) | 2022-01-01(main) |
| storagecache.json | 2022-05-01(eef50a2) | 2022-05-01(main) |
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L554:11 |
|
The new version adds a response code '202'. New: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L554:11 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L518:7 Old: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L508:7 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L518:7 Old: Microsoft.StorageCache/stable/2022-05-01/storagecache.json#L508:7 |
️❌Breaking Change(Cross-Version): 4 Errors, 52 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| storagecache.json | 2023-01-01(eef50a2) | 2022-05-01(main) |
| storagecache.json | 2023-01-01(eef50a2) | 2019-08-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:
Only 25 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-05 | package-2022-05(eef50a2) | package-2022-05(main) |
| package-2022-01 | package-2022-01(eef50a2) | package-2022-01(main) |
| package-2023-01 | package-2023-01(eef50a2) | default(main) |
The following errors/warnings exist before current PR submission:
Only 25 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L305 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-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/2022-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/2022-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/2022-01-01/storagecache.json#L451 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L493 |
|
A 202 response should include an Location response header. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L493 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L538 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L538 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L538 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-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/2022-01-01/storagecache.json#L594 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-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/2022-01-01/storagecache.json#L656 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-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/2022-01-01/storagecache.json#L718 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-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/2022-01-01/storagecache.json#L780 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-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/2022-01-01/storagecache.json#L842 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L903 |
|
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2022-01-01/storagecache.json#L951 |
|
Tracked resource 'StorageTarget' must have patch operation that at least supports the update of tags. Location: Microsoft.StorageCache/stable/2022-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/2022-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/2022-01-01/storagecache.json#L952 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[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]
️❌ModelValidation: 28 Errors, 0 Warnings failed [Detail]
Only 25 items are listed, please refer to log for more details.
️️✔️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.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/storagecache/armstoragecache - Approved - 3.0.0+ Operation `*CachesClient.Update` has been changed to LRO, use `*CachesClient.BeginUpdate` instead. + Struct `CloudError` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-storagecache - Approved - 1.4.0b1+ Renamed operation CachesOperations.update to CachesOperations.begin_update
❌azure-sdk-for-js - @azure/arm-storagecache - Approved - 6.0.0+ Interface CachesCreateOrUpdateOptionalParams no longer has parameter cache + Interface StorageTargetsCreateOrUpdateOptionalParams no longer has parameter storagetarget + Operation Caches.beginCreateOrUpdate has a new signature + Operation Caches.beginCreateOrUpdateAndWait has a new signature + Operation StorageTargets.beginCreateOrUpdate has a new signature + Operation StorageTargets.beginCreateOrUpdateAndWait has a new signature + Removed operation Caches.update
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-storagecache [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation StorageTargetsOperations.begin_restore_defaults info [Changelog] - Model BlobNfsTarget has a new parameter verification_timer info [Changelog] - Model BlobNfsTarget has a new parameter write_back_timer info [Changelog] - Model Nfs3Target has a new parameter verification_timer info [Changelog] - Model Nfs3Target has a new parameter write_back_timer info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Renamed operation CachesOperations.update to CachesOperations.begin_update
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 672 | [0m [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.StorageCache [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.StorageCache/Debug/netstandard2.0/Azure.ResourceManager.StorageCache.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/storagecache/Azure.ResourceManager.StorageCache/src/Azure.ResourceManager.StorageCache.csproj::TargetFramework=netstandard2.0]
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-storagecache [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/storagecache/armstoragecache [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Operation `*CachesClient.Update` has been changed to LRO, use `*CachesClient.BeginUpdate` instead. info [Changelog] - Struct `CloudError` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New function `*StorageTargetsClient.BeginRestoreDefaults(context.Context, string, string, string, *StorageTargetsClientBeginRestoreDefaultsOptions) (*runtime.Poller[StorageTargetsClientRestoreDefaultsResponse], error)` info [Changelog] - New struct `StorageTargetsClientRestoreDefaultsResponse` info [Changelog] - New field `VerificationTimer` in struct `BlobNfsTarget` info [Changelog] - New field `WriteBackTimer` in struct `BlobNfsTarget` info [Changelog] - New field `VerificationTimer` in struct `Nfs3Target` info [Changelog] - New field `WriteBackTimer` in struct `Nfs3Target` info [Changelog] info [Changelog] Total 3 breaking change(s), 5 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-storagecache [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation Caches.beginUpdate info [Changelog] - Added operation Caches.beginUpdateAndWait info [Changelog] - Added operation StorageTargets.beginRestoreDefaults info [Changelog] - Added operation StorageTargets.beginRestoreDefaultsAndWait info [Changelog] - Added Interface CachesDebugInfoHeaders info [Changelog] - Added Interface CachesDeleteHeaders info [Changelog] - Added Interface CachesFlushHeaders info [Changelog] - Added Interface CachesStartHeaders info [Changelog] - Added Interface CachesStopHeaders info [Changelog] - Added Interface CachesUpdateHeaders info [Changelog] - Added Interface CachesUpgradeFirmwareHeaders info [Changelog] - Added Interface StorageTargetFlushHeaders info [Changelog] - Added Interface StorageTargetInvalidateHeaders info [Changelog] - Added Interface StorageTargetResumeHeaders info [Changelog] - Added Interface StorageTargetsDeleteHeaders info [Changelog] - Added Interface StorageTargetsDnsRefreshHeaders info [Changelog] - Added Interface StorageTargetsRestoreDefaultsHeaders info [Changelog] - Added Interface StorageTargetsRestoreDefaultsOptionalParams info [Changelog] - Added Interface StorageTargetSuspendHeaders info [Changelog] - Interface BlobNfsTarget has a new optional parameter verificationTimer info [Changelog] - Interface BlobNfsTarget has a new optional parameter writeBackTimer info [Changelog] - Interface CachesUpdateOptionalParams has a new optional parameter resumeFrom info [Changelog] - Interface CachesUpdateOptionalParams has a new optional parameter updateIntervalInMs info [Changelog] - Interface Nfs3Target has a new optional parameter verificationTimer info [Changelog] - Interface Nfs3Target has a new optional parameter writeBackTimer info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Removed operation Caches.update info [Changelog] - Operation Caches.beginCreateOrUpdate has a new signature info [Changelog] - Operation Caches.beginCreateOrUpdateAndWait has a new signature info [Changelog] - Operation StorageTargets.beginCreateOrUpdate has a new signature info [Changelog] - Operation StorageTargets.beginCreateOrUpdateAndWait has a new signature info [Changelog] - Interface CachesCreateOrUpdateOptionalParams no longer has parameter cache info [Changelog] - Interface StorageTargetsCreateOrUpdateOptionalParams no longer has parameter storagetarget
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️storagecache [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
❌Failed [Logs]Release - Generate from dd8b2cb079a2e90e5267db665ecfeedb4c5ae108. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
❌Az.storagecache [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/storagecache/armstoragecache | https://apiview.dev/Assemblies/Review/8bbf907901e645e992f0aded3855fdc2 |
| Java | azure-resourcemanager-storagecache | https://apiview.dev/Assemblies/Review/fc0334d833cb4bfa99c5df1915a983b5 |
| .Net | Azure.ResourceManager.StorageCache | https://apiview.dev/Assemblies/Review/78c6ae5cb1b94c2282a6e73b3bd41a0a |
| JavaScript | @azure/arm-storagecache | https://apiview.dev/Assemblies/Review/a077b7b4b5c94b08b76bc89f922f0304 |
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. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
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
Hi @rebecca337, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
"$ref": "#/definitions/CloudError"
Non-blocking, but recommended that teams move to ErrorResponse from v4 common types for new APIs.
Refers to: specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-01-01/storagecache.json:1838 in 30d4c64. [](commit_id = 30d4c64c2167a84401850e8f6f180f0aa0092b10, deletion_comment = False)
@mentat9 Thanks for the note on v4, we are working on this and plan to have it in our next API version.
@tadelesh The CI-MissingBaseCommit tag is incorrect. If you look at our list of commits, we have the base commits in place done by OpenAPI.
@tadelesh The CI-MissingBaseCommit tag is incorrect. If you look at our list of commits, we have the base commits in place done by OpenAPI.
I don't see the error you mentioned. But you need to fix the model validation error.
@tadelesh I pushed the fixes for this. The model validation is now failing incorrectly due to the following:
The required property primingManifestUrl is not present in GET or PUT responses. This is an issue with the validation checker since primingManifestUrl is labeled as both required and x-ms-secret. According to the x-ms-secret autorest specs, "When a property is modeled as both "required" and "x-ms-secret": true, which means that this property must not exist in the response but has to be present in request." which is what we do in the examples.
"primingManifestUrl": { "description": "The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob.", "$ref": "#/definitions/URLString", "x-ms-mutability": [ "create" ], "x-ms-secret": true }, "required": [ "primingJobName", "primingManifestUrl" ],
@tadelesh I pushed the fixes for this. The model validation is now failing incorrectly due to the following:
The required property primingManifestUrl is not present in GET or PUT responses. This is an issue with the validation checker since primingManifestUrl is labeled as both required and x-ms-secret. According to the x-ms-secret autorest specs, "When a property is modeled as both "required" and "x-ms-secret": true, which means that this property must not exist in the response but has to be present in request." which is what we do in the examples.
"primingManifestUrl": { "description": "The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob.", "$ref": "#/definitions/URLString", "x-ms-mutability": [ "create" ], "x-ms-secret": true }, "required": [ "primingJobName", "primingManifestUrl" ],
Got it. I've let tooling team know the issue.
@tadelesh thanks. Are we approved to merge when we are ready? The other errors here are because of breaking change, and we already have the exception tag for that.
Hi, @rebecca337. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
@tadelesh Are we missing anything on my team's end to get this merged? Our rollout is complete so we need to merge this Swagger change as soon as we can.