Update README for serverless demo #98
Conversation
|
This branch is running in CodeSandbox. Use the links below to review this PR faster. |
| @@ -53,7 +53,7 @@ subscription PlaybackStateSubscriberSubscription { | |||
| } | |||
| ``` | |||
|
|
|||
| GraphOS Explorer also supports tabs. Open a new tab and try pausing the running subscription: | |||
| GraphOS Explorer also supports tabs. Open a new tab and run the operation below to pause the running subscription: | |||
There was a problem hiding this comment.
Clarify: new Explorer tab. This should be the same window tab as when we ran the subscription above, to better see that it did indeed get paused.
|
|
||
| > If you're new to Apollo, learn more about GraphOS in [our docs](https://www.apollographql.com/docs/studio/). |
There was a problem hiding this comment.
Removed so that they stay on the README page instead of getting distracted by the docs link.
| In creating this demo, we've set up GraphOS to work with two GraphQL APIs we have hosted for you: | ||
|
|
||
| - _spotify_: Exposes the Spotify REST API | ||
| - _spotify_: Exposes the [Spotify REST API](https://developer.spotify.com/documentation/web-api) | ||
| - _playback_: Exposes subscriptions for playback functionality coming from the Spotify REST API including the associated `mutation` operations |
There was a problem hiding this comment.
This description is a mouthful but I didn't change it because I wasn't sure which were the important bits. Can we simplify to just "Spotify playback functionality"?
|
|
||
| ```gql | ||
| query RootWebsiteQuery($offset: Int, $limit: Int) { | ||
| query RoolWebsiteQuery($offset: Int, $limit: Int) { |
There was a problem hiding this comment.
What is RoolWebsiteQuery?
There was a problem hiding this comment.
OH was it supposed to be "Root"? I worked off the string in the Studio UI page.
There was a problem hiding this comment.
But "RootWebsite" is still not clear to me 😅
There was a problem hiding this comment.
That is supposed to be the query that is used to load the initial page data. Any recommendations on what we would name there?
There was a problem hiding this comment.
Since this graph kind of exists outside of the client app, maybe we just name it what it's querying for? MyPlaylists?
(Shows up later on in the README as well)
| @@ -42,7 +40,7 @@ query RootWebsiteQuery($offset: Int, $limit: Int) { | |||
| } | |||
| ``` | |||
|
|
|||
| The Apollo Router also supports [GraphQL subscriptions](https://www.apollographql.com/docs/graphos/operations/subscriptions/)! | |||
| The [Apollo Router also supports GraphQL subscriptions](https://www.apollographql.com/docs/graphos/operations/subscriptions/)! | |||
There was a problem hiding this comment.
Possibly add something about what this operation is doing? I'm actually not sure what this was doing / what it's listening for.
| | `apollographql-client-version` | Increment this value with version numbers for your integration as its API usage changes. | | ||
| | Header name | Header value | | ||
| | ------------------------------ | ----------------------------------------------------------------------------------- | | ||
| | `apollographql-client-name` | The name of your client. | |
There was a problem hiding this comment.
Is this a correct change? "client" vs "integration"
| | Header name | Header value | | ||
| | ------------------------------ | ----------------------------------------------------------------------------------- | | ||
| | `apollographql-client-name` | The name of your client. | | ||
| | `apollographql-client-version` | Increment this value with version numbers for your client as its API usage changes. | |
There was a problem hiding this comment.
Possibly add something about this being enterprise-only?
There was a problem hiding this comment.
great catch, we'll remove this
|
|
||
| ## Adding a new GraphQL API to GraphOS | ||
|
|
||
| You can view all of the GraphQL APIs in the [subgraphs tab]({{ graph.url.subgraphs }}). Try adding SpaceX to the demo by using the "Add a subgraph" button. You'll use https://spacex-production.up.railway.app/ for the routing URL and it should be able to fetch the subgraph schema/ | ||
| You can view all of the GraphQL APIs in the Subgraphs page. |
There was a problem hiding this comment.
Removed the link here until the shortcode is implemented https://apollographql.atlassian.net/browse/NEBULA-2562
|
|
||
| ## Understanding the usage of your graph | ||
|
|
||
| The Apollo Router automatically collects usage information on your graph based on what fields are being requested from client applications. You can start diving into specific fields and their usage in the graph by heading to the [Fields tab]({{ graph.url.fields }}). | ||
| The Apollo Router automatically collects usage information on your graph based on what fields are being requested from client applications. You can start diving into specific fields and their usage in the graph by heading to the [Fields page]({{ graph.url.fields }}). |
There was a problem hiding this comment.
Made a lot of changes to refer to "page" instead of "tab"
|
|
||
| 📚 [The Apollo documentation](https://www.apollographql.com/docs/graphos) covers all things GraphOS. | ||
|
|
||
| ✏️ Learn through hands-on tutorials [available on Odyssey, our GraphQL learning platform](https://www.apollographql.com/tutorials/browse?categories=GraphOS). |
There was a problem hiding this comment.
Had to plug Odyssey :)
|
I'm not quite sure GitHub isn't letting me get to the checks steps on this so I can merge. I went ahead and included all these changes in a PR that adds the working demo scripts in PR #104 |
|
@michael-watson those checks are much better now and shouldn't block PRs anymore because they didn't run |
|
@michael-watson is this a PR that can be closed? |
No description provided.