Skip to content

Commit 79dacd0

Browse files
authored
Merge pull request #7897 from apollographql/docs/update-router-terminology
docs: update router terminology
2 parents 33b3e51 + a62c8aa commit 79dacd0

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

docs/source/api/plugin/subscription-callback.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ api_reference: true
44
minVersion: 4.9.0
55
---
66

7-
This document covers the usage of the subscription callback plugin for use in Apollo Federation with Apollo Router. For more information about the protocol itself, see the [subscription callback protocol](/router/executing-operations/subscription-callback-protocol).
7+
This document covers the usage of the subscription callback plugin for use in Apollo Federation with GraphOS Router. For more information about the protocol itself, see the [subscription callback protocol](/router/executing-operations/subscription-callback-protocol).
88

99
> ⚠️ **Note**: The subscription callback protocol is currently in [preview](/resources/product-launch-stages#preview). Breaking changes might be introduced during the preview period.
1010
1111
## Using the plugin
1212

1313
This article documents the options for the `ApolloServerPluginSubscriptionCallback` plugin, which you can import from `@apollo/server/plugin/subscriptionCallback`.
1414

15-
This plugin enables your GraphQL server to respond to [subscription operations](/apollo-server/data/subscriptions/) using the [subscription callback protocol](https://www.apollographql.com/docs/router/executing-operations/subscription-callback-protocol/#initialization). Apollo Router uses this protocol to execute subscription operations and receive updates at a URL specified by the router.
15+
This plugin enables your GraphQL server to respond to [subscription operations](/apollo-server/data/subscriptions/) using the [subscription callback protocol](https://www.apollographql.com/docs/router/executing-operations/subscription-callback-protocol/#initialization). GraphOS Router uses this protocol to execute subscription operations and receive updates at a URL specified by the router.
1616

1717
This feature can only be enabled by providing an `ApolloServerPluginSubscriptionCallback` instance to your `ApolloServer` constructor:
1818

@@ -58,7 +58,7 @@ The subscription plugin implementation inherently bypasses Apollo Server's reque
5858
</td>
5959
<td>
6060

61-
Optionally configure the heartbeat interval in milliseconds. The default is 5 seconds, which is the interval that Apollo Router expects. Lengthening this interval may cause Apollo Router to invalidate existing subscriptions frequently and is not recommended. You may want to shorten this interval if you have latency issues between your GraphQL Server and Apollo Router.
61+
Optionally configure the heartbeat interval in milliseconds. The default is 5 seconds, which is the interval that GraphOS Router expects. Lengthening this interval may cause GraphOS Router to invalidate existing subscriptions frequently and is not recommended. You may want to shorten this interval if you have latency issues between your GraphQL Server and GraphOS Router.
6262

6363
</td>
6464
</tr>
@@ -86,7 +86,7 @@ Optionally provide a [`Logger`](https://www.npmjs.com/package/@apollo/utils.logg
8686
</td>
8787
<td>
8888

89-
This plugin uses the `async-retry` module to retry failed requests to Apollo Router. You can optionally provide an `Options` object to configure the retry behavior. The configuration options for `async-retry` can be found in the [README](https://www.npmjs.com/package/async-retry).
89+
This plugin uses the `async-retry` module to retry failed requests to GraphOS Router. You can optionally provide an `Options` object to configure the retry behavior. The configuration options for `async-retry` can be found in the [README](https://www.npmjs.com/package/async-retry).
9090

9191
The default configuration provided by this plugin is:
9292
```ts

docs/source/api/plugin/usage-reporting.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ api_reference: true
88
99
Apollo Server's built-in usage reporting plugin gathers data on how your clients use the operations and fields in your GraphQL schema. The plugin also handles pushing this usage data to [GraphOS](/graphos/), as described in [Metrics and logging](../../monitoring/metrics/).
1010

11-
This plugin is designed to be used in an Apollo Gateway or in a monolithic server; it is not designed to be used from a subgraph. In a supergraph running Apollo Federation, the Apollo Gateway or Apollo Router will send usage reports to Apollo's cloud. Subgraphs don't need to also send usage reports to Apollo's cloud; instead, they send it to the Router via [inline traces](./inline-trace/) and the Router combines execution information across all subgraphs and sends summarized reports to the cloud.
11+
This plugin is designed to be used in an Apollo Gateway or in a monolithic server; it is not designed to be used from a subgraph. In a supergraph running Apollo Federation, the Apollo Gateway or GraphOS Router will send usage reports to Apollo's cloud. Subgraphs don't need to also send usage reports to Apollo's cloud; instead, they send it to the Router via [inline traces](./inline-trace/) and the Router combines execution information across all subgraphs and sends summarized reports to the cloud.
1212

1313
## Default installation
1414

docs/source/migration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1808,7 +1808,7 @@ new ApolloServer({
18081808

18091809
### Usage reporting plugin is off by default on subgraphs
18101810

1811-
In an Apollo Federation supergraph, your Apollo Gateway or Apollo Router sends [usage reports](./api/plugin/usage-reporting/) to Apollo's servers; information about what happens inside individual subgraph servers is sent from the subgraphs to the Gateway or Router via [inline traces](./api/plugin/inline-trace/). That is to say: the usage reporting plugin is *not* designed for use in federated subgraphs.
1811+
In an Apollo Federation supergraph, your Apollo Gateway or GraphOS Router sends [usage reports](./api/plugin/usage-reporting/) to Apollo's servers; information about what happens inside individual subgraph servers is sent from the subgraphs to the Gateway or Router via [inline traces](./api/plugin/inline-trace/). That is to say: the usage reporting plugin is *not* designed for use in federated subgraphs.
18121812

18131813
In Apollo Server 3, if you provide an Apollo API key and graph ref and do not explicitly install the `ApolloServerPluginUsageReporting` or `ApolloServerPluginUsageReportingDisabled` plugins, the `ApolloServerPluginUsageReporting` plugin will be installed with its default configuration, even if the server is a subgraph.
18141814

docs/source/security/authentication.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Your GraphQL API probably needs to control which users can see and interact with
1212

1313
<Tip>
1414

15-
Apollo Router can now provide authentication and authorization for your entire supergraph. While it may make sense to re-apply auth checks at a subgraph level or in a monolith graph, the Apollo Router has built and provided standard JWT checks that can be setup with a simple YAML configuration and enforce this in a central location for all subgraphs:
15+
GraphOS Router can now provide authentication and authorization for your entire supergraph. While it may make sense to re-apply auth checks at a subgraph level or in a monolith graph, the GraphOS Router has built and provided standard JWT checks that can be setup with a simple YAML configuration and enforce this in a central location for all subgraphs:
1616

1717
https://www.apollographql.com/blog/centrally-enforce-policy-as-code-for-graphql-apis
1818

docs/source/using-federation/api/apollo-gateway.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ api_reference: true
55

66
This API reference documents the exports from the `@apollo/gateway` package. This package enables you to use Apollo Server as a gateway for a federated supergraph. For more information, see [Implementing a gateway with Apollo Server](../apollo-gateway-setup).
77

8-
> We recommend that all supergraphs use the Apollo Router instead of this Node.js-based gateway. See [Choosing a router library](/federation/building-supergraphs/router/#choosing-a-router-library).
8+
> We recommend that all supergraphs use the GraphOS Router instead of this Node.js-based gateway. See [Choosing a router library](/federation/building-supergraphs/router/#choosing-a-router-library).
99
1010
## `class ApolloGateway`
1111

docs/source/using-federation/apollo-gateway-setup.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ After you set up at least one federation-ready [subgraph](/federation/building-s
99

1010
<FederationArchitecture />
1111

12-
> 📣 In the majority of cases, **we recommend using [the Apollo Router](/federation/building-supergraphs/router) as your graph router.** It's faster to configure, it's more performant (especially with high request loads), and it rarely requires writing custom code.
12+
> 📣 In the majority of cases, **we recommend using [the GraphOS Router](/federation/building-supergraphs/router) as your graph router.** It's faster to configure, it's more performant (especially with high request loads), and it rarely requires writing custom code.
1313
14-
In certain cases, you might need to use Apollo Server as your graph router if your subgraphs use a custom authentication method that is currently difficult to configure with the Apollo Router.
14+
In certain cases, you might need to use Apollo Server as your graph router if your subgraphs use a custom authentication method that is currently difficult to configure with the GraphOS Router.
1515

1616
Regardless of which graph router library you start with, you can swap to the other without making any changes to other parts of your supergraph.
1717

0 commit comments

Comments
 (0)