Skip to content

Commit 794497d

Browse files
authored
Update license requirements (#3296)
<!-- First, 🌠 thank you 🌠 for taking the time to consider a contribution to Apollo! Here are some important details to follow: * ⏰ Your time is important To save your precious time, if the contribution you are making will take more than an hour, please make sure it has been discussed in an issue first. This is especially true for feature requests! * 💡 Features Feature requests can be created and discussed within a GitHub Issue. Be sure to search for existing feature requests (and related issues!) prior to opening a new request. If an existing issue covers the need, please upvote that issue by using the 👍 emote, rather than opening a new issue. * 🕷 Bug fixes These can be created and discussed in this repository. When fixing a bug, please _try_ to add a test which verifies the fix. If you cannot, you should still submit the PR but we may still ask you (and help you!) to create a test. * Federation versions Please make sure you're targeting the federation version you're opening the PR for. Federation 2 (alpha) is currently located on the `main` branch and prior versions of Federation live on the `version-0.x` branch. * 📖 Contribution guidelines Follow https://github.com/apollographql/federation/blob/HEAD/CONTRIBUTING.md when submitting a pull request. Make sure existing tests still pass, and add tests for all new behavior. * ✏️ Explain your pull request Describe the big picture of your changes here to communicate to what your pull request is meant to accomplish. Provide 🔗 links 🔗 to associated issues! We hope you will find this to be a positive experience! Open source contribution can be intimidating and we hope to alleviate that pain as much as possible. Without following these guidelines, you may be missing context that can help you succeed with your contribution, which is why we encourage discussion first. Ultimately, there is no guarantee that we will be able to merge your pull-request, but by following these guidelines we can try to avoid disappointment. --> Updates documentation to reflect feature tiering changes made in the [recent router release](https://github.com/apollographql/router/releases/tag/v2.6.0). References: - [Product's feature tiering matrix](https://docs.google.com/document/d/13wh3NBmBnSPKBCH1f19eir-caWbz6Y9wKEHItXq6l1c/edit?tab=t.7kwmpu4gs3p#heading=h.37ncslwgnmfs) - [Additional feedback from product](https://docs.google.com/document/d/1ea30pyaIAaBg4xTUXuUDDa3w16fhhR7KvEm3QQNE-D8/edit?tab=t.pyvj315sx3ne#heading=h.gx3p2h7ez2ov) ### Testing Ran the docs site locally using `librarian.local.config.mts` file with override for the `federation` repository. Specifically, the following pages were checked: - http://localhost:3000/docs/graphos/connectors/reference/directives - http://localhost:3000/docs/graphos/schema-design/federated-schemas/entities/use-contexts - http://localhost:3000/docs/graphos/schema-design/federated-schemas/entities/migrate-fields#incremental-migration-with-progressive-override
1 parent e17173b commit 794497d

File tree

5 files changed

+9
-33
lines changed

5 files changed

+9
-33
lines changed

docs/shared/licensed-directive.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<PlanRequired plans={["Free", "Developer", "Standard", "Enterprise"]}>
2+
3+
Rate limits apply on the Free plan.
4+
5+
</PlanRequired>

docs/shared/progressive-override-enterprise.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/source/schema-design/federated-schemas/entities/migrate-fields.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ subtitle: Transfer entity fields from one subgraph to another
44
description: Learn how to safely move parts of one subgraph to another subgraph in a federated GraphQL architecture using the @override directive.
55
---
66

7-
import ProgressiveOverrideEnterprise from '../../../../shared/progressive-override-enterprise.mdx';
8-
97
As your supergraph grows, you might want to move parts of one subgraph to another subgraph.
108
For example, suppose your Payments subgraph defines a `Bill` entity:
119

@@ -160,8 +158,6 @@ After you deploy the Billing subgraph and publish this final schema change, you'
160158

161159
<MinVersionBadge version="Federation v2.7" />
162160

163-
<ProgressiveOverrideEnterprise/>
164-
165161
Follow these steps to incrementally migrate a field from one subgraph to another.
166162
These steps use the `amount` field in the example Payments and Billing subgraphs described at the top of the page, but you can them with any entity field(s).
167163

docs/source/schema-design/federated-schemas/entities/use-contexts.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@ description: Use the @context and @fromContext directives to enable a subgraph t
55
minVersion: Federation v2.8
66
---
77

8-
<EnterpriseFeature>
9-
10-
The `@context` and `@fromContext` directives are [Enterprise features](https://www.apollographql.com/pricing) of the Apollo Router and require an organization with a [GraphOS Enterprise plan](https://www.apollographql.com/pricing/). If your organization doesn't have an Enterprise plan, you can test it out by signing up for a free [Enterprise trial](https://studio.apollographql.com/signup?referrer=docs).
11-
12-
</EnterpriseFeature>
13-
148
In an entity, a nested object may have a dependency on an ancestor type and thus need access to that ancestor's field(s).
159

1610
To enable a descendant to access an ancestor's field, you could add it as a `@key` field to every entity along the chain of nested types, but that can become problematic. Deeply nested types can change the `@key` fields of many entities. The added field may be irrelevant to the entities it's added to. Most importantly, overloading `@key` fields often breaks the separation of concerns between different subgraphs.

docs/source/schema-design/federated-schemas/reference/directives.mdx

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ subtitle: Reference for Apollo Federation specific GraphQL directives
44
description: Reference for GraphQL federation directives including @key, @extends, @sharable, @override, @requires and more.
55
---
66

7-
import ProgressiveOverrideEnterprise from '../../../../shared/progressive-override-enterprise.mdx';
87
import EnterpriseDirective from '../../../../shared/enterprise-directive.mdx';
8+
import LicensedDirective from '../../../../shared/licensed-directive.mdx';
99
import LinkDirective from '../../../../shared/link-directive.mdx';
1010

1111
Apollo Federation defines a collection of directives that you use in your subgraph schemas to enable certain features.
@@ -379,8 +379,6 @@ For more information, see [Migrating entity and root fields](/graphos/schema-des
379379

380380
<MinVersionBadge version="Federation v2.7" />
381381

382-
<ProgressiveOverrideEnterprise/>
383-
384382
Rolling out any change to a production subgraph, including field migration, risks degrading the performance of your graph. Rerouting all traffic from one subgraph to another all at once could overload the overriding subgraph.
385383

386384
The _progressive `@override`_ feature enables the gradual, progressive deployment of a subgraph with an `@override` field. As a subgraph developer, you can customize the percentage of traffic that the overriding and overridden subgraphs each resolve for a field. You apply a label to an `@override` field to set the percentage of traffic for the field that should be resolved by the overriding subgraph, with the remaining percentage resolved by the overridden subgraph. You can then monitor the performance of the subgraphs in Studio, resolve any issues, and iteratively and progressively increase the percentage until all traffic is resolved by the overriding subgraph.
@@ -426,12 +424,6 @@ To learn more, see the [Incremental migration with `@override`](/graphos/schema-
426424
</td>
427425
<td>
428426

429-
<EnterpriseFeature>
430-
431-
This argument is available in Apollo Federation 2.7 and later. It is an [Enterprise feature](https://www.apollographql.com/pricing) of the GraphOS Router and requires an organization with a [GraphOS Enterprise plan](https://www.apollographql.com/pricing/). You can test it out by signing up for a free [Enterprise trial](https://studio.apollographql.com/signup?referrer=docs).
432-
433-
</EnterpriseFeature>
434-
435427
**Optional.** A string of arbitrary arguments. Supported in this release:
436428
- `percent(<percent-value>)` - The percentage of traffic for the field that's resolved by this subgraph. The remaining percentage is resolved by the other ([from](#from)) subgraph. To learn more, see [Incremental migration with `@override`](/graphos/schema-design/federated-schemas/entities/migrate-fields#incremental-migration-with-progressive-override).
437429

@@ -447,7 +439,7 @@ This argument is available in Apollo Federation 2.7 and later. It is an [Enterpr
447439

448440
<MinVersionBadge version="Federation v2.5" />
449441

450-
<EnterpriseDirective />
442+
<LicensedDirective />
451443

452444

453445
```graphql
@@ -465,7 +457,7 @@ Indicates to composition that the target element is accessible only to the authe
465457

466458
<MinVersionBadge version="Federation v2.5" />
467459

468-
<EnterpriseDirective />
460+
<LicensedDirective />
469461

470462
```graphql
471463
directive @requiresScopes(scopes: [[federation__Scope!]!]!) on
@@ -895,8 +887,6 @@ If different subgraphs use different versions of a directive's corresponding spe
895887

896888
<MinVersionBadge version="Federation v2.8" />
897889

898-
<EnterpriseFeature />
899-
900890
The `@context` directive defines a named context from which a field of the annotated type can be passed to a receiver of the context. The receiver must be a field annotated with the `@fromContext` directive.
901891

902892
```graphql
@@ -928,8 +918,6 @@ type U @key(fields: "id") {
928918

929919
<MinVersionBadge version="Federation v2.8" />
930920

931-
<EnterpriseFeature />
932-
933921
The `@fromContext` directive sets the context from which to receive the value of the annotated field. The context must have been defined with the `@context` directive.
934922

935923
```graphql
@@ -958,7 +946,7 @@ For examples using `@context` and `@fromContext`, see [Using contexts to share d
958946

959947
<MinVersionBadge version="Federation v2.9" />
960948

961-
<EnterpriseFeature />
949+
<LicensedDirective />
962950

963951
```graphql
964952
directive @cost(weight: Int!) on ARGUMENT_DEFINITION | ENUM | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | OBJECT | SCALAR
@@ -1163,6 +1151,4 @@ The default value is `true`.
11631151

11641152
<MinVersionBadge version="Federation v2.10" />
11651153

1166-
<EnterpriseFeature />
1167-
11681154
Directives for Connectors like `@connect` and `@source` are documented in [Connector Directives Reference](/graphos/schema-design/connectors/directives).

0 commit comments

Comments
 (0)