Skip to content

docs(directives): add @external directive page #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

BrendanBondurant
Copy link
Member

Add documentation for the @external directive used in GraphQL Federation (v1 and v2).

The directives pages were requested by Max at K Health so he can stop using Apollo's docs.

@@ -0,0 +1,268 @@
---
title: '@external'
description: Marks a field or type as declared in this subgraph but resolved by another. Enables use in `@requires`, `@provides`, or interface implementations.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please replace this with
@external serves multiple functions depending on how it is used and what federation version the subgraph defining it is.

icon: "link"
---

Supported in both Federation v1 and v2, though usage and validation rules differ between versions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we typically write these as capitals (V1 and V2)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can differ.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants