From 382a92e45473e17340f734c6ade03188ec95d1a4 Mon Sep 17 00:00:00 2001 From: jdolle <1841898+jdolle@users.noreply.github.com> Date: Thu, 6 Mar 2025 16:41:53 -0800 Subject: [PATCH] docs: Mention passing URL on schema check (#6589) --- packages/web/docs/src/content/api-reference/cli.mdx | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/packages/web/docs/src/content/api-reference/cli.mdx b/packages/web/docs/src/content/api-reference/cli.mdx index 354036f51..1f73260e2 100644 --- a/packages/web/docs/src/content/api-reference/cli.mdx +++ b/packages/web/docs/src/content/api-reference/cli.mdx @@ -166,14 +166,21 @@ Or, multiple files using a `glob` expression: hive schema:check "src/*.graphql" ``` -If you want to leverage from retaining approved breaking changes within the lifecyle of a pull/merge -request or branch, you must provide the `--contextId` parameter. Using `--contextId` is optional -when using GitHub repositories and actions with the `--github` flag. +If you want to be able to leverage breaking change approvals, you must provide the `--contextId` +parameter. Using `--contextId` is optional when using GitHub repositories and actions with the +`--github` flag. ```bash hive schema:check --contextId "pr-123" "src/*.graphql" ``` +For distributed schemas (Federated or Stitching), you are able to view changes to subgraph URLs by +providing the `--url` parameter. + +```bash +hive schema:check "src/schema.graphql" --service users --url "https://users.graphql-hive.com/graphql" +``` + Further reading: - [Publishing a schema to the Schema Registry](/docs/schema-registry#publish-a-schema)