Skip to content

Commit

Permalink
chore: apply style guide rules from #610
Browse files Browse the repository at this point in the history
  • Loading branch information
EverlastingBugstopper committed Aug 20, 2021
1 parent 4baa603 commit 8f9e4ad
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ By default, Rover will print the main output of its commands to `stdout` in plai
### `--output json`

If you would like more programmatic control over Rover's output, you can pass `--output json` to any command. The JSON structure is very similar to those you may be used to working with from GraphQL APIs, but instead of multiple errors at the top level, there is only one.
If you would like more programmatic control over Rover's output, you can pass `--output json` to any command. The JSON structure is very similar to those you might be used to working with from GraphQL APIs, but instead of multiple errors at the top level, there is only one.

#### Minimal JSON examples

Expand Down Expand Up @@ -169,7 +169,7 @@ Example failure output for `rover subgraph publish`:
}
```

You can see here that the `error` object contains two string fields, `message`, and `code`. In your scripts you should be able to gracefully handle errors by matching on the codes instead of the error messages themselves (as those strings are subject to change without bumping the `json_version`).
You can see here that the `error` object contains two string fields, `message`, and `code`. In your scripts you should be able to gracefully handle errors by matching on the codes instead of the error messages themselves. Error message strings are subject to change without bumping `json_version`.

This particular error also includes some extra `details` about what exactly went wrong with this particular operation. You'll notice that even though errors occurred while executing this operation, `.data.success` is still `true`. The error details themselves are build errors associated with building the supergraph. While the supergraph wasn't updated, the subgraph publish itself was successful.

Expand Down

0 comments on commit 8f9e4ad

Please sign in to comment.