Type Members

1.  case class Api(operations: List[Operation], interfaces: List[Interface], types: List[Type], original: Document) extends Product with Serializable

   The API based on one or more GraphQL query documents using a given schema.

   The API based on one or more GraphQL query documents using a given schema.

   It includes only the operations, interfaces and input/output types referenced in the query documents.

   operations

   all operations

   interfaces

   defined interfaces

   types

   all types that are not operations related. This includes predefined types (e.g. ID) and input variable types.

2.  case class CodeGen(useType: String) extends TypedDocument with Product with Serializable
   useType

   use this type instead and don't generate any code

3.  case class Enum(name: String, values: List[String]) extends Type with Product with Serializable
4.  case class Field(name: String, tpe: sangria.schema.Type, selection: Option[Selection] = None, union: List[UnionSelection] = List.empty, codeGen: Option[CodeGen] = None) extends TypedDocument with Product with Serializable

   Selected GraphQL field

   Selected GraphQL field

   The class contains a variety of information on a selected field to allow an source code generators to define different behaviours.

   name

   - the field name

   tpe

   - the field type extraced from the schema

   selection

   - is None for scalar types (String, Option, List, etc.)

   union

   contains a list of union types that are selected with the spread operator ...UnionTypeName

5.  case class Interface(name: String, fields: List[Field]) extends Type with Product with Serializable
6.  case class Object(name: String, fields: List[Field]) extends Type with Product with Serializable
7.  case class Operation(name: Option[String], variables: List[Field], selection: Selection, original: OperationDefinition) extends TypedDocument with Product with Serializable

   Operations represent API calls and are the entry points to the API.

   Operations represent API calls and are the entry points to the API.

   name

   the operation name

   variables

   input variables

   selection

   the selected fields

   original

   the original sangria OperationDefinition

8.  case class Selection(fields: List[Field], interfaces: List[String] = List.empty) extends TypedDocument with Product with Serializable

   A Selection represents a list of selected fields with additional meta information.

   A Selection represents a list of selected fields with additional meta information.

   Based on the meta information (interfaces, fragment) code generators can decide what code needs to be generated.

   ## Interfaces

   The generated code may inherit the specified interfaces for this selection.

   ## Fragment

   If a fragment is the source for this selection the fragment code could be generated in a separate place and referenced here by name and or type of the fragment.

   fields

   the fields that are part of the selection

   interfaces

   the interfaces that apply to this selection

9.  sealed trait Type extends TypedDocument

   Marker trait for GraphQL input and output types.

10.  case class TypeAlias(name: String, tpe: String) extends Type with Product with Serializable
11.  case class Union(name: String, types: List[Object]) extends Type with Product with Serializable
12.  case class UnionSelection(tpe: ObjectType[_, _], selection: Selection) extends TypedDocument with Product with Serializable