...

Text file src/github.com/vektah/gqlparser/v2/validator/prelude.graphql

Documentation: github.com/vektah/gqlparser/v2/validator

     1# This file defines all the implicitly declared types that are required by the graphql spec. It is implicitly included by calls to LoadSchema
     2
     3"The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1."
     4scalar Int
     5
     6"The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point)."
     7scalar Float
     8
     9"The `String`scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text."
    10scalar String
    11
    12"The `Boolean` scalar type represents `true` or `false`."
    13scalar Boolean
    14
    15"""The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID."""
    16scalar ID
    17
    18"The @include directive may be provided for fields, fragment spreads, and inline fragments, and allows for conditional inclusion during execution as described by the if argument."
    19directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
    20
    21"The @skip directive may be provided for fields, fragment spreads, and inline fragments, and allows for conditional exclusion during execution as described by the if argument."
    22directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
    23
    24"The @deprecated built-in directive is used within the type system definition language to indicate deprecated portions of a GraphQL service's schema, such as deprecated fields on a type, arguments on a field, input fields on an input type, or values of an enum type."
    25directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE
    26
    27"The @specifiedBy built-in directive is used within the type system definition language to provide a scalar specification URL for specifying the behavior of custom scalar types."
    28directive @specifiedBy(url: String!) on SCALAR
    29
    30"The @defer directive may be specified on a fragment spread to imply de-prioritization, that causes the fragment to be omitted in the initial response, and delivered as a subsequent response afterward. A query with @defer directive will cause the request to potentially return multiple responses, where non-deferred data is delivered in the initial response and data deferred delivered in a subsequent response. @include and @skip take precedence over @defer."
    31directive @defer(if: Boolean = true, label: String) on FRAGMENT_SPREAD | INLINE_FRAGMENT
    32
    33type __Schema {
    34  description: String
    35  types: [__Type!]!
    36  queryType: __Type!
    37  mutationType: __Type
    38  subscriptionType: __Type
    39  directives: [__Directive!]!
    40}
    41
    42type __Type {
    43  kind: __TypeKind!
    44  name: String
    45  description: String
    46  # must be non-null for OBJECT and INTERFACE, otherwise null.
    47  fields(includeDeprecated: Boolean = false): [__Field!]
    48  # must be non-null for OBJECT and INTERFACE, otherwise null.
    49  interfaces: [__Type!]
    50  # must be non-null for INTERFACE and UNION, otherwise null.
    51  possibleTypes: [__Type!]
    52  # must be non-null for ENUM, otherwise null.
    53  enumValues(includeDeprecated: Boolean = false): [__EnumValue!]
    54  # must be non-null for INPUT_OBJECT, otherwise null.
    55  inputFields: [__InputValue!]
    56  # must be non-null for NON_NULL and LIST, otherwise null.
    57  ofType: __Type
    58  # may be non-null for custom SCALAR, otherwise null.
    59  specifiedByURL: String
    60}
    61
    62type __Field {
    63  name: String!
    64  description: String
    65  args: [__InputValue!]!
    66  type: __Type!
    67  isDeprecated: Boolean!
    68  deprecationReason: String
    69}
    70
    71type __InputValue {
    72  name: String!
    73  description: String
    74  type: __Type!
    75  defaultValue: String
    76}
    77
    78type __EnumValue {
    79  name: String!
    80  description: String
    81  isDeprecated: Boolean!
    82  deprecationReason: String
    83}
    84
    85enum __TypeKind {
    86  SCALAR
    87  OBJECT
    88  INTERFACE
    89  UNION
    90  ENUM
    91  INPUT_OBJECT
    92  LIST
    93  NON_NULL
    94}
    95
    96type __Directive {
    97  name: String!
    98  description: String
    99  locations: [__DirectiveLocation!]!
   100  args: [__InputValue!]!
   101  isRepeatable: Boolean!
   102}
   103
   104enum __DirectiveLocation {
   105  QUERY
   106  MUTATION
   107  SUBSCRIPTION
   108  FIELD
   109  FRAGMENT_DEFINITION
   110  FRAGMENT_SPREAD
   111  INLINE_FRAGMENT
   112  VARIABLE_DEFINITION
   113  SCHEMA
   114  SCALAR
   115  OBJECT
   116  FIELD_DEFINITION
   117  ARGUMENT_DEFINITION
   118  INTERFACE
   119  UNION
   120  ENUM
   121  ENUM_VALUE
   122  INPUT_OBJECT
   123  INPUT_FIELD_DEFINITION
   124}

View as plain text