-
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
[Hub Generated] Review request for Microsoft.Cache to add version preview/2022-11-01-preview #21026
[Hub Generated] Review request for Microsoft.Cache to add version preview/2022-11-01-preview #21026
Conversation
… to version 2022-11-01-preview
Hi, @riyasimon23 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 | 2022-11-01-preview(e890834) | 2022-01-01(main) |
redisenterprise.json | 2022-11-01-preview(e890834) | 2021-02-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 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-preview-2022-11 | package-preview-2022-11(e890834) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L1852 |
RPC-Put-V1-14 | |
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/preview/2022-11-01-preview/redisenterprise.json#L1899 |
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/preview/2022-11-01-preview/redisenterprise.json#L115 |
CreateOperationAsyncResponseValidation |
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L116 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L220 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L231 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L264 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L400 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L446 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L446 |
CreateOperationAsyncResponseValidation |
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L447 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L562 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L617 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L654 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L669 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L669 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L715 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L715 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L765 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L777 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L777 |
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/preview/2022-11-01-preview/redisenterprise.json#L778 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L824 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L836 |
ResourceNameRestriction |
The resource name parameter 'databaseName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L836 |
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/preview/2022-11-01-preview/redisenterprise.json#L837 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L883 |
GetCollectionResponseSchema |
The response in the GET collection operation 'PrivateEndpointConnections_List' does not match the response definition in the individual GET operation 'PrivateEndpointConnections_Get' . Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L895 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L895 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L940 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L940 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L984 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 23 Errors, 0 Warnings failed [Detail]
Tag package-preview-2022-11; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 24, untested: 0, failed: 21, passed: 3
Service API Readiness Test failed. Check pipeline artifact for detail report.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client has permission to perform action 'Microsoft.ManagedIdentity/userAssignedIdentities/assign/action' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-eDLgks-21026/providers/Microsoft.Cache/redisEnterprise/clusterna8v1kr', however the linked subscription 'your-subscription' was not found. Source: runtime OperationId: RedisEnterprise_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/redisEnterprise/clusterna8v1kr' under resource group 'apiTest-eDLgks-21026' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: RedisEnterprise_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.Cache/redisEnterprise/clusterna8v1kr' under resource group 'apiTest-eDLgks-21026' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: RedisEnterprise_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_ListByCluster |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_Import |
CLIENT_ERROR |
statusCode: 403, errorCode: LinkedAuthorizationFailed, errorMessage: The client has permission to perform action 'Microsoft.Cache/redisEnterprise/databases/write' on scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5/resourceGroups/apiTest-eDLgks-21026/providers/Microsoft.Cache/redisEnterprise/clusterna8v1kr/databases/databasexqj6im', however the linked subscription 'db5eb68e-73e2-4fa8-b18a-46cd1be4cce52' was not found. Source: runtime OperationId: Databases_ForceUnlink |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_RegenerateKey |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_Export |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_ListKeys |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: PrivateEndpointConnections_Put |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: PrivateEndpointConnections_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: PrivateEndpointConnections_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: properties Source: response OperationId: Operations_List |
SERVER_ERROR |
statusCode: 500, errorCode: InternalServerError, errorMessage: An error occurred in the resource provider. Please include the following details when you contact support: CorrelationID=50f3b391-7ca5-4df0-8734-fa54cc0e3052 RequestID=c0514e8c-a9fc-4807-a689-aa4c66faaae6 Timestamp=2/9/2023 6:45:46 PM (UTC) Source: runtime OperationId: OperationsStatus_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: Skus_List |
INVALID_CONTENT_TYPE |
Invalid Content-Type (application/octet-stream). These are supported: application/json Source: response OperationId: Skus_List |
INVALID_RESPONSE_BODY |
Body is required in response but not provided Source: response OperationId: Skus_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: PrivateLinkResources_ListByCluster |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: PrivateEndpointConnections_Delete |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterna8v1kr' not found. Source: runtime OperationId: Databases_Delete |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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
|
"x-ms-enum": { | ||
"name": "SkuName", | ||
"modelAsString": true | ||
} |
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.
We should be able to refactor this out into its own definition and reference it in both places:
`
"definitions":{
"SkuName": {
"type": "string",
"description": "The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)",
"enum": [
"Enterprise_E10",
"Enterprise_E20",
"Enterprise_E50",
"Enterprise_E100",
"EnterpriseFlash_F300",
"EnterpriseFlash_F700",
"EnterpriseFlash_F1500"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": true
}
}`
and "name": { "$ref": "#Definitions/SkuName }
(approx) #Closed
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.
Added a new definition Sku Name and changed the two definitions to point to this reference
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/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.
🕐
Hi, @riyasimon23 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Hi @riyasimon23, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @riyasimon23, 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. |
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
...senterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json
Show resolved
Hide resolved
… of https://github.com/riyasimon23/azure-rest-api-specs into dev-redisenterprise-Microsoft.Cache-2022-11-01-preview
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@akning-ms @TimLovellSmith @raosuhas I'm not sure who's the right person to do the merge - please do another review when you can and merge if it looks good. Thanks! |
@akning-ms ready to merge? |
…oft.Cache to add version preview/2022-11-01-preview (#2792) Create to sync Azure/azure-rest-api-specs#21026 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/redisenterprise?expand=1)
…view/2022-11-01-preview (Azure#21026) * Update example value for module argument * Adds base for updating Microsoft.Cache from version stable/2022-01-01 to version 2022-11-01-preview * Updates readme * Updates API version in new specs and examples * Add changes * Changes from feedback * Adding changes to fix checks * fix error * fix error * revert changes * change * Adds base for updating Microsoft.Cache from version stable/2022-01-01 to version 2022-11-01-preview * Updates readme * Updates API version in new specs and examples * Update spec and examples for redisenterprise 2022-11-01-preview * Fix update example by properly defining headers * Add identity to patch to satisfy linter * Improve description of keyId * Switch to v3 types and use ref for location/operation * Change missed v2 types to v3 * change keyId to keyUrl and add "format": "url" for it * Match common api contract This commit changes `encryption` field in the API spec to match the recommendation in the following repository and file: azure-resource-manager-rpc:v1.0/common-api-contracts.md#customer-managed-key-encryption * add identityType with description that states only userAssigned is supported * Update encryption description to say encryption-at-rest * fix(example): use correct API version in SKUs example * fixes for checks * updating from main * fix * change header * add headers subsection * updating 2022-01-01 * removing read only, adding location common types * Update specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json Co-authored-by: jantache-microsoft <jantache@microsoft.com> * review updates - for linter issues * edit * prettier fix --------- Co-authored-by: Riya Simon <riyasimon@microsoft.com> Co-authored-by: jantache-microsoft <jantache@microsoft.com>
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.