-
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
Riya/removeskulist #26376
Riya/removeskulist #26376
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
redisenterprise.json | 2022-11-01-preview(75f0a5c) | 2022-11-01-preview(main) |
redisenterprise.json | 2023-03-01-preview(75f0a5c) | 2023-03-01-preview(main) |
redisenterprise.json | 2023-08-01-preview(75f0a5c) | 2023-08-01-preview(main) |
redisenterprise.json | 2023-10-01-preview(75f0a5c) | 2023-10-01-preview(main) |
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/skus' removed or restructured? Old: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L1202:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/skus' removed or restructured? Old: Microsoft.Cache/preview/2023-03-01-preview/redisenterprise.json#L1271:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/skus' removed or restructured? Old: Microsoft.Cache/preview/2023-08-01-preview/redisenterprise.json#L1271:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/skus' removed or restructured? Old: Microsoft.Cache/preview/2023-10-01-preview/redisenterprise.json#L1271:5 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-preview-2023-10 | package-preview-2023-10(75f0a5c) | package-preview-2023-10(main) |
package-preview-2023-08 | package-preview-2023-08(75f0a5c) | package-preview-2023-08(main) |
package-preview-2023-03 | package-preview-2023-03(75f0a5c) | package-preview-2023-03(main) |
package-preview-2022-11 | package-preview-2022-11(75f0a5c) | package-preview-2022-11(main) |
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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L220 |
DeleteResponseCodes |
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/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 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L562 |
DeleteResponseCodes |
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/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 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must 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. 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 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must 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. 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 |
ResourceNameRestriction |
The resource name parameter 'clusterName' should be defined with a 'pattern' restriction. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L895 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L924 |
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 |
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/preview/2022-11-01-preview/redisenterprise.json#L984 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Cache/preview/2022-11-01-preview/redisenterprise.json#L984 |
DeleteResponseCodes |
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/preview/2022-11-01-preview/redisenterprise.json#L1037 |
️️✔️
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
|
Please address or respond to feedback from the ARM API reviewer. |
Breaking changes new intake created: https://msazure.visualstudio.com/b32aa71e-8ed2-41b2-9d77-5bc261222004/_workitems/edit/25626928 |
Hi @msyyc, I am requesting a breaking changes review for CI-BreakingChange-Python-Track2. Please let me know if there are questions or some fixes more to do from my end. |
@rkmanda Hi, I had a question on how the public docs will be updated for ARM internal API (https://armwiki.azurewebsites.net/api_contracts/SKUContract.html?tabs=resource-type-level). The document mentions that individual RPs shouldn't specify the API in their spec. Is there anything from our end to onboard the documentation for this API? Similar to how Microsoft.Compute has: https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list?tabs=HTTP |
no action required for internal APIs |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
* updates to preview api version removing unshipped SKUs API
* updates to preview api version removing unshipped SKUs API
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
We had initially implemented an API to return skus available for the Redis Enterprise service. After being informed that the right way to do this is by implementing the SKU contract where ARM returns the skus after contacting the service RP, we recently rolled out changes to support that. We do not need to expose the previous API anymore. This API was not usable by customers since we had not rolled out the manifest changes for the previous implementation so this will not have customer impact.
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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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 ApiView
comment 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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.