Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Schema Checks Show Affected App Deployments
description:
See which app deployments would be impacted by breaking schema changes before deploying.
date: 2025-12-10
authors: [adam]
---

Schema checks now show which active app deployments would be affected by breaking changes, helping
you understand the real-world impact before deploying schema updates.

## How It Works

When a schema check detects breaking changes, Hive automatically identifies which active app
deployments have operations that use the affected schema coordinates. For each affected deployment,
you'll see:

- The app deployment name and version
- Which specific operations within that deployment use the affected fields

## Example

If you're removing `Query.users`, and your `mobile-app@2.1.0` deployment has operations that query
this field, the schema check will show:

- **Breaking change**: Field `users` was removed from object type `Query`
- **Affected deployment**: `mobile-app` version `2.1.0`
- **Affected operations**: The specific operation names and hashes that use this field

## Benefits

- **Impact assessment**: Understand which client applications would break before deploying
- **Team coordination**: Know which teams need to update their apps before proceeding
- **Risk mitigation**: Make informed decisions about breaking changes

Only **active** app deployments (published and not retired) are analyzed. Pending and retired
deployments are not included.

---

- [Learn more about App Deployments](/docs/schema-registry/app-deployments#schema-checks-and-affected-app-deployments)
44 changes: 44 additions & 0 deletions packages/web/docs/src/content/schema-registry/app-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,50 @@ change to **retired**.

- [`app:retire` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-appretire)

## Schema Checks and Affected App Deployments

When you run a schema check that detects breaking changes, Hive automatically identifies which
active app deployments would be affected by those changes. This helps you understand the real-world
impact of schema changes before deploying them.

### How It Works

During a schema check, Hive analyzes the breaking changes and matches them against the persisted
documents in your active app deployments. Hive identifies all app deployments that have operations
using any of the affected schema coordinates (e.g., fields like `Query.hello` that are being
removed).

For each affected app deployment, you'll see:

- **The deployment** name and version
- **Which specific operations** within that deployment use the affected schema coordinates

This information is displayed alongside the breaking changes in the schema check results, helping
you understand the collective impact across all your active app deployments.

### Example

If you have a breaking change that removes the `Query.users` field, and you have an active app
deployment `mobile-app@2.1.0` with operations that query `Query.users`, the schema check will show:

- The breaking change: "Field 'users' was removed from object type 'Query'"
- Affected app deployment: `mobile-app` version `2.1.0`
- Affected operations: The specific operation names and hashes that use this field

### Benefits

- **Impact assessment**: Understand which client applications would break before deploying schema
changes
- **Coordination**: Know which teams need to update their apps before a breaking change can be
safely deployed
- **Risk mitigation**: Make informed decisions about whether to proceed with breaking changes or
find alternative approaches

<Callout type="info">
Only **active** app deployments (published and not retired) are checked for affected operations.
Pending and retired deployments are not included in this analysis.
</Callout>

## Persisted Documents on GraphQL Server and Gateway

Persisted documents can be used on your GraphQL server or Gateway to reduce the payload size of your
Expand Down
Loading