Skip to content
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

Implement @Interface and @compose decorators #3

Open
wants to merge 1 commit into
base: feature/graphql
Choose a base branch
from

Conversation

steverice
Copy link

The @compose decorator is used to indicate that a GraphQL type or interface implements one or more interfaces.

As defined by the GraphQL spec, a type or interface implementing an interface must contain all the properties defined by that interface, and so we require that the TypeSpec model implement the interface's properties as well. There is no restriction on how this is accomplished (via spread, via composition, via manual copying of properties, etc).

To reduce confusion, we do not allow a TypeSpec model to define both a type and an interface. In order to define an interface, the model must be decorated with the @Interface decorator.

@steverice steverice requested a review from swatkatz as a code owner November 22, 2024 19:32
@steverice steverice changed the base branch from schema-decorator to feature/graphql November 26, 2024 19:52
The `@compose` decorator is used to indicate that a GraphQL `type` or `interface` implements one or more interfaces.

As [defined by the GraphQL spec](https://spec.graphql.org/October2021/#sec-Interfaces), a `type` or `interface` implementing an interface must contain all the properties defined by that interface, and so we require that the TypeSpec model implement the interface's properties as well. There is no restriction on how this is accomplished (via spread, via composition, via manual copying of properties, etc).

To reduce confusion, we do not allow a TypeSpec model to define both a `type` and an `interface`. In order to define an `interface`, the model must be decorated with the `@Interface` decorator.
@steverice steverice force-pushed the interface-and-compose branch from 8ddde71 to 15399b4 Compare November 26, 2024 19:52
Copy link

@AngelEVargas AngelEVargas left a comment

Choose a reason for hiding this comment

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

LGTM

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

Successfully merging this pull request may close these issues.

2 participants