Review request for Microsoft.Cache to add version stable/2024-03-01 #28983
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
added 3 commits
May 6, 2024 10:00
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-08-01 to stable/2024-03-01.
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| redis.json | 2024-03-01(7124d13) | 2023-08-01(main) |
| redis.json | 2024-03-01(7124d13) | 2023-05-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: 1 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-03 | package-2024-03(7124d13) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2392 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.Cache/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L57 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L58 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability' Location: Microsoft.Cache/stable/2024-03-01/redis.json#L73 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Redis_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Cache/stable/2024-03-01/redis.json#L173 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L266 |
|
Properties of a PATCH request body must not have default value, property:publicNetworkAccess. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L266 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L266 |
|
Properties of a PATCH request body must not be required, property:family. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L266 |
|
Properties of a PATCH request body must not be required, property:capacity. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L266 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L285 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L299 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L333 |
|
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L630 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L670 |
|
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L689 |
|
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L729 |
|
The resource name parameter 'ruleName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L863 |
|
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1071 |
|
The resource name parameter 'linkedServerName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1264 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'LinkedServer_Create' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1265 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1332 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1519 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1711 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L1838 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2046 |
|
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2195 |
|
The schema 'RedisCommonProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2235 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2237 |
|
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2342 |
|
The schema 'RedisCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Cache/stable/2024-03-01/redis.json#L2401 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced May 6, 2024
This was referenced May 6, 2024
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
added 3 commits
May 6, 2024 11:12
AzureRestAPISpecReview
added
ARMReview
new-api-version
NotReadyForARMReview
ReadyForApiTest
mikekistler
added
the
BreakingChange-Approved-Benign
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
AzureRestAPISpecReview
added
WaitForARMFeedback
We should add little more details in the description
Refers to: specification/redis/resource-manager/Microsoft.Cache/stable/2024-03-01/redis.json:2394 in 431c8d3. [](commit_id = 431c8d3, deletion_comment = False) |
|
@vrijesh discussed internally and updated the default value and description. Since we aren't setting required as true in the swagger, we haven't stated whether the property is optional or not in the description. Additionally, since we might have a new authentication mechanism in future, we aren't specifying details about the auth used if access keys are disabled. |
vrijesh
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
|
@koderjoker - Please refresh to fix merge failure and re-apply the MergeRequested label. |
It would be good to include it in the example responses also. Refers to: specification/redis/resource-manager/Microsoft.Cache/stable/2024-03-01/redis.json:2392 in 7124d13. [](commit_id = 7124d13, deletion_comment = False) |
TimLovellSmith
approved these changes
May 13, 2024
@mentat9 Could you share what error we're facing in merging, and what steps to take to refresh to fix the merge failure? |
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
Looks like out-of-date state got fixed. |
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
…zure#28983) * Copy files from stable/2023-08-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-03-01 Updated the API version from stable/2023-08-01 to stable/2024-03-01. * Added tag for 2024-03-01 in readme file * Add disableAccessKeyAuthentication property * Update pattern for access policy name to allow space * Run prettier * Run prettier * Update description * Run prettier * Update description for redisConfiguration * Add default value and update description --------- Co-authored-by: Kanchan Joshi <[email protected]>
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 (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.