GraphQL Content API (GCA)
We are actively working to improve this documentation. The content you see here may be incomplete, subject to change, or may not fully reflect the current state of the feature. We appreciate your understanding as we continue to enhance our docs.
The GraphQL Content API (GCA) is the cornerstone feature of the Brightspot GraphQL plugin, providing automatic GraphQL schema generation from your Brightspot content types, view models, and static methods. The GCA embodies a "code as configuration" philosophy where developers can expose content through GraphQL with minimal to zero custom code, automatically generating CRUD operations, filtering, sorting, pagination, and full integration with Brightspot's editorial features like workflow, preview, and revisions.
What You'll Find in This Section​
This section is organized around the core artifacts you work with in Brightspot:
Content Types - The primary way to expose and query data. Learn how to get single items, query collections, and create/update/delete content. Includes comprehensive coverage of how Java content types map to GraphQL schema including relationships, embedded content, and field patterns.
View Models - Presentation layer transformations for your content. Access content-backed view models (via Get's views field) or standalone view models (via the View operation) for computed fields, aggregated data, and frontend-specific transformations.
Execute Static Methods - Expose custom business logic by calling static Java methods directly through GraphQL for calculations, integrations with external systems, batch operations, and functionality beyond standard CRUD.
Editorial Endpoint Configuration - Create and configure GCA endpoints entirely through the Brightspot UI without code changes or deployments, ideal for delegating API management to content administrators and non-technical users.
Schema Introspection - Programmatically discover available content types and view models with Brightspot-specific metadata including field definitions, operations, predicates, and inheritance hierarchies—essential for building dynamic tools and documentation generators.
Best Practices - Production-ready guidelines for schema design, performance optimization, security hardening, and versioning strategies drawn from real-world Brightspot implementations at scale.
Quick Start​
The fastest way to get started is with the Get operation for content types. Configure a content type in your schema settings using readonlyEntryClass and immediately start fetching content with full access to all fields, nested relationships, and editorial metadata. From there, explore Query for collections with filtering and pagination, mutations for content lifecycle management, and view models for presentation transformations.