dotCMS / dotCMS/core

[FEATURE] PageAPI/GraphQL Style Properties Delivery

Open
#33,515 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stale
Dominant language
Java
Stars
970
Forks
486
Avg merge
3d 33m
Merged PRs (30d)
170

Description

Problem

Problem
PageAPI and GraphQL responses don't include style properties, making it impossible for headless applications to render components with their configured styling. Real-time preview in the Style Editor also needs this delivery system to show accurate styling.

Goal

Goal
Enhance both PageAPI and GraphQL page query to return style properties with contentlet data, maintaining the existing response structure while adding style information. This enables both headless applications and real-time preview functionality.

Personas
Developer teams: Need style data available in headless applications
Content teams: Need accurate preview of their style changes (indirect benefit)

Target Personas
  • Developer teams
  • Content teams
  • DevOps teams
  • System administrators (dotCMS)
Demo Expectations

Demo Expectations
PageAPI/GraphQL responses include styleProperties field for each contentlet
Both APIs return identical (as possible) style data maintaining consistency
Style data properly cached to prevent performance impact
Demo shows saved style properties flowing through to page rendering

Acceptance Criteria

No response

User Stories

No response

Links

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test paths are provided. Start by locating the PageAPI and GraphQL page-query entry points, then compare how contentlet data and style properties are currently delivered and cached. Done means both APIs expose consistent styleProperties for each contentlet without a performance regression.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, java
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.