introspection

Documentation

Index

• Constants
• Variables
• type Directive
  • func (t Directive) Arg(name string) *DirectiveArg
• type DirectiveArg
• type Directives
  • func (t Directives) Directive(name string) *Directive
  • func (t *Directives) SourceMap() *SourceMap
• type EnumValue
• type Field
  • func (f *Field) ReferencesType(typeName string) bool
• type InputValue
  • func (v InputValue) IsOptional() bool
• type InputValues
  • func (i InputValues) HasOptionals() bool
• type Response
• type Scalar
• type Schema
  • func (s *Schema) Mutation() *Type
  • func (s *Schema) Query() *Type
  • func (s *Schema) ScrubType(typeName string)
  • func (s *Schema) Subscription() *Type
  • func (s *Schema) Visit() []*Type
• type SourceMap
  • func (sourceMap *SourceMap) Filelink() string
• type Type
  • func (t *Type) ScrubType(typeName string) bool
• type TypeKind
• type TypeRef
  • func (r TypeRef) IsList() bool
  • func (r TypeRef) IsObject() bool
  • func (r TypeRef) IsOptional() bool
  • func (r TypeRef) IsScalar() bool
  • func (r TypeRef) IsVoid() bool
  • func (r TypeRef) ReferencesType(typeName string) bool
• type Types
  • func (t Types) Get(name string) *Type
• type Visitor
  • func (v *Visitor) Run() []*Type

Constants

const (
	TypeKindScalar      = TypeKind("SCALAR")
	TypeKindObject      = TypeKind("OBJECT")
	TypeKindInterface   = TypeKind("INTERFACE")
	TypeKindUnion       = TypeKind("UNION")
	TypeKindEnum        = TypeKind("ENUM")
	TypeKindInputObject = TypeKind("INPUT_OBJECT")
	TypeKindList        = TypeKind("LIST")
	TypeKindNonNull     = TypeKind("NON_NULL")
)

const (
	ScalarInt     = Scalar("Int")
	ScalarFloat   = Scalar("Float")
	ScalarString  = Scalar("String")
	ScalarBoolean = Scalar("Boolean")
	ScalarVoid    = Scalar("Void")
)

Variables

var Query string

Query is the query generated by graphiql to determine type information

Types

type Directive

type Directive struct {
	Name string          `json:"name"`
	Args []*DirectiveArg `json:"args"`
}

func (Directive) Arg

func (t Directive) Arg(name string) *DirectiveArg

type DirectiveArg

type DirectiveArg struct {
	Name  string  `json:"name"`
	Value *string `json:"value"`
}

type Directives

type Directives []*Directive

func (Directives) Directive

func (t Directives) Directive(name string) *Directive

func (*Directives) SourceMap

func (t *Directives) SourceMap() *SourceMap

type EnumValue

type EnumValue struct {
	Name              string     `json:"name"`
	Description       string     `json:"description"`
	IsDeprecated      bool       `json:"isDeprecated"`
	DeprecationReason string     `json:"deprecationReason"`
	Directives        Directives `json:"directives"`
}

type Field

type Field struct {
	Name              string      `json:"name"`
	Description       string      `json:"description"`
	TypeRef           *TypeRef    `json:"type"`
	Args              InputValues `json:"args"`
	IsDeprecated      bool        `json:"isDeprecated"`
	DeprecationReason string      `json:"deprecationReason"`
	Directives        Directives  `json:"directives"`

	ParentObject *Type `json:"-"`
}

func (*Field) ReferencesType

func (f *Field) ReferencesType(typeName string) bool

type InputValue

type InputValue struct {
	Name         string     `json:"name"`
	Description  string     `json:"description"`
	DefaultValue *string    `json:"defaultValue"`
	TypeRef      *TypeRef   `json:"type"`
	Directives   Directives `json:"directives"`
}

func (InputValue) IsOptional

func (v InputValue) IsOptional() bool

type InputValues

type InputValues []InputValue

func (InputValues) HasOptionals

func (i InputValues) HasOptionals() bool

type Response

type Response struct {
	Schema        *Schema `json:"__schema"`
	SchemaVersion string  `json:"__schemaVersion"`
}

Response is the introspection query response

type Scalar

type Scalar string

type Schema

type Schema struct {
	QueryType struct {
		Name string `json:"name,omitempty"`
	} `json:"queryType,omitempty"`
	MutationType *struct {
		Name string `json:"name,omitempty"`
	} `json:"mutationType,omitempty"`
	SubscriptionType *struct {
		Name string `json:"name,omitempty"`
	} `json:"subscriptionType,omitempty"`

	Types      Types `json:"types"`
	Directives any   `json:"directives"`
}

func (*Schema) Mutation

func (s *Schema) Mutation() *Type

func (*Schema) Query

func (s *Schema) Query() *Type

func (*Schema) ScrubType

func (s *Schema) ScrubType(typeName string)

Remove all occurrences of a type from the schema, including any fields, input fields, and enum values that reference it.

func (*Schema) Subscription

func (s *Schema) Subscription() *Type

func (*Schema) Visit

func (s *Schema) Visit() []*Type

type SourceMap

type SourceMap struct {
	Module   string
	Filename string
	Line     string
	Column   string
}

func (*SourceMap) Filelink

func (sourceMap *SourceMap) Filelink() string

type Type

type Type struct {
	Kind        TypeKind     `json:"kind"`
	Name        string       `json:"name"`
	Description string       `json:"description,omitempty"`
	Fields      []*Field     `json:"fields,omitempty"`
	InputFields []InputValue `json:"inputFields,omitempty"`
	EnumValues  []EnumValue  `json:"enumValues,omitempty"`
	Interfaces  []*Type      `json:"interfaces"`
	Directives  Directives   `json:"directives"`
}

func (*Type) ScrubType

func (t *Type) ScrubType(typeName string) bool

Remove all occurrences of a type from the schema, including any fields, input fields, and enum values that reference it. Returns true if this type should be removed, whether because it is the type being scrubbed, or because it is now empty after scrubbing its references.

type TypeKind

type TypeKind string

type TypeRef

type TypeRef struct {
	Kind   TypeKind `json:"kind"`
	Name   string   `json:"name,omitempty"`
	OfType *TypeRef `json:"ofType,omitempty"`
}

func (TypeRef) IsList

func (r TypeRef) IsList() bool

func (TypeRef) IsObject

func (r TypeRef) IsObject() bool

func (TypeRef) IsOptional

func (r TypeRef) IsOptional() bool

func (TypeRef) IsScalar

func (r TypeRef) IsScalar() bool

func (TypeRef) IsVoid

func (r TypeRef) IsVoid() bool

func (TypeRef) ReferencesType

func (r TypeRef) ReferencesType(typeName string) bool

type Types

type Types []*Type

func (Types) Get

func (t Types) Get(name string) *Type

type Visitor

type Visitor struct {
	// contains filtered or unexported fields
}

func (*Visitor) Run

func (v *Visitor) Run() []*Type