Package io.smallrye.graphql.api.federation

Annotation Interface Requires

@Description("Indicates that the resolver for a particular entity field depends on the values of other entity fields that are resolved by other subgraphs. This tells the graph router that it needs to fetch the values of those externally defined fields first, even if the original client query didn\'t request them.") @Retention(RUNTIME) @Experimental("SmallRye GraphQL Federation is still subject to change.") public @interface Requires
directive @requires(fields: FieldSet!) on FIELD_DEFINITION
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    @NonNull FieldSet
    fields
     

  • Element Details

    • fields

      @NonNull @Description("A GraphQL selection set (provided as a string) of @external object fields and subfields that this field requires.\nExamples:\n\"name\"\n\"name address\"\n\"name organization { id }\"") @NonNull FieldSet fields