ExShopifySchema.Generator.Graphql.Introspection.Definition.Field (ExShopifySchema v2024.10.2)

View Source

GraphQL Objects represent a list of named fields, each of which yield a value of a specific type.

https://spec.graphql.org/October2021/#FieldDefinition

Example introspection payload

{
  "name": "confirmed",
  "description": "Whether inventory has been reserved for the order.",
  "args": [],
  "type": {
    "kind": "NON_NULL",
    "name": null,
    "ofType": {
      "kind": "SCALAR",
      "name": "Boolean",
      "ofType": null
    }
  },
  "isDeprecated": false,
  "deprecationReason": null
}

Summary

Types

t()

@type t() :: %ExShopifySchema.Generator.Graphql.Introspection.Definition.Field{
  args: [
    ExShopifySchema.Generator.Graphql.Introspection.Definition.InputValue.t()
  ],
  deprecation_reason: String.t() | nil,
  description: String.t() | nil,
  directives: [
    ExShopifySchema.Generator.Graphql.Introspection.Definition.ConstDirective.t()
  ],
  is_deprecated: boolean(),
  name: String.t(),
  type: ExShopifySchema.Generator.Graphql.Introspection.Definition.Type.t()
}

Functions

load_json(json)

@spec load_json(json :: map()) :: t()