feat: entry variants branch support#240
Draft
reeshika-h wants to merge 3 commits into
Draft
Conversation
reeshika-h
commented
May 12, 2026
reeshika-h
commented
Contributor
- implementation
🔒 Security Scan Results
⏱️ SLA Breach Summary
✅ BUILD PASSED - All security checks passed |
🔒 Security Scan Results
⏱️ SLA Breach Summary
✅ BUILD PASSED - All security checks passed |
🔒 Security Scan Results
⏱️ SLA Breach Summary
✅ BUILD PASSED - All security checks passed |
sunil-lakshman
left a comment
sunil-lakshman
left a comment
There was a problem hiding this comment.
Add version bump and changelog
There was a problem hiding this comment.
Pull request overview
This PR adds Content Management API “entry variants” support to the Java SDK, including stack-branch header propagation/overrides and publish/unpublish flows that require an api_version header, plus request-shape unit tests and fixtures.
Changes:
- Added entry-variant endpoints to
EntryServiceand corresponding public APIs onEntry(fetch/create/update/delete + publish/unpublish variants + branch handling helpers). - Introduced new unit tests and JSON fixtures to validate request paths, query params, and headers (including
branchandapi_version). - Extended shared constants/error messages to support variant-specific headers and validation.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/java/com/contentstack/cms/stack/EntryService.java | Adds Retrofit endpoints for entry-variant CRUD and adds query support to publish/unpublish. |
| src/main/java/com/contentstack/cms/stack/Entry.java | Adds branch/variant UID helpers and entry-variant operations, plus variant publish/unpublish helpers. |
| src/main/java/com/contentstack/cms/core/Util.java | Adds header constants for variant personalization and entry-variant publish API versioning. |
| src/main/java/com/contentstack/cms/core/ErrorMessages.java | Adds a validation message for missing Variant UID. |
| src/main/java/com/contentstack/cms/Contentstack.java | Updates stack(branch) Javadoc to clarify branch header behavior and overriding. |
| src/test/java/com/contentstack/cms/stack/EntryVariantUnitTest.java | New request-shape unit tests covering entry-variant endpoints and branch precedence. |
| src/test/java/com/contentstack/cms/stack/EntryVariantAPITest.java | New request-shape API test suite for entry-variant operations using fixtures and branch defaults. |
| src/test/java/com/contentstack/cms/stack/APISanityTestSuite.java | Registers the new entry-variant API tests in the sanity suite. |
| src/test/java/com/contentstack/cms/UnitTestSuite.java | Registers the new entry-variant unit tests in the unit suite. |
| src/test/java/com/contentstack/cms/TestClient.java | Adds env-configurable defaults for entry-variant test content type/branch/locale. |
| src/test/resources/entry_variant/create_entry_variant.json | Adds fixture payload for create variant requests. |
| src/test/resources/entry_variant/update_entry_variant.json | Adds fixture payload for update variant requests. |
| src/test/resources/entry_variant/publish_entry_variant.json | Adds fixture payload for publishing variants (requires api_version header). |
| src/test/resources/entry_variant/unpublish_entry_variant.json | Adds fixture payload for unpublishing variants (requires api_version header). |
| pom.xml | Changes surefire skipTests configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
256
to
258
| <!-- Skip during default lifecycle (e.g. publish); run tests locally with: mvn test -DskipTests=false --> | ||
| <!-- <skipTests>true</skipTests> --> | ||
| <skipTests>true</skipTests> | ||
| <testFailureIgnore>true</testFailureIgnore> |
Comment on lines
+85
to
+90
| if (branchUid == null || branchUid.isEmpty()) { | ||
| return this.headers; | ||
| } | ||
| HashMap<String, Object> copy = new HashMap<>(this.headers); | ||
| copy.put(Util.BRANCH, branchUid); | ||
| return copy; |
Comment on lines
+73
to
+78
| private void validateVariantUid(@NotNull String variantUid) { | ||
| Objects.requireNonNull(variantUid, ErrorMessages.VARIANT_UID_REQUIRED); | ||
| if (variantUid.isEmpty()) { | ||
| throw new IllegalArgumentException(ErrorMessages.VARIANT_UID_REQUIRED); | ||
| } | ||
| } |
Comment on lines
+101
to
+104
| public Entry addBranch(@NotNull String branchUid) { | ||
| this.headers.put(Util.BRANCH, branchUid); | ||
| return this; | ||
| } |
Comment on lines
+29
to
+32
| /** Content type UID for entry-variant tests (default {@code blog}). */ | ||
| public static final String ENTRY_VARIANT_CONTENT_TYPE_UID = | ||
| env.get("entryVariantContentTypeUid") != null ? env.get("entryVariantContentTypeUid") : "blog"; | ||
|
|
Comment on lines
+33
to
+36
| /** Stack branch for entry-variant tests (default {@code develop}). */ | ||
| public static final String ENTRY_VARIANT_BRANCH = | ||
| env.get("entryVariantBranch") != null ? env.get("entryVariantBranch") : "develop"; | ||
|
|
Comment on lines
+37
to
+40
| /** Locale query param for entry-variant tests (default {@code en-us}). */ | ||
| public static final String ENTRY_VARIANT_LOCALE = | ||
| env.get("entryVariantLocale") != null ? env.get("entryVariantLocale") : "en-us"; | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.