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.NullnessError
    Information about a Nullness error between the GraphQL schema and the application code.
    static interface 
    SchemaReport.SkippedType
    Information about a schema type skipped during the inspection.

  • Method Summary

    Modifier and Type
    Method
    Description
    MultiValueMap<graphql.schema.DataFetcher<?>, SchemaReport.NullnessError>
    argumentNullnessErrors()
    Return a map with DataFetchers and information for its arguments if there is a nullness error between the schema arguments and the corresponding AnnotatedElement in the application.
    @Nullable graphql.schema.DataFetcher<?>
    dataFetcher(graphql.schema.FieldCoordinates coordinates)
    Return the DataFetcher for the given field coordinates, if registered.
    Map<graphql.schema.FieldCoordinates, SchemaReport.NullnessError>
    fieldNullnessErrors()
    Return the coordinates for nullness errors between schema fields and the corresponding AnnotatedElement in the application.
    graphql.schema.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<graphql.schema.DataFetcher<?>, String>
    unmappedArguments()
    Return a map with DataFetchers and the names of arguments they depend on that don't exist.
    List<graphql.schema.FieldCoordinates>
    unmappedFields()
    Return the coordinates of unmapped fields.
    Map<graphql.schema.FieldCoordinates, graphql.schema.DataFetcher<?>>
    unmappedRegistrations()
    Return the coordinates for invalid DataFetcher registrations referring to fields that don't exist in the schema.

  • Method Details

    • schema

      graphql.schema.GraphQLSchema schema()
      Return the inspected schema with type and field definitions.

    • unmappedFields

      List<graphql.schema.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<graphql.schema.FieldCoordinates, graphql.schema.DataFetcher<?>> unmappedRegistrations()
      Return the coordinates for invalid DataFetcher registrations referring to fields that don't exist in the schema.

    • unmappedArguments

      MultiValueMap<graphql.schema.DataFetcher<?>, String> unmappedArguments()
      Return a map with DataFetchers and the names of arguments they depend on that don't exist.
      Since:
      1.3.0

    • fieldNullnessErrors

      Map<graphql.schema.FieldCoordinates, SchemaReport.NullnessError> fieldNullnessErrors()
      Return the coordinates for nullness errors between schema fields and the corresponding AnnotatedElement in the application.
      See Also:

    • argumentNullnessErrors

      MultiValueMap<graphql.schema.DataFetcher<?>, SchemaReport.NullnessError> argumentNullnessErrors()
      Return a map with DataFetchers and information for its arguments if there is a nullness error between the schema arguments and the corresponding AnnotatedElement in the application.
      See Also:

    • 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 graphql.schema.DataFetcher<?> dataFetcher(graphql.schema.FieldCoordinates coordinates)
      Return the DataFetcher for the given field coordinates, if registered.
      Parameters:
      coordinates - the field coordinates