Skip to content
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

Davidgrebb redisenterprise microsoft.cache 2023 08 01 preview 3 #25485

Merged

Conversation

davidgrebb
Copy link
Contributor

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.

diagram

[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!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

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:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 23, 2023

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).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 23, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 2 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
redisenterprise.json 2023-08-01-preview(8ab8513) 2023-07-01(main)
redisenterprise.json 2023-08-01-preview(8ab8513) 2023-03-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Cache/preview/2023-08-01-preview/redisenterprise.json#L1361:9
Old: Microsoft.Cache/stable/2023-07-01/redisenterprise.json#L1277:9


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.Cache/preview/2023-08-01-preview/redisenterprise.json#L2050:11
Old: Microsoft.Cache/preview/2023-03-01-preview/redisenterprise.json#L2006:11
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.4) new version base version
package-preview-2023-08 package-preview-2023-08(8ab8513) default(main)
️️✔️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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 23, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/redisenterprise/armredisenterprise - Approved - 2.0.0-beta.1
+	Operation `*PrivateEndpointConnectionsClient.Delete` has been changed to LRO, use `*PrivateEndpointConnectionsClient.BeginDelete` instead.
azure-sdk-for-python-track2 - track2_azure-mgmt-redisenterprise - Approved - 2.1.0b2
+	Renamed operation PrivateEndpointConnectionsOperations.delete to PrivateEndpointConnectionsOperations.begin_delete
azure-sdk-for-js - @azure/arm-redisenterprisecache - Approved - 3.0.0-beta.1
+	Removed operation PrivateEndpointConnections.delete
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from a380920. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]  notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-redisenterprise [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation RedisEnterpriseOperations.check_name_availability
    info	[Changelog]
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Renamed operation PrivateEndpointConnectionsOperations.delete to PrivateEndpointConnectionsOperations.begin_delete
️⚠️ azure-sdk-for-java warning [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from a380920. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/redisenterprise/armredisenterprise [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Operation `*PrivateEndpointConnectionsClient.Delete` has been changed to LRO, use `*PrivateEndpointConnectionsClient.BeginDelete` instead.
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `ResourceStateScaling`, `ResourceStateScalingFailed` added to enum type `ResourceState`
    info	[Changelog] - New enum type `CmkIdentityType` with values `CmkIdentityTypeSystemAssignedIdentity`, `CmkIdentityTypeUserAssignedIdentity`
    info	[Changelog] - New enum type `CreatedByType` with values `CreatedByTypeApplication`, `CreatedByTypeKey`, `CreatedByTypeManagedIdentity`, `CreatedByTypeUser`
    info	[Changelog] - New enum type `ManagedServiceIdentityType` with values `ManagedServiceIdentityTypeNone`, `ManagedServiceIdentityTypeSystemAssigned`, `ManagedServiceIdentityTypeSystemAssignedUserAssigned`, `ManagedServiceIdentityTypeUserAssigned`
    info	[Changelog] - New function `*Client.CheckNameAvailability(context.Context, CheckNameAvailabilityParameters, *ClientCheckNameAvailabilityOptions) (ClientCheckNameAvailabilityResponse, error)`
    info	[Changelog] - New function `*ClientFactory.NewSKUsClient() *SKUsClient`
    info	[Changelog] - New function `*DatabasesClient.BeginFlush(context.Context, string, string, string, FlushParameters, *DatabasesClientBeginFlushOptions) (*runtime.Poller[DatabasesClientFlushResponse], error)`
    info	[Changelog] - New function `NewSKUsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SKUsClient, error)`
    info	[Changelog] - New function `*SKUsClient.NewListPager(string, *SKUsClientListOptions) *runtime.Pager[SKUsClientListResponse]`
    info	[Changelog] - New function `timeRFC3339.MarshalText() ([]byte, error)`
    info	[Changelog] - New function `*timeRFC3339.Parse(string) error`
    info	[Changelog] - New function `*timeRFC3339.UnmarshalText([]byte) error`
    info	[Changelog] - New struct `Capability`
    info	[Changelog] - New struct `CheckNameAvailabilityParameters`
    info	[Changelog] - New struct `ClusterPropertiesEncryption`
    info	[Changelog] - New struct `ClusterPropertiesEncryptionCustomerManagedKeyEncryption`
    info	[Changelog] - New struct `ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity`
    info	[Changelog] - New struct `FlushParameters`
    info	[Changelog] - New struct `LocationInfo`
    info	[Changelog] - New struct `ManagedServiceIdentity`
    info	[Changelog] - New struct `RegionSKUDetail`
    info	[Changelog] - New struct `RegionSKUDetails`
    info	[Changelog] - New struct `SKUDetail`
    info	[Changelog] - New struct `SystemData`
    info	[Changelog] - New struct `UserAssignedIdentity`
    info	[Changelog] - New field `Identity`, `SystemData` in struct `Cluster`
    info	[Changelog] - New field `Encryption` in struct `ClusterProperties`
    info	[Changelog] - New field `Identity` in struct `ClusterUpdate`
    info	[Changelog] - New field `SystemData` in struct `Database`
    info	[Changelog] - New field `SystemData` in struct `PrivateEndpointConnection`
    info	[Changelog] - New field `SystemData` in struct `PrivateLinkResource`
    info	[Changelog] - New field `SystemData` in struct `ProxyResource`
    info	[Changelog] - New field `SystemData` in struct `Resource`
    info	[Changelog] - New field `SystemData` in struct `TrackedResource`
    info	[Changelog]
    info	[Changelog] Total 1 breaking change(s), 58 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from a380920. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-redisenterprisecache [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group Skus
    info	[Changelog]   - Added operation Databases.beginFlush
    info	[Changelog]   - Added operation Databases.beginFlushAndWait
    info	[Changelog]   - Added operation PrivateEndpointConnections.beginDelete
    info	[Changelog]   - Added operation PrivateEndpointConnections.beginDeleteAndWait
    info	[Changelog]   - Added operation RedisEnterprise.checkNameAvailability
    info	[Changelog]   - Added Interface Capability
    info	[Changelog]   - Added Interface CheckNameAvailabilityParameters
    info	[Changelog]   - Added Interface ClusterPropertiesEncryption
    info	[Changelog]   - Added Interface ClusterPropertiesEncryptionCustomerManagedKeyEncryption
    info	[Changelog]   - Added Interface ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity
    info	[Changelog]   - Added Interface DatabasesFlushHeaders
    info	[Changelog]   - Added Interface DatabasesFlushOptionalParams
    info	[Changelog]   - Added Interface FlushParameters
    info	[Changelog]   - Added Interface LocationInfo
    info	[Changelog]   - Added Interface ManagedServiceIdentity
    info	[Changelog]   - Added Interface PrivateEndpointConnectionsDeleteHeaders
    info	[Changelog]   - Added Interface RedisEnterpriseCheckNameAvailabilityOptionalParams
    info	[Changelog]   - Added Interface RegionSkuDetail
    info	[Changelog]   - Added Interface RegionSkuDetails
    info	[Changelog]   - Added Interface SkuDetail
    info	[Changelog]   - Added Interface SkusListOptionalParams
    info	[Changelog]   - Added Interface SystemData
    info	[Changelog]   - Added Interface UserAssignedIdentity
    info	[Changelog]   - Added Type Alias CmkIdentityType
    info	[Changelog]   - Added Type Alias CreatedByType
    info	[Changelog]   - Added Type Alias ManagedServiceIdentityType
    info	[Changelog]   - Added Type Alias SkusListResponse
    info	[Changelog]   - Interface Cluster has a new optional parameter encryption
    info	[Changelog]   - Interface Cluster has a new optional parameter identity
    info	[Changelog]   - Interface ClusterUpdate has a new optional parameter encryption
    info	[Changelog]   - Interface ClusterUpdate has a new optional parameter identity
    info	[Changelog]   - Interface PrivateEndpointConnectionsDeleteOptionalParams has a new optional parameter resumeFrom
    info	[Changelog]   - Interface PrivateEndpointConnectionsDeleteOptionalParams has a new optional parameter updateIntervalInMs
    info	[Changelog]   - Interface Resource has a new optional parameter systemData
    info	[Changelog]   - Added Enum KnownCmkIdentityType
    info	[Changelog]   - Added Enum KnownCreatedByType
    info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
    info	[Changelog]   - Enum KnownResourceState has a new value Scaling
    info	[Changelog]   - Enum KnownResourceState has a new value ScalingFailed
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Removed operation PrivateEndpointConnections.delete
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from a380920. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh]  notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️redisenterprise [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from a380920. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.redisenterprise.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.redisenterprise.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 23, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/redisenterprise/armredisenterprise Create ApiView timeout. Package is too large and we cannot create ApiView for it.
Java azure-resourcemanager-redisenterprise https://apiview.dev/Assemblies/Review/96f3ae4c860d4fdfafb404aca4152c33
.Net Azure.ResourceManager.RedisEnterprise https://apiview.dev/Assemblies/Review/9651a1c7166b4774b5edb239838ea7b9
JavaScript @azure/arm-redisenterprisecache https://apiview.dev/Assemblies/Review/d48f6551011b4bf2b5c3307c563451ae

@openapi-workflow-bot
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@openapi-workflow-bot
Copy link

Hi @davidgrebb! 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.
For more details refer to the wiki.

@davidgrebb
Copy link
Contributor Author

@rkmanda Can you review this PR?

@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Aug 24, 2023
@rkmanda rkmanda removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 30, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 30, 2023
@mentat9
Copy link
Member

mentat9 commented Sep 6, 2023

@davidgrebb - Signing off for ARM. Before you can merge this PR, you will need to address the SDK breaking changes labels (Go, Javascript, Python). You can find SDK owners in pinned posts in the API Spec Reviews channel here: https://teams.microsoft.com/l/channel/19%3a0351f5f9404446e4b4fd4eaf2c27448d%40thread.skype/API%2520Spec%2520Review?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47.

@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 6, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 6, 2023
@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Sep 8, 2023
@davidgrebb
Copy link
Contributor Author

/pr RequestMerge

@mentat9 mentat9 self-requested a review September 9, 2023 02:10
@mentat9 mentat9 merged commit a380920 into main Sep 9, 2023
@mentat9 mentat9 deleted the davidgrebb-redisenterprise-Microsoft.Cache-2023-08-01-preview-3 branch September 9, 2023 02:10
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
* Adds base for updating Microsoft.Cache from version preview/2023-03-01-preview to version 2023-08-01-preview

* Updates readme

* Updates API version in new specs and examples

* Adding CheckNameAvailability operation, and new resource states

* Adding flush type to match stable release version
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants