PR for new api-version: Microsoft.Cache/redis/stable/2020-12-01 [rebased + refactored] #14023
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, @TimLovellSmith 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] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2020-12-01/redis.json#L68 |
|
The response of operation:'Redis_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L345 |
|
The response of operation:'FirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L899 |
|
The response of operation:'PatchSchedules_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1208 |
|
The response of operation:'LinkedServer_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1399 |
|
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1562 |
|
The response of operation:'Redis_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L172 |
|
The response of operation:'FirewallRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L828 |
|
The response of operation:'PatchSchedules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1067 |
|
The response of operation:'LinkedServer_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2020-12-01/redis.json#L1273 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross Version BreakingChange (Base on preview version): 18 Errors, 1 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2019-07-01/redis.json <---> new: stable/2020-12-01/redis.json
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L103:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L155:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L354:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L394:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listKeys' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L427:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/regenerateKey' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L471:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/forceReboot' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L524:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/import' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L577:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/export' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L634:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules' removed or restructured? Old: Microsoft.Cache/preview/2019-07-01/redis.json#L691:5 |
️❌Cross Version BreakingChange (Base on stable version): 1 Errors, 2 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-06-01/redis.json <---> new: stable/2020-12-01/redis.json
| Rule | Message |
|---|---|
|
The read only property has changed from 'true' to 'false'. New: Microsoft.Cache/stable/2020-12-01/redis.json#L1830:9 Old: Microsoft.Cache/stable/2020-06-01/redis.json#L1922:9 |
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Cache/stable/2020-12-01/redis.json#L866:13 Old: Microsoft.Cache/stable/2020-06-01/redis.json#L863:13 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Cache/stable/2020-12-01/redis.json#L2098:5 Old: Microsoft.Cache/stable/2020-06-01/redis.json#L2153:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- redis/resource-manager/readme.md#package-2020-06
- redis/resource-manager/readme.md#package-2019-07-preview
- redis/resource-manager/readme.md#package-2018-03
- redis/resource-manager/readme.md#package-2017-10
- redis/resource-manager/readme.md#package-2017-02
- redis/resource-manager/readme.md#package-2016-04
- redis/resource-manager/readme.md#package-2015-08
- redis/resource-manager/readme.md#package-2020-12
|:speech_balloon: AutorestCore/Exception|"readme":"redis/resource-manager/readme.md",
"tag":"package-2020-06",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"redis/resource-manager/readme.md",
"tag":"package-2020-06",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"redis/resource-manager/readme.md",
"tag":"package-2020-12",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"redis/resource-manager/readme.md",
"tag":"package-2020-12",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
"readme":"redis/resource-manager/readme.md", "tag":"package-2020-06", "details":"Duplicate Schema named Resource -- properties.id.description: undefined => "Fully qualified resource ID for the resource. Ex - /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/resourceProviderNamespace/resourceType/resourceName", properties.name.description: undefined => "The name of the resource", properties.type.description: undefined => "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", title: undefined => "Resource" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"redis/resource-manager/readme.md", "tag":"package-2020-06", "details":"Error: Plugin prechecker reported failure." |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2020-06", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2019-07-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2019-07-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2018-03", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2018-03", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2017-10", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2017-10", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"redis/resource-manager/readme.md", "tag":"package-2017-02", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
|
Hi, @TimLovellSmith your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ |
Swagger Generation Artifacts
|
|
Hi, @TimLovellSmith your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @zhenglaizhang |
This was referenced Apr 20, 2021
This was referenced Apr 20, 2021
|
Hi @TimLovellSmith, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
Member
Author
|
@raych1 Resolved the conflicts by rebase. |
Member
@TimLovellSmith , there's breaking change compare to previous stable version. It needs to get breaking change review board approval. |
|
Hi @TimLovellSmith, 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. |
Member
Author
|
@raych1 All the remaining cross-version breaking change errors flagged by CI are intentional, or they are motivated by linter warnings.
|
…ng flagged as breaking changes.
…ce from common-types. Since otherwise we get "Duplicate Schema named Resource -- properties.id.description: undefined => "Fully qualified resource ID for the resource. Ex - /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/resourceProviderNamespace/resourceType/resourceName", properties.name.description: undefined => "The name of the resource","
Member
Author
|
@raych1 To simplify the scope of discussion, I've pushed new commits that minimize the breaking change errors to just More specifically, it is not a breaking change, because neither making formerly read-only string properties writeable, nor adding new string values to a string property are breaking changes. They don't break the REST API, they won't break SDKs, and its unlikely to break most app logic, since most apps wouldn't have had a need to inspect the value of the specific redisVersion string they receive, since it never previously varied. Even if it does broke app logic, it was a break the app developer could have predicted just by considering the semantics of the field. Its a version string! New versions are a thing that happen. In any case, in our API, we do need a way to model different redis versions 4 and 6, so that customers can opt-in to creating caches on redisVersion 6. And the logical way to do that is... to let them specify the redis version. It would be weird to be doing it any other way when we have a redisVersion property defined here already.
|
Member
|
For python, the breaking change is ok. Please ignore it. |
jianyexi
added
the
Approved-BreakingChange
Contributor
|
approved breaking change as it's false alarm |
This was referenced May 11, 2021
Merged
11 tasks
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.
(This PR is a redo of #13937 )
This is to document the latest REST API version for redis cache.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Answer: [Already deployed.]
Answer: [When new api-version is approved.]
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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.
-[x] 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. [Blocked, per Ray saying we need review]
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
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.
Please follow the link to find more details on PR review process.