-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Release redisenterprise-Microsoft.cache 2023-07-01 #24548
Release redisenterprise-Microsoft.cache 2023-07-01 #24548
Conversation
Hi, @revanthballa1188 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 |
---|---|---|
redisenterprise.json | 2023-07-01(55aecfd) | 2022-01-01(main) |
redisenterprise.json | 2023-07-01(55aecfd) | 2023-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 2 Errors, 7 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-2023-07 | package-2023-07(55aecfd) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
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.Cache/stable/2023-07-01/redisenterprise.json#L716 |
|
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L1569 |
|
The response of operation:'RedisEnterprise_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L116 |
||
The response of operation:'RedisEnterprise_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L175 |
||
Based on the response model schema, operation 'RedisEnterprise_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L278 |
||
The response of operation:'RedisEnterprise_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L278 |
||
The response of operation:'Databases_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L447 |
||
The response of operation:'Databases_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L513 |
||
The response of operation:'Databases_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L573 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L115 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L220 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L264 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L400 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L446 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L446 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L562 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L654 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L669 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L669 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L715 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L715 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L765 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L777 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L777 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L778 |
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.Cache/stable/2023-07-01/redisenterprise.json#L778 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L824 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L836 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L836 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L837 |
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.Cache/stable/2023-07-01/redisenterprise.json#L837 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L883 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L895 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L924 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L940 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L940 |
ProvisioningStateSpecifiedForLROPut |
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L984 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L1022 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L1098 |
️️✔️
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.
️️✔️
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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @revanthballa1188! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
Hi @revanthballa1188! 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. |
...tion/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-07-01/redisenterprise.json
Show resolved
Hide resolved
...tion/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-07-01/redisenterprise.json
Outdated
Show resolved
Hide resolved
...tion/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-07-01/redisenterprise.json
Show resolved
Hide resolved
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.
Please also check and fix the LintDiff errors.
Please address or respond to feedback from the ARM API reviewer. When you are ready to continue the ARM API review, please remove the |
@revanthballa1188 Please fix CI checks errors ( |
@visingla-ms Can you please merge this, |
The lint diff errors are not part of this PR changes and have the the same in the last release as well. |
@rkmanda Can you please merge this PR. I added the tag MergeRequested yesterday, but for some reason, it is not yet merged! |
Theres a required check failing. I am reaching out to the tooling team to check |
Looks like the SDK check failed with runtime exception. I am not 100% sure but I suspect that this is the root-cause of the PR missing the label Update: not working as expected. Investigating. |
"default": { | ||
"description": "Error response describing why the operation failed.", | ||
"schema": { | ||
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" |
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.
@revanthballa1188, please ref to the common-type version uniformly.
Currently there are v2 and v3, azure-sdk-for-go appeared Duplicate Schema named 'ErrorResponse'
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.
Updated to use V2
Next Steps to Merge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 request review from an ARM API Review board.
ARM API changes review
ARMReview
label.ARMReview
label, if appropriate.If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.
Getting help
and https://aka.ms/ci-fix.