API reference
API reference
Partial GraphQL and REST reference, with measurable coverage against the current schema.
This reference is partial. The canonical contract remains apps/api/src/schema.gql; use the generated schema coverage inventory to see exactly which declarations have dedicated field reference sections.
Schema navigation
| Category | Description |
|---|---|
| Schema coverage | Generated declaration count, coverage percentage, and missing-reference inventory |
| Queries | Read queries (resolveConfiguration, product, productRevisionDetail, shopifyCatalogProducts, etc.) |
| Mutations | State mutation operations (createProduct, publishProductRevision, createChoice, startShopifyOAuth, etc.) |
| Inputs | Field reference for selected GraphQL input objects (ConfigurationStateInput, CreateChoiceInput, etc.) |
| Objects | Selected output and domain type definitions (ResolvedConfigurationModel, ProductRevisionDetailModel, etc.) |
| Enums | Selected enumerated types (VisualOperation, ProductModelAssetRole, GraphVersionStatus, etc.) |
| Errors | Transport error structures and status codes |
Interactive explorers
- GraphQL Explorer (GraphiQL): Interactive query IDE.
- REST Reference (Scalar): OpenAPI interactive documentation.