Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor docs clarifications #619

Merged
merged 2 commits into from
Jun 17, 2021
Merged
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
6 changes: 4 additions & 2 deletions docs/source/graphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ sidebar_title: 'graph'
description: 'Publish and retrieve your API schema'
---

> 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).
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 them to fetch a federated gateway's API schema [from Apollo Studio](#fetching-from-apollo-studio) or [via introspection](#fetching-via-introspection).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and rover graph fetch to get the API schema from studio instead of via introspection

> When interacting directly with a federated subgraph, instead use [`subgraph` commands](./subgraphs).

## Fetching a schema

Expand All @@ -26,7 +28,7 @@ The argument `my-graph@my-variant` in the example above specifies the ID of the

### Fetching via introspection

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

Use the `graph introspect` command, like so:

Expand Down
6 changes: 3 additions & 3 deletions docs/source/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ apollo service:push --serviceName users

## Rover ##
# (no config file needed)
# globs don't work natively with Rover, so you can use `cat` to combine
# multiple files on *nix machines
cat *.graphql | rover subgraph publish my-graph@prod --name users --schema -
# globs don't work natively with Rover, so you can use a command like `awk 1`
# to combine multiple files on *nix machines
awk 1 *.graphql | rover subgraph publish my-graph@prod --name users --schema -
```
2 changes: 2 additions & 0 deletions docs/source/subgraphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Rover commands that interact with subgraphs begin with `rover subgraph`.

## Fetching a subgraph schema

These commands enable you to fetch the schema for a single subgraph in a federated graph. To instead fetch your gateway's composed supergraph schema, use the corresponding [`rover graph` commands](./graphs/).

### Fetching from Apollo Studio

> This requires first [authenticating Rover with Apollo Studio](./configuring/#authenticating-with-apollo-studio).
Expand Down