[Key Vault Certificates] Remove preview service version from GA library#48678
[Key Vault Certificates] Remove preview service version from GA library#48678rohitsinghal4u wants to merge 10 commits intomainfrom
Conversation
Remove V2025_06_01_PREVIEW from CertificateServiceVersion as preview service versions should not be included in GA versions of the library. Also update getLatest() to return V2025_07_01 (the new stable version) and remove the preview entry from the CHANGELOG.
There was a problem hiding this comment.
Pull request overview
Removes an accidentally-included preview service version from the Key Vault Certificates GA client’s service version enum, and updates the library’s “latest” service version to the new stable 2025-07-01.
Changes:
- Removed
V2025_06_01_PREVIEWfromCertificateServiceVersion. - Updated
CertificateServiceVersion.getLatest()to returnV2025_07_01. - Removed the preview-version mention from the module CHANGELOG.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sdk/keyvault/azure-security-keyvault-certificates/src/main/java/com/azure/security/keyvault/certificates/CertificateServiceVersion.java | Removes the preview enum constant and switches getLatest() to the new stable service version. |
| sdk/keyvault/azure-security-keyvault-certificates/CHANGELOG.md | Removes the CHANGELOG entry that claimed the preview service version was added. |
Comments suppressed due to low confidence (1)
sdk/keyvault/azure-security-keyvault-certificates/src/main/java/com/azure/security/keyvault/certificates/CertificateServiceVersion.java:44
CertificateServiceVersionis marked as generated, but the generation customization still hard-codes the removed2025-06-01-previewentry and also hard-codesgetLatest()to returnV7_6. Unlesscustomizations/.../CertificatesCustomizations.customizeServiceVersion()is updated to remove the preview version and returnV2025_07_01, the next regeneration will re-introduce the preview constant and revertgetLatest()back toV7_6.
V7_6("7.6"),
/**
* Service version {@code 2025-07-01}.
*/
V2025_07_01("2025-07-01");
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Changing getLatest() to V2025_07_01 caused all playback tests to fail because existing recordings were made against API version 7.6. Reverting getLatest() to V7_6 — only the removal of V2025_06_01_PREVIEW is in scope for this PR.
The customization class generates CertificateServiceVersion.java with a hardcoded list of API versions. Preview service versions should not be included in GA library releases. Removing '2025-06-01-preview' from the list so that the generated output matches the committed file and the TypeSpec code generation verify check passes.
| .setJavadocComment("The versions of Azure Key Vault Certificates supported by this client library."); | ||
|
|
||
| for (String version : Arrays.asList("7.0", "7.1", "7.2", "7.3", "7.4", "7.5", "7.6", | ||
| "2025-06-01-preview", "2025-07-01")) { |
There was a problem hiding this comment.
Are there any APIs generated from this preview version that should be removed too? This change only removes the preview version from the enum but doesn't remove any of the APIs (if there are any) from this version. Please verify that we are not shipping any features that are still in preview.
There was a problem hiding this comment.
The uris and ipAddresses properties on SubjectAlternativeNames were introduced with @Versioning.added(v2025_06_01_preview) in the TypeSpec spec, but since v2025_07_01 is a later stable version in the Versions enum, those properties are also part of the 2025-07-01 stable API surface. No APIs need to be removed — everything currently in the library and its CHANGELOG corresponds to the stable 2025-07-01 API.
| /** | ||
| * Service version {@code 2025-07-01}. | ||
| */ | ||
| V2025_07_01("2025-07-01"); |
There was a problem hiding this comment.
The getLatest method should also be updated to return the latest stable version (V2025_07_01)
There was a problem hiding this comment.
Done — getLatest() has been updated to return V2025_07_01 in both CertificateServiceVersion.java and CertificatesCustomizations.java (the TypeSpec code-gen source of truth). All tests have been re-recorded against the live 2025-07-01 API endpoint and the updated recordings pushed in commit e0ae632.
…cord tests - Updated getLatest() to return V2025_07_01 in both CertificateServiceVersion.java and CertificatesCustomizations.java (the TypeSpec code-gen source of truth) - Re-recorded all tests against live Azure Key Vault using API version 2025-07-01 - Updated assets.json with new recording tag: java/keyvault/azure-security-keyvault-certificates_665470077b
Updated assets.json tag to include async test recordings: java/keyvault/azure-security-keyvault-certificates_8643a442b1 All 159 playback tests now pass (2 skipped).
Description
Addresses an API review comment: preview service versions should not be included in GA versions of the library.
V2025_06_01_PREVIEW(2025-06-01-preview) was introduced by the TypeSpec AutoPR for API version2025-07-01but should never have been included in a GA SDK release. This PR removes it.Changes
"2025-06-01-preview"from the version list inCertificatesCustomizations.java— this is the source of truth that generatesCertificateServiceVersion.javaduring TypeSpec code generationV2025_06_01_PREVIEWenum constant fromCertificateServiceVersion.javaV2025_06_01_PREVIEWentry from CHANGELOG under4.9.0-beta.1API Review
This change was requested during API review:
https://spa.apiview.dev/review/0ae58ec9f9c741e4aaa9f78d9d00a482?activeApiRevisionId=c33cbbe380f34a1794c7070c8b562643&diffApiRevisionId=62e624c0803a4383b9f27e52cd9c708a&diffStyle=trees&view=conversations&nId=com.azure.security.keyvault.certificates.CertificateServiceVersion.V7_4
Checklist
V2025_06_01_PREVIEWwas added in4.9.0-beta.1 (Unreleased)and was never part of a released artifactgetLatest()remainsV7_6so all existing playback recordings are unaffected