Skip to content

Commit

Permalink
Update docs for absolute paths
Browse files Browse the repository at this point in the history
  • Loading branch information
WolffRuoff committed Oct 17, 2023
1 parent 93eb633 commit b1fad27
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This extension requires a `supergraph.json` file at `.rover-runner/supergraph.js
{
"subgraphs": {
"Subgraph1": {
"path": "",
"path": "/Users/name/Desktop/repos/subgraph",
"localUrl": "http://localhost:3000/graphql"
},
"Subgraph2": {
Expand All @@ -40,7 +40,7 @@ This extension requires a `supergraph.json` file at `.rover-runner/supergraph.js
```
Some notes about this format:
- `Subgraph1`, `Subgraph2`, etc are the subgraph names and should match the names in Apollo Studio
- `path` is the relative path to the subgraph from the workspace root. If this is blank like in `Subgraph1`, then you need to run the subgraph on its own
- `path` is the path to the subgraph. It can either be a relative path from the workspace root like in `Subgraph2` or an absolute path like in `Subgraph1`.
- `localUrl` is the graphQL endpoint when running the subgraph locally
- `devUrl` is the graphQL endpoint for the GraphQL variant. This field is optional as the extension will grab the endpoint from Apollo Studio by default

Expand Down
2 changes: 1 addition & 1 deletion src/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const sampleSupergraphJson = {
subgraphs: {
// eslint-disable-next-line @typescript-eslint/naming-convention
Subgraph1: {
path: '',
path: '/Users/name/Desktop/repos/subgraph',
localUrl: 'http://localhost:3000/graphql',
},
// eslint-disable-next-line @typescript-eslint/naming-convention
Expand Down

0 comments on commit b1fad27

Please sign in to comment.