Package org.springframework.graphql.execution

Interface SchemaReport

public interface SchemaReport

Report produced as a result of inspecting schema mappings.

The inspection checks if schema fields are covered either by a DataFetcher registration, or match a Java object property. Fields that have neither are reported as unmappedFields(). The inspection also checks if any DataFetcher are registered against schema fields that don't exist and reports those as unmappedRegistrations().

Since:

1.2.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SchemaReport.SkippedType	Information about a schema type skipped during the inspection.

Method Summary

Modifier and Type	Method	Description
DataFetcher<?>	dataFetcher(FieldCoordinates coordinates)	Return the DataFetcher for the given field coordinates, if registered.
GraphQLSchema	schema()	Return the inspected schema with type and field definitions.
List<SchemaReport.SkippedType>	skippedTypes()	Return types skipped during the inspection, either because the schema type is not supported, e.g.
MultiValueMap<DataFetcher<?>,String>	unmappedArguments()	Return a map with DataFetchers and the names of arguments they depend on that don't exist.
List<FieldCoordinates>	unmappedFields()	Return the coordinates of unmapped fields.
Map<FieldCoordinates,DataFetcher<?>>	unmappedRegistrations()	Return the coordinates for invalid DataFetcher registrations referring to fields that don't exist in the schema.

Method Details

schema

GraphQLSchema schema()

Return the inspected schema with type and field definitions.

unmappedFields

List<FieldCoordinates> unmappedFields()

Return the coordinates of unmapped fields. Such fields have neither a DataFetcher registration, such as a @SchemaMapping method, nor a matching Java property in the return type from the parent DataFetcher.

unmappedRegistrations

Map<FieldCoordinates,DataFetcher<?>> unmappedRegistrations()

Return the coordinates for invalid DataFetcher registrations referring to fields that don't exist in the schema.

unmappedArguments

MultiValueMap<DataFetcher<?>,String> unmappedArguments()

Return a map with DataFetchers and the names of arguments they depend on that don't exist.

Since:

1.3.0

skippedTypes

List<SchemaReport.SkippedType> skippedTypes()

Return types skipped during the inspection, either because the schema type is not supported, e.g. union, or because there is insufficient Java type information, e.g. controller method that returns Object or wrapper type (collection, reactive, asynchronous) with wildcard generics.

dataFetcher

@Nullable
DataFetcher<?> dataFetcher(FieldCoordinates coordinates)

Return the DataFetcher for the given field coordinates, if registered.

Parameters:

coordinates - the field coordinates