Definition
Overview
The @openfed__configureDescriptiondirective serves four main functions:
-
Designate a certain description that should be propagated in the federated graph.
-
Designate a description override that should be propagated in the federated graph.
-
Designate that a certain description should never be propagated in the federated graph.
-
Setting a description on an extension type (which usually cannot define descriptions).
Propagate a description to the federated graph
If the propagate argument is set to true (the default value), the description corresponding to the coordinates of the directive in the defining subgraph will be the description that appears for those coordinates in the federated graph.
Hide a description from the federated graph
If the propagate argument is set to false, the description corresponding to the coordinates of the directive in the defining subgraph will not be considered for description that appears for those coordinates in the federated graph.
Override a description
If the propagate argument is set to true (the default value), and the descriptionOverride argument is set to a non-empty string, that string will be the description that appears for those coordinates in the federated graph.
If the propagate argument is set to false, the descriptionOverride argument will be ignored.
Composition rules
-
The coordinates that define the directive must define a description or provide a non-empty value to the
descriptionOverride argument.
-
Only one instance of coordinates may define the
propagate with true. Multiple such definitions will produce a composition error.
-
Any number of instances of coordinates may provide the
propagate argument with false.
Examples
Propagating a specific description
Hiding a specific description
Hiding all descriptions
Setting and propagating a description on an extension type
Overriding and propagating a description
Last modified on July 27, 2026