File Structure - WunderGraph

SubgraphCheckExtensionContent

The fields listed below are all optional and can be included or excluded based on the namespace configuration.

Field Type Description
subgraphs SubgraphInfo[] or undefined A list of subgraphs that trigger the check.
compositions CompositionInfo[] or undefined A list of all compositions produced by the check.
affectedOperations AffectedOperationInfo[] or undefined A list containing all the operations affected by the check.

SubgraphInfo

Field Type Description
id string The unique identifier of the subgraph.
name string The name of the subgraph.
labels LabelInfo[] The list of labels the subgraph is associated with.
oldComposedSdl string or undefined The original subgraph SDL
newComposedSdl string or undefined The new subgraph SDL
lintIssues LintIssue[] or undefined A list containing all the lint issues detected based on the Lint Policies.
graphPruningIssues GraphPruningIssue[] or undefined A list containing all the graph pruning issues detected based on the Graph Pruning Policies
schemaChanges SchemaChangeInfo[] or undefined A list containing all the changes detected by the check.

CompositionInfo

Field Type Description
id string The unique identifier of the composition.
name string The name of the composition.
composedSchema string The composed SDL schema.
federatedClientSchema string The composed schema for the Federated Client.
subgraphs CompositionSubgraphInfo[] A collection of all subgraphs that contributed to this composition.

LabelInfo

Provides information about the labels associated with the subgraph.

Field Type Description
key string The key of the label.
name string The name of the label.

CompositionSubgraphInfo

Field Type Description
id string The unique identifier of the subgraph.
name string The name of the subgraph.
sdl string The SDL of the subgraph.

LintIssue

Field Type Description
lintRuleType string One of the lint rule.
severity LintSeverity The severity of the issue.
message string A message describing the issue.
issueLocation LintIssueLocation The location of the issue related to the schema.

LintSeverity

Field Value Description
Warning 0 Represents a lint warning.
Error 1 Represents a lint error.

LintIssueLocation

Field Type Description
line number The line number of the lint issue.
column number The column number of the lint issue.
endLine number or undefined The end line number of the lint issue.
endColumn number or undefined The end column number of the lint issue.

GraphPruningIssue

Field Type Description
graphPruningRuleType GraphPruningRuleType The graph pruning rule.
severity GraphPruningSeverity The severity of the issue.
fieldPath string The path to the field.
message string A message describing the issue.
issueLocation GraphPruningIssueLocation The location of the issue related to the schema.
federatedGraphId string The unique identifier of the Federated graph.
federatedGraphName string The name of the Federated graph.
subgraphName string or undefined The name of the subgraph.

GraphPruningSeverity

Field Value Description
Warning 0 Represents a graph pruning warning.
Error 1 Represents a graph pruning error.

SchemaChangeInfo

Field Type Description
message string A string representation of the change.
changeType string A string representing the type of change. You can find the possible values here.
path string The path to the schema change.
isBreaking boolean A value indicating whether the detected change is considered breaking or not.

List of possible change types

AffectedOperationInfo

Field Type Description
schemaChangeId string The unique identifier of the schema change.
hash string The unique hash of the operation.
name string The name of the operation.
type string The type of the operation.
firstSeenAt ISO Date A Date with the ISO format indicating when the operation was first seen.
lastSeenAt ISO Date A Date with the ISO format indicating when the operation was last seen.
isSafeOverride boolean A value indicating whether it is safe for the operation to be overridden.