Federation version changelog

@authenticated

Introduced. Learn more.

1
directive @authenticated on
2
    FIELD_DEFINITION
3
  | OBJECT
4
  | INTERFACE
5
  | SCALAR
6
  | ENUM

@requiresScopes

Introduced. Learn more.

1
directive @requiresScopes(scopes: [[Scope!]!]!) on
2
    FIELD_DEFINITION
3
  | OBJECT
4
  | INTERFACE
5
  | SCALAR
6
  | ENUM

Scope

• Custom scalar representing a JWT scope. Used by new @requiresScopes directive.

Subscriptions

• Composition now supports defining the Subscription type in subgraph schemas.
• Use of GraphQL subscriptions with a federated graph requires a compatible version of the Apollo Router. See details.

@interfaceObject

Introduced. Learn more.

1
directive @interfaceObject on OBJECT

@key

Can now be applied to interface definitions to support entity interfaces.

(Previous versions of composition threw an error if @key was applied to an interface definition.)

@shareable

Added repeatable to the directive definition.

1
directive @shareable repeatable on OBJECT | FIELD_DEFINITION

Additionally, composition now throws an error if @shareable is applied to fields of an interface definition.

@composeDirective

Introduced. Learn more.

1
directive @composeDirective(name: String!) repeatable on SCHEMA

@requires

The fields argument can now include fields that themselves take arguments. Learn more.

(Functionality added in v2.1.2)

1
type Product @key(fields: "id") {
2
  id: ID!
3
  weight(units: String): Int! @external
4
  shippingEstimate: Int! @requires(fields: "weight(units: \"KILOGRAMS\")")
5
}

@key

Added optional resolvable argument.

1
directive @key(
2
  fields: FieldSet!,
3
  resolvable: Boolean = true 
4
) repeatable on OBJECT | INTERFACE

@shareable

Introduced.

1
directive @shareable on OBJECT | FIELD_DEFINITION

@inaccessible

Introduced.

1
directive @inaccessible on
2
  | FIELD_DEFINITION
3
  | OBJECT
4
  | INTERFACE
5
  | UNION
6
  | ARGUMENT_DEFINITION
7
  | SCALAR
8
  | ENUM
9
  | ENUM_VALUE
10
  | INPUT_OBJECT
11
  | INPUT_FIELD_DEFINITION

@override

Introduced.

1
directive @override(from: String!) on FIELD_DEFINITION

@link

Introduced.

1
directive @link(
2
  url: String,
3
  as: String,
4
  for: link__Purpose,
5
  import: [link__Import]
6
) repeatable on SCHEMA

@extends, @external, @provides, @requires, @tag

No changes.

Entities

• Entities no longer originate in a subgraph. Instead, any number of subgraphs can define the same entity and contribute fields to it.
• Multiple subgraphs can contribute the same field to an entity, if that field is marked as @shareable in every subgraph that defines it.
• Subgraphs no longer need to extend (or @extends) an entity whenever another subgraph already defines that entity.
• Each subgraph can apply any number of @key directives to an entity.
• Subgraphs must no longer apply the @external directive to their @key fields.

Value types

• To define a value type with shared fields across multiple subgraphs, those shared fields must be marked as @shareable in every subgraph that defines them.
• Value type fields can differ across subgraphs (in certain ways). For details, see Differing shared fields.

Query and Mutation

• More than one subgraph can define the same field of the Query or Mutation type, if that field is marked as @shareable in every subgraph that defines it.
• Subgraphs no longer need to apply the extend keyword (or the @extends directive) to the Query and Mutation types.

@tag

Introduced.

1
directive @tag(name: String!) repeatable on
2
  | FIELD_DEFINITION
3
  | INTERFACE
4
  | OBJECT
5
  | UNION

@key

Introduced.

1
directive @key(fields: _FieldSet!) repeatable on OBJECT | INTERFACE

@external

Introduced.

1
directive @external on FIELD_DEFINITION

@requires

Introduced.

1
directive @requires(fields: _FieldSet!) on FIELD_DEFINITION

@provides

Introduced.

1
directive @provides(fields: _FieldSet!) on FIELD_DEFINITION

@extends

Introduced.

1
directive @extends on OBJECT | INTERFACE

Entities

• Each entity originates in exactly one subgraph and can be extended in other subgraphs.
• An entity's originating subgraph must apply at least one @key directive to the entity definition.
• An extending subgraph must use the extend keyword (or the @extends directive) when defining another subgraph's entity.
• An extending subgraph must apply exactly one @key directive to any entity it extends. The fields of that @key must match a @key that's defined by the entity's originating subgraph.
• An extending subgraph must apply the @external directive to all @key fields of an entity it extends.
• If an entity field is defined in more than one subgraph, it must be marked as @external in all but one subgraph.

Value types

• Each subgraph that defines a value type must define that value type identically.

Query and Mutation

• More than one subgraph cannot define the same field of the Query or Mutation type.
• Every subgraph must apply the extend keyword (or the @extends directive) to the Query and Mutation types.