Package io.smallrye.graphql.api.federation.link

Annotation Type Link

@Description("This directive links definitions from an external specification to this schema.")
@Retention(RUNTIME)
@Repeatable(Links.class)
@Experimental("SmallRye GraphQL Federation is still subject to change.")
public @interface Link

directive @link(url: String!, as: String, import: [Import], for: Purpose) repeatable on SCHEMA

See Also:

federation spec

Field Summary

Fields

Modifier and Type	Fields	Description
static String	FEDERATION_SPEC_LATEST_URL
static String	FEDERATION_SPEC_LATEST_VER
static String	FEDERATION_SPEC_URL

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
@NonNull String	url

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Purpose	_for
Import[]	_import
String	as

Field Detail

FEDERATION_SPEC_URL

static final String FEDERATION_SPEC_URL

FEDERATION_SPEC_LATEST_VER

static final String FEDERATION_SPEC_LATEST_VER

FEDERATION_SPEC_LATEST_URL

static final String FEDERATION_SPEC_LATEST_URL

Element Detail

url

@NonNull
@Description("The foreign schema\u2019s URL.")
@NonNull String url

as

@Description("Change the namespace prefix assigned to the foreign schema.")
String as

Default:

""

_import

@Description("A list of elements to import from the foreign schema into the document.")
@Name("import")
Import[] _import

Default:

{}

_for

@Description("An optional purpose for this link. This hints to consumers as to whether they can safely ignore metadata described by a foreign schema.")
@Name("for")
Purpose _for

Default:

io.smallrye.graphql.api.federation.link.Purpose.UNDEFINED