FSharp.Data.GraphQL


Introspection

Namespace: FSharp.Data.GraphQL

The MIT License (MIT) Copyright (c) 2016 Bazinga Technologies Inc

Functions and values

Function or valueDescription
__Directive
Signature: ObjectDef<IntrospectionDirective>

A GraphQL Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL’s execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

__DirectiveLocation
Signature: EnumDef<DirectiveLocation>

GraphQL enum describing kind of location for a particular directive to be used in. Can be one of: QUERY, MUTATION, SUBSCRIPTION, FIELD, FRAGMENTDEFINITION, FRAGMENTSPREAD or INLINE_FRAGMENT.

__EnumValue
Signature: ObjectDef<IntrospectionEnumVal>

One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.

__Field
Signature: ObjectDef<IntrospectionField>

Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.

__InputValue
Signature: ObjectDef<IntrospectionInputVal>

Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.

__Schema
Signature: ObjectDef<IntrospectionSchema>

GraphQL object defining capabilities of GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.

__Type
Signature: ObjectDef<IntrospectionTypeRef>

The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.

__TypeKind
Signature: EnumDef<TypeKind>

GraphQL enum describing kind of the GraphQL type definition. Can be one of: SCALAR, OBJECT, INTERFACE, UNION, ENUM, LIST, NONNULL or INPUTOBJECT.

introspectionQuery
Signature: string

Common GraphQL query that may be used to retrieve overall data about schema type system itself.

Fork me on GitHub