Skip to content

Commit 382a92e

Browse files
authored
docs: Mention passing URL on schema check (#6589)
1 parent bb2f2aa commit 382a92e

File tree

1 file changed

+10
-3
lines changed
  • packages/web/docs/src/content/api-reference

1 file changed

+10
-3
lines changed

packages/web/docs/src/content/api-reference/cli.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,21 @@ Or, multiple files using a `glob` expression:
166166
hive schema:check "src/*.graphql"
167167
```
168168

169-
If you want to leverage from retaining approved breaking changes within the lifecyle of a pull/merge
170-
request or branch, you must provide the `--contextId` parameter. Using `--contextId` is optional
171-
when using GitHub repositories and actions with the `--github` flag.
169+
If you want to be able to leverage breaking change approvals, you must provide the `--contextId`
170+
parameter. Using `--contextId` is optional when using GitHub repositories and actions with the
171+
`--github` flag.
172172

173173
```bash
174174
hive schema:check --contextId "pr-123" "src/*.graphql"
175175
```
176176

177+
For distributed schemas (Federated or Stitching), you are able to view changes to subgraph URLs by
178+
providing the `--url` parameter.
179+
180+
```bash
181+
hive schema:check "src/schema.graphql" --service users --url "https://users.graphql-hive.com/graphql"
182+
```
183+
177184
Further reading:
178185

179186
- [Publishing a schema to the Schema Registry](/docs/schema-registry#publish-a-schema)

0 commit comments

Comments
 (0)