Schema Checks Reference

Reference for types of schema changes that checks can detect

PLAN REQUIRED

This feature is available on the following GraphOS plans: Free, Developer, Standard, Enterprise.

This reference describes the operations checks statuses you see in GraphOS Studio and the schema change types reported by the Rover CLI subgraph check response.

Operations check statuses

GraphOS classifies operations checks with the following statuses:

Types of schema changes

When you run a schema check, the check response classifies each schema change with the following codes.

Not every change to a schema is a potentially breaking change. Additive changes (such as adding a field to a type) are usually safe and do not affect active clients. Deletions and modifications (such as removing a field or changing a return type), however, can break clients that use affected types and fields.

If you use the GraphOS Router to report operation metrics, you can configure extended reference reporting for more accurate schema checks.

Potentially breaking changes

note

You can use ignored conditions settings to ignore all potentially breaking changes when detected on a variant without traffic.

Removals

These changes remove a schema element. If an operation is actively using a removed element, that operation will start returning an error.

Addition of required arguments

These changes add a required input to a schema element. If an operation is actively using an element of your graph and doesn't add the new required input argument, the graph will return an error to affected clients.

In-place updates

These changes update an existing schema element. If an operation is actively using an element that is updated, the operation might start receiving an error from your graph. It also might receive an unexpected result.

note

In some cases, in-place updates are compatible with affected clients at runtime (such as a type rename or a conversion from an object to an interface that uses the same fields). However, schema checks still marks these as breaking changes, because validation does not have enough information to ensure that they are safe.

Default values

These changes update the default value for an argument or input type. If an operation is using an element of your graph and does not specify a value for this argument, the operation might get an unexpected result when the schema is updated if it was relying on the original default value.

note

You can use ignored conditions settings to ignore default value changes. Default value removals can still be breaking changes.

Non-breaking changes

These changes are detected by schema checks, but they are "safe." They never affect the behavior of any existing clients if deployed.

Schema additions

Deprecations

Descriptions