Single Schema Management
Definitions
Here are helpful definitions of terms that are used in this document:
- Instance Schema: The GraphQL schema definition (i.e.
schema.graphql
) that's deployed in your GraphQL server instance (i.e.typeDefs
passed into Apollo Server) - Configured Schema: The GraphQL schema definition (i.e.
schema.graphql
) that's referenced from your InigoService
YAML definition.The Instance Schema and the Configured Schema should have the same exact definition for a given version of the schema, as they should be derived from the same source.
- Control Plane: Where Inigo Cloud applies, processes, and tracks Inigo configurations, and that tracking includes Configured Schema definitions for your
Service
. - Schema Check Pipeline: Where Inigo Cloud performs the automated validations and checks of the applied Configured Schema.
- Breaking Change: The Configured Schema has changes that remove or modify parts of the schema that have recently been used by GraphQL clients and may result in client errors if the schema changes are published.