GraphQL Schema
Bosca exposes a single GraphQL endpoint that brings all major capabilities together behind one API. This makes it easier to build apps, automate workflows, and evolve your system without juggling multiple services.
Endpoints:
- GraphQL:
http://localhost:8080/graphql - GraphiQL:
http://localhost:8080/graphiql
Why GraphQL:
- Fetch exactly what you need—nothing more
- Compose data from multiple modules in a single request
- Version-friendly, schema-first approach
Subscriptions
Bosca supports GraphQL subscriptions for real-time updates over WebSocket connections. Events are published when content changes occur:
- Collection Events: Notifications when collections are created, updated, or deleted, including version tracking.
- Metadata Events: Notifications when metadata items are created, updated, or deleted.
Subscriptions are useful for building live dashboards, real-time editors, and notification systems that react instantly to content changes.
Persisted Queries
Bosca supports persisted GraphQL queries, which allow clients to register queries ahead of time and execute them by reference. This is particularly useful for mobile clients where bandwidth matters—instead of sending a full query string with every request, clients send a compact query identifier.
Persisted queries also improve security by limiting the set of queries that can be executed against the API.
Technical Reference (for developers)
Schema sources are composed from module-local .graphqls files:
- Core types:
/backend/framework/core/src/main/resources/graphql - Content:
/backend/framework/content/src/main/resources/graphql - Security:
/backend/framework/security/src/main/resources/graphql - Profiles & Organizations:
/backend/framework/profile/src/main/resources/graphql - Analytics:
/backend/framework/analytics/src/main/resources/graphql - AI & Agents:
/backend/framework/ai/src/main/resources/graphql - Languages:
/backend/framework/languages/src/main/resources/graphql - Search:
/backend/framework/search/src/main/resources/graphql - Scheduler:
/backend/framework/scheduler/src/main/resources/graphql - Scripting:
/backend/framework/scripting/src/main/resources/graphql - Configuration:
/backend/framework/configuration/src/main/resources/graphql - Backup:
/backend/framework/backup/src/main/resources/graphql - Storage Systems:
/backend/framework/storage/src/main/resources/graphql - Server root:
/backend/servers/bosca-server/src/main/resources/graphql
Use these files as the source of truth for fields, inputs, and mutations.