Elgato_dark/console
1
0
Fork 0
mirror of https://github.com/graphql-hive/console synced 2026-05-23 09:08:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: Mention passing URL on schema check (#6589)

Browse source
This commit is contained in:
jdolle 2025-03-06 16:41:53 -08:00 committed by GitHub
parent bb2f2aa30f
commit 382a92e454
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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)