Skip to content

Commit eb69fa0

Browse files
author
Stephen Barlow
committed
Minor docs clarifications
1 parent 49dd8e4 commit eb69fa0

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

docs/source/graphs.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ sidebar_title: 'graph'
44
description: 'Publish and retrieve your API schema'
55
---
66

7-
> These commands are for graphs that do _not_ use [federation](https://www.apollographql.com/docs/federation/). When working with a federated graph, instead use the [`subgraph` comamand](./subgraphs).
7+
These Rover commands are _primarily_ for interacting with monolithic graphs that do _not_ use [federation](https://www.apollographql.com/docs/federation/). However, you can also use [`rover graph introspect`](#fetching-via-introspection) to fetch a federated gateway's API schema.
8+
9+
When interacting directly with with a federated subgraph, instead use [`subgraph` commands](./subgraphs).
810

911
## Fetching a schema
1012

@@ -26,7 +28,7 @@ The argument `my-graph@my-variant` in the example above specifies the ID of the
2628
2729
### Fetching via introspection
2830

29-
If you need to obtain a running GraphQL server's schema, you can use Rover to execute an introspection query on it. This is especially helpful if you're developing a GraphQL server that _doesn't_ define its schema via SDL, such as [`graphql-kotlin`](https://github.com/ExpediaGroup/graphql-kotlin).
31+
If you need to obtain the schema of a running GraphQL server or federated gateway, you can use Rover to execute an introspection query on it. This is especially helpful if you're developing a GraphQL server that _doesn't_ define its schema via SDL, such as [`graphql-kotlin`](https://github.com/ExpediaGroup/graphql-kotlin).
3032

3133
Use the `graph introspect` command, like so:
3234

docs/source/migration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ apollo service:push --serviceName users
265265

266266
## Rover ##
267267
# (no config file needed)
268-
# globs don't work natively with Rover, so you can use `cat` to combine
269-
# multiple files on *nix machines
270-
cat *.graphql | rover subgraph publish my-graph@prod --name users --schema -
268+
# globs don't work natively with Rover, so you can use a command like `awk 1`
269+
# to combine multiple files on *nix machines
270+
awk 1 *.graphql | rover subgraph publish my-graph@prod --name users --schema -
271271
```

0 commit comments

Comments
 (0)