Skip to content

Commit af6cba8

Browse files
authored
Updates documentation for policy and listSize directives (#3297)
<!-- 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/schema-design/federated-schemas/reference/directives#listsize - http://localhost:3000/docs/graphos/schema-design/federated-schemas/reference/directives#policy
1 parent 92ad462 commit af6cba8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ Indicates to composition that the target element is accessible only to the authe
504504

505505
<MinVersionBadge version="Federation v2.6" />
506506

507-
<EnterpriseDirective />
507+
<LicensedDirective />
508508

509509
```graphql
510510
directive @policy(policies: [[federation__Policy!]!]!) on
@@ -993,7 +993,7 @@ Regardless of whether `@cost` is specified on a field, the field cost for that f
993993

994994
<MinVersionBadge version="Federation v2.9" />
995995

996-
<EnterpriseFeature />
996+
<LicensedDirective />
997997

998998
```graphql
999999
directive @listSize(assumedSize: Int, slicingArguments: [String!], sizedFields: [String!], requireOneSlicingArgument: Boolean = true) on FIELD_DEFINITION

0 commit comments

Comments
 (0)