Handbook - Reference

Contracts

CloudGrid implementation work is contract-first. Do not add public fields, routes, subjects, error codes, or message payloads outside the specs.

On this page

CloudGrid implementation work is contract-first. Do not add public fields, routes, subjects, error codes, or message payloads outside the specs.

Public Contracts

ContractPath
GraphQL schemaspecs/03-contracts/graphql/public-schema.graphql
AsyncAPI message bridgespecs/03-contracts/messages/message-bridge.asyncapi.yaml
HTTP OpenAPIspecs/03-contracts/api/http-api.openapi.yaml
Error taxonomyspecs/03-contracts/errors.yaml
Entity JSON Schemasspecs/03-contracts/entities/
Generated UI contractsapps/packages/ui-contracts
Generated Go contractscore/go-contracts

Public GraphQL Surfaces

SurfaceExamples
Viewer and organizationviewer, organizations, organizationMembers, organizationInvitations
Projectsprojects, selectProject, project member mutations
Telemetrytraces, trace, logs, metricNames, metricSeries, richMetricSeries
LiveSubscription.liveTraces
Ingest credentialsingestCredentials, createIngestCredential, revokeIngestCredential
Dashboardsdashboards, saveDashboard, deleteDashboard, setDashboardPinned, reorderDashboardPins
Retention and alertsretentionPolicy, alertRules, alertHistory, alertSilences

Contract Check

Run:

bun run contracts:check

This is mandatory for GraphQL, AsyncAPI, UI contract, BFF bridge, or Go message contract changes.

Generation

Run:

bun run contracts:generate

Generated files must identify the spec source and must not be hand-edited once generation exists.

Last updated .