You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/api/express-middleware.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The `expressMiddleware` function enables you to attach Apollo Server to an Expre
15
15
16
16
The `expressMiddleware` function expects you to set up HTTP body parsing and CORS headers for your web framework. Specifically, you should install the [`body-parser`](https://www.npmjs.com/package/body-parser) and [`cors`](https://www.npmjs.com/package/cors) packages and use them to set up your Express app, as shown below.
17
17
18
-
> See [Configuring CORS](../../security/cors#specifying-origins) for guidance on configuring the CORS behavior of your project.
18
+
> See [Configuring CORS](../security/cors#specifying-origins) for guidance on configuring the CORS behavior of your project.
19
19
20
20
The `expressMiddleware` function accepts two arguments. The first **required** argument is an instance of `ApolloServer` that has been `start`ed:
Copy file name to clipboardExpand all lines: docs/source/api/plugin/landing-pages.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,13 +55,13 @@ Available configuration options are listed in each plugin's reference below.
55
55
56
56
## Default non-production landing page
57
57
58
-
In non-production environments, Apollo Server 4's landing page is an embedded version of [Apollo Sandbox](/studio/explorer/sandbox) (served at `http://localhost:4000` by default):
58
+
In non-production environments, Apollo Server 4's landing page is an embedded version of [Apollo Sandbox](/graphos/explorer/sandbox) (served at `http://localhost:4000` by default):
This landing page is designed for use in local development, where `NODE_ENV` is *not* set to `production`.
63
63
64
-
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/studio/explorer/explorer), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
64
+
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/graphos/explorer/explorer), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
65
65
### Options
66
66
67
67
<tableclass="field-table">
@@ -177,7 +177,7 @@ If you omit this, the Explorer defaults `includeCookies` to `false` or the curre
177
177
</td>
178
178
<td>
179
179
180
-
If `true`, the Apollo Server landing page renders an embedded version of [Apollo Sandbox](/studio/explorer/sandbox/) at its GraphQL endpoint URL. This is the default behavior.
180
+
If `true`, the Apollo Server landing page renders an embedded version of [Apollo Sandbox](/graphos/explorer/sandbox/) at its GraphQL endpoint URL. This is the default behavior.
181
181
182
182
If you set this option to `false`, your server's landing page is a splash page containing a copyable command-line snippet showing how to run operations via `curl` alongside a link to Apollo Sandbox.
183
183
@@ -194,7 +194,7 @@ The `ApolloServerPluginLandingPageProductionDefault` shows a minimalist landing
194
194
195
195
<imgclass="screenshot"src="../../images/as-landing-page-production.jpg"alt="Apollo Server default landing page"width="350"/>
196
196
197
-
This landing page is designed for use in production. It provides a copyable command-line snippet showing how to run operations with your server. By default, the only visible reference to Apollo is a footer explaining how to customize the page. You can also configure it to add a link to query your graph with the [Apollo Explorer](https://www.apollographql.com/docs/studio/explorer). You can choose to embed the Apollo Explorer on your endpoint if you pass the `embed`[option](#embed-options).
197
+
This landing page is designed for use in production. It provides a copyable command-line snippet showing how to run operations with your server. By default, the only visible reference to Apollo is a footer explaining how to customize the page. You can also configure it to add a link to query your graph with the [Apollo Explorer](/graphos/explorer/explorer/). You can choose to embed the Apollo Explorer on your endpoint if you pass the `embed`[option](#embed-options).
198
198
199
199
### Options
200
200
@@ -461,7 +461,7 @@ The default value is `dark`.
461
461
462
462
## GraphQL Playground landing page
463
463
464
-
By default, Apollo Server 2 provided a GraphQL Playground landing page. For migration purposes, we've published the [`@apollo/server-plugin-landing-page-graphql-playground`](https://www.npmjs.com/package/@apollo/server-plugin-landing-page-graphql-playground) package, a GraphQL Playground plugin compatible with Apollo Server 4. However, we aren't supporting this plugin with documentation or security updates since the GraphQL Playground project is officially [retired](https://github.com/graphql/graphql-playground/issues/1143) and we do not recommend its continued use. Instead, we recommend migrating to the actively maintained [Apollo Sandbox](/studio/explorer/sandbox) (the default landing page in Apollo Server 4) at your earliest convenience.
464
+
By default, Apollo Server 2 provided a GraphQL Playground landing page. For migration purposes, we've published the [`@apollo/server-plugin-landing-page-graphql-playground`](https://www.npmjs.com/package/@apollo/server-plugin-landing-page-graphql-playground) package, a GraphQL Playground plugin compatible with Apollo Server 4. However, we aren't supporting this plugin with documentation or security updates since the GraphQL Playground project is officially [retired](https://github.com/graphql/graphql-playground/issues/1143) and we do not recommend its continued use. Instead, we recommend migrating to the actively maintained [Apollo Sandbox](/graphos/explorer/sandbox) (the default landing page in Apollo Server 4) at your earliest convenience.
Copy file name to clipboardExpand all lines: docs/source/api/plugin/usage-reporting.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -191,7 +191,7 @@ By default, all requests are included in usage reports.
191
191
</td>
192
192
<td>
193
193
194
-
Specify this function to provide Apollo Studio with client details for each processed request. Apollo Studio uses this information to [segment metrics by client](/studio/metrics/client-awareness/).
194
+
Specify this function to provide Apollo Studio with client details for each processed request. Apollo Studio uses this information to [segment metrics by client](/graphos/metrics/client-awareness/).
195
195
196
196
This function is passed a [`GraphQLRequestContext`](https://github.com/apollographql/apollo-server/blob/6b4945935a786d06e7ff904be94c0035fe27aeb1/packages/server/src/externalTypes/graphql.ts#L47) object containing all available information about the request. It should return an object with `clientName` and `clientVersion` fields that identify the associated client.
> ⚠️ **Running into an error?** If you're using the `graphql-ws` library, your specified subscription protocol must be consistent across your backend, frontend, and **every other tool** you use (including [Apollo Sandbox](/studio/explorer/additional-features/#subscription-support)). For more information, see [Switching from `subscriptions-transport-ws`](#switching-from-subscriptions-transport-ws).
208
+
> ⚠️ **Running into an error?** If you're using the `graphql-ws` library, your specified subscription protocol must be consistent across your backend, frontend, and **every other tool** you use (including [Apollo Sandbox](/graphos/explorer/additional-features/#subscription-support)). For more information, see [Switching from `subscriptions-transport-ws`](#switching-from-subscriptions-transport-ws).
> If you don't see the result of your subscription operation you might need to [adjust your Sandbox settings to use the `graphql-ws` protocol](/studio/explorer/additional-features/#subscription-support).
414
+
> If you don't see the result of your subscription operation you might need to [adjust your Sandbox settings to use the `graphql-ws` protocol](/graphos/explorer/additional-features/#subscription-support).
415
415
416
416
After you start up the server in CodeSandbox, follow the instructions in the browser to test running the `numberIncremented` subscription in Apollo Sandbox. You should see the subscription's value update every second.
417
417
@@ -611,19 +611,19 @@ If you intend to [switch from `subscriptions-transport-ws` to `graphql-ws`](/apo
611
611
<tr>
612
612
<td>
613
613
614
-
[Apollo Studio Explorer](/studio/explorer/explorer/)
614
+
[Apollo Studio Explorer](/graphos/explorer/explorer/)
Copy file name to clipboardExpand all lines: docs/source/deployment/heroku.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ Then from the app's detail page, select the **Deploy** tab. On that tab, you can
123
123
124
124
To enable the production mode of Apollo Server, you need to set the `NODE_ENV` variable to `production`. To ensure you have visibility into your GraphQL performance in Apollo Studio, you'll want to add the `APOLLO_KEY` environment variable to Heroku. For the API key, log in to [Apollo Studio](https://studio.apollographql.com) and navigate to your graph or create a new one.
125
125
126
-
Under your Heroku app's Settings tab, click **Reveal Config Vars**. Next, set `NODE_ENV` to `production` and [copy your graph API key](/studio/api-keys/#graph-api-keys) from Apollo Studio as the value for `APOLLO_KEY`.
126
+
Under your Heroku app's Settings tab, click **Reveal Config Vars**. Next, set `NODE_ENV` to `production` and [copy your graph API key](/graphos/api-keys/#graph-api-keys) from Apollo Studio as the value for `APOLLO_KEY`.
Copy file name to clipboardExpand all lines: docs/source/monitoring/metrics.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,19 +3,19 @@ title: Metrics and logging
3
3
description: How to monitor Apollo Server's performance
4
4
---
5
5
6
-
Apollo Server integrates seamlessly with [Apollo Studio](/studio) to help you monitor the execution of your GraphQL operations. Apollo Server additionally provides configurable mechanisms for logging each phase of a GraphQL operation.
6
+
Apollo Server integrates seamlessly with [Apollo GraphOS](/graphos/) to help you monitor the execution of your GraphQL operations. Apollo Server additionally provides configurable mechanisms for logging each phase of a GraphQL operation.
7
7
8
8
> Using Federation? Check out the documentation for [federated tracing](/federation/metrics/).
9
9
10
-
## Sending metrics to Apollo Studio
10
+
## Sending metrics to GraphOS
11
11
12
-
[Apollo Studio](/studio/) provides an integrated hub for all of your GraphQL performance data. It[aggregates and displays information](/studio/metrics/usage-reporting/) for your schema, queries, requests, and errors. You can also configure alerts that support [Slack](/studio/notification-setup/#slack) and [Datadog](/studio/metrics/datadog-integration/) integrations.
12
+
[Apollo GraphOS](/graphos/) provides an integrated hub for all of your GraphQL performance data, which you can view in Apollo Studio. Studio[aggregates and displays information](/graphos/metrics/usage-reporting/) for your schema, queries, requests, and errors. You can also configure alerts that support [Slack](/graphos/notifications/notification-setup/#slack) and [Datadog](/graphos/metrics/datadog-integration/) integrations.
13
13
14
-
### Connecting to Apollo Studio
14
+
### Connecting to GraphOS
15
15
16
-
To connect Apollo Server to Apollo Studio, first [obtain a graph API key](/studio/metrics/usage-reporting/#pushing-metrics-from-apollo-server). To provide this key to Apollo Server, assign it to the `APOLLO_KEY` environment variable in your server's environment.
16
+
To connect Apollo Server to GraphOS, first [obtain a graph API key](/graphos/api-keys#graph-api-keys). To provide this key to Apollo Server, assign it to the `APOLLO_KEY` environment variable in your server's environment.
17
17
18
-
Then associate your server instance with a particular graph ID and [graph variant](/studio/org/graphs/#managing-variants) by setting the `APOLLO_GRAPH_REF` environment variable.
18
+
Then associate your server instance with a particular graph ID and [graph variant](/graphos/graphs/overview/#variants) by setting the `APOLLO_GRAPH_REF` environment variable.
19
19
20
20
You can set environment variable values on the command line as seen below, or with the [`dotenv` npm package](https://www.npmjs.com/package/dotenv) (or similar).
21
21
@@ -33,7 +33,7 @@ By default, Apollo Server aggregates your traces and sends them in batches to St
33
33
34
34
### Identifying distinct clients
35
35
36
-
Apollo Studio's [client awareness feature](/studio/metrics/client-awareness/) enables you to view metrics for distinct versions
36
+
Apollo Studio's [client awareness feature](/graphos/metrics/client-awareness/) enables you to view metrics for distinct versions
37
37
of your clients. To enable this, your clients need to include some or all of the following identifying information in the headers of GraphQL requests they
Copy file name to clipboardExpand all lines: docs/source/security/cors.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ If you don't, while your personal computer is on your private network, a script
62
62
63
63
#### Federated subgraphs
64
64
65
-
If you're building a [federated graph](/federation/), we strongly recommend that _all_ of your production subgraph servers _disable_ CORS or limit your subgraph's origins to tools like the [Apollo Studio Explorer](/studio/explorer/embed-explorer/). Most subgraphs should _only_ allow communication from your gateways, and that communication doesn't involve a browser.
65
+
If you're building a [federated graph](/federation/), we strongly recommend that _all_ of your production subgraph servers _disable_ CORS or limit your subgraph's origins to tools like the [Apollo Studio Explorer](/graphos/explorer/embed-explorer/). Most subgraphs should _only_ allow communication from your gateways, and that communication doesn't involve a browser.
66
66
67
67
For more information, see [Securing your subgraphs](/federation/building-supergraphs/subgraphs-overview#securing-your-subgraphs).
Copy file name to clipboardExpand all lines: docs/source/workflow/build-run-queries.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
title: Build and run queries against Apollo Server
3
3
---
4
4
5
-
In non-production environments, Apollo Server 4's landing page is an embedded version of [Apollo Sandbox](/studio/explorer/sandbox) (served at `http://localhost:4000` by default):
5
+
In non-production environments, Apollo Server 4's landing page is an embedded version of [Apollo Sandbox](/graphos/explorer/sandbox) (served at `http://localhost:4000` by default):
> Apollo Server serves a different landing page [in production](#production-vs-non-production).
10
10
11
-
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/studio/explorer/explorer), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
11
+
[Apollo Sandbox](https://studio.apollographql.com/sandbox) is a special mode of Apollo Studio used for local development, which doesn't require an Apollo account. Sandbox includes the [Apollo Studio Explorer](/graphos/explorer/explorer), a powerful web IDE that enables you to build and run operations against your server (or any other reachable server).
12
12
13
13
## Production vs. non-production
14
14
@@ -113,4 +113,4 @@ const server = new ApolloServer({
Copy file name to clipboardExpand all lines: docs/source/workflow/generate-types.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Generating types from a GraphQL schema
3
3
description: How to ensure your resolvers are type safe
4
4
---
5
5
6
-
> 👋 If you haven't set up a TypeScript project using Apollo Server yet, follow our [Getting Started](../../getting-started) guide before continuing.
6
+
> 👋 If you haven't set up a TypeScript project using Apollo Server yet, follow our [Getting Started](../getting-started) guide before continuing.
7
7
8
8
GraphQL uses a type system to clearly define the available data for each type and field in a [GraphQL schema](../schema/schema). Type generation libraries can take advantage of the strongly-typed nature of a GraphQL schema to automatically generate TypeScript types based on that schema.
0 commit comments