markdown

README

API Reference

View reference documentation to learn about the data types available in your GraphQL API schema.

{{ range $i := .Items }}

• [{{ $i.Type }}]({{ $i.Link }}) {{- end }}

Documentation

Index

• type Config
  • func (m *Config) Create(filename string) (*os.File, error)
  • func (m *Config) MakeLinkFromType(typ *introspection.Type) (string, error)
  • func (m *Config) Render(s *introspection.Schema) error
• type Enum
• type EnumValue
• type Enums
• type ImplementedBy
• type InputObject
• type InputObjectField
• type InputObjects
• type Interface
• type InterfaceField
• type InterfaceFieldArg
• type Interfaces
• type Mutation
• type MutationField
• type MutationFieldArg
• type MutationFieldReturn
• type Object
• type ObjectField
• type ObjectFieldArg
• type ObjectImplements
• type Objects
• type Query
• type QueryField
• type QueryFieldArg
• type QueryFieldReturn
• type README
• type READMEItem
• type Scalar
• type Scalars
• type Union
• type UnionPossibleType
• type Unions

Types

type Config

type Config struct {
	BaseDir string
}

func (*Config) Create

func (m *Config) Create(filename string) (*os.File, error)

func (*Config) MakeLinkFromType

func (m *Config) MakeLinkFromType(typ *introspection.Type) (string, error)

func (*Config) Render

func (m *Config) Render(s *introspection.Schema) error

type Enum

type Enum struct {
	Name        string
	Description string
	Values      []*EnumValue
}

type EnumValue

type EnumValue struct {
	Name        string
	Description string
}

type Enums

type Enums struct {
	Enums []*Enum
}

type ImplementedBy

type ImplementedBy struct {
	Type     string
	TypeLink string
}

type InputObject

type InputObject struct {
	Name        string
	Description string
	InputFields []*InputObjectField
}

type InputObjectField

type InputObjectField struct {
	Name        string
	Type        string
	TypeLink    string
	Description string
}

type InputObjects

type InputObjects struct {
	InputObjects []*InputObject
}

type Interface

type Interface struct {
	Name        string
	Description string
	Implemented []*ImplementedBy
	Fields      []*InterfaceField
}

type InterfaceField

type InterfaceField struct {
	Name        string
	Type        string
	TypeLink    string
	Description string
	Args        []*InterfaceFieldArg
}

type InterfaceFieldArg

type InterfaceFieldArg struct {
	Name        string
	Type        string
	TypeLink    string
	Description string
}

type Interfaces

type Interfaces struct {
	Interfaces []*Interface
}

type Mutation

type Mutation struct {
	Description string
	Fields      []*MutationField
}

type MutationField

type MutationField struct {
	Name        string
	Description string
	Args        []*MutationFieldArg
	Returns     []*MutationFieldReturn
}

type MutationFieldArg

type MutationFieldArg struct {
	Name     string
	Type     string
	TypeLink string
}

type MutationFieldReturn

type MutationFieldReturn struct {
	Name        string
	Description string
	Type        string
	TypeLink    string
}

type Object

type Object struct {
	Name        string
	Description string
	Implements  []*ObjectImplements
	Fields      []*ObjectField
}

type ObjectField

type ObjectField struct {
	Name        string
	Type        string
	TypeLink    string
	Description string
	Args        []*ObjectFieldArg
}

type ObjectFieldArg

type ObjectFieldArg struct {
	Name        string
	Type        string
	TypeLink    string
	Description string
}

type ObjectImplements

type ObjectImplements struct {
	Type     string
	TypeLink string
}

type Objects

type Objects struct {
	Objects []*Object
}

type Query

type Query struct {
	Description string
	Fields      []*QueryField
}

type QueryField

type QueryField struct {
	Name        string
	Description string
	Args        []*QueryFieldArg
	Return      *QueryFieldReturn
}

type QueryFieldArg

type QueryFieldArg struct {
	Name        string
	Description string
	Type        string
	TypeLink    string
}

type QueryFieldReturn

type QueryFieldReturn struct {
	Type     string
	TypeLink string
}

type README

type README struct {
	Items []*READMEItem
}

type READMEItem

type READMEItem struct {
	Type string
	Link string
}

type Scalar

type Scalar struct {
	Name        string
	Description string
}

type Scalars

type Scalars struct {
	Scalars []*Scalar
}

type Union

type Union struct {
	Name          string
	Description   string
	PossibleTypes []*UnionPossibleType
}

type UnionPossibleType

type UnionPossibleType struct {
	Name string
	Link string
}

type Unions

type Unions struct {
	Unions []*Union
}