Add @tag documentation #2033
Closed
Add @tag documentation #2033
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for apollo-federation-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
jeffjakub
requested review from
benweatherman and
StephenBarlow
and removed request for
StephenBarlow
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
StephenBarlow
approved these changes
Aug 4, 2022
| directive @tag(from: String!) on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION | ||
| ``` | ||
|
|
||
| The `@tag` directive is used to provide a mechanism for applying arbitrary string metadata to the fields and types of a schema. Tags will be propagated up into composed supergraphs. This metadata is potentially useful throughout the schema’s lifecycle, including, but not limited to, processing, static analysis, and documentation. |
There was a problem hiding this comment.
Suggested change
| The `@tag` directive is used to provide a mechanism for applying arbitrary string metadata to the fields and types of a schema. Tags will be propagated up into composed supergraphs. This metadata is potentially useful throughout the schema’s lifecycle, including, but not limited to, processing, static analysis, and documentation. | |
| The `@tag` directive provides a mechanism for applying arbitrary string metadata to a schema's types and fields. This metadata can be useful throughout the schema’s lifecycle, including (but not limited to) processing, static analysis, and documentation. | |
| Tags applied in subgraph schemas are preserved in the composed supergraph schema. |
|
|
||
| ```graphql | ||
| extend schema | ||
| @link(url: "https://specs.apollo.dev/federation/v2.0", import: [""@tag"]) |
There was a problem hiding this comment.
Suggested change
| @link(url: "https://specs.apollo.dev/federation/v2.0", import: [""@tag"]) | |
| @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@tag"]) |
benweatherman
suggested changes
Aug 4, 2022
| ### `@tag` | ||
|
|
||
| ```graphql | ||
| directive @tag(from: String!) on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION |
There was a problem hiding this comment.
blocker This should be marked as repeatable and the input param is called name, to align with what's in code / the spec https://specs.apollo.dev/tag/v0.2/#@tag
Suggested change
| directive @tag(from: String!) on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION | |
| directive @tag(name: String!) repeatable on FIELD_DEFINITION | INTERFACE | OBJECT | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION |
| type Customer implements User @tag(name: "team-customers") { | ||
| id: String! | ||
| name: String! | ||
| cart: [Product!] @tag(name: "team-shopping-cart") |
There was a problem hiding this comment.
suggestion type Product isn't defined in this schema. Just so we can make sure these examples compose, maybe it would be best to remove this field and put a tag on a different field.
Suggested change
| cart: [Product!] @tag(name: "team-shopping-cart") |
benweatherman
changed the title
|
All directive descriptions have been removed from this doc in favor of the "Federation-specific directives" article, so I'm going to recreate this content targeting that article in a separate PR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1972