entity

Documentation

Index

• Constants
• Variables
• type Config
• type Definition
• type DocType
• type Example
• type Property
• type ScalarVariant
• type Spec
• type Template
• type TypeVariant

Constants

const (
	Query    = "queries.go"
	Mutation = "mutations.go"
)

const (
	Scalar    = "Scalar"
	Object    = "Object"
	Interface = "Interface"
	Union     = "Union"
	Enum      = "Enum"
	Input     = "Input"
)

const (
	Int = iota
	Float
	String
	Boolean
	ID
)

Variables

var AvailableTemplate = map[string]Template{
	"json":       JSON,
	"markdown":   Markdown,
	"html":       HTML,
	"confluence": Confluence,
}

var Default = map[string]interface{}{
	"Int":     1,
	"String":  "Hello",
	"Float":   1.0,
	"Boolean": true,
	"ID":      "123",
}

var DocTypeVariant = map[string]DocType{
	"query":    Query,
	"mutation": Mutation,
}

var ScalarTypes = map[string]ScalarVariant{
	"Int":     Int,
	"Float":   Float,
	"String":  String,
	"Boolean": Boolean,
	"ID":      ID,
}

var Types = map[string]TypeVariant{
	"type":      Object,
	"interface": Interface,
	"enum":      Enum,
	"input":     Input,
}

Types

type Config

type Config struct {
	Input     string
	Output    string
	Template  string
	Type      []DocType
	Quiet     bool
	Help      bool
	NoExample bool
}

type Definition

type Definition struct {
	Name       string      `json:"name,omitempty"`
	Comment    string      `json:"comment,omitempty"`
	Variant    TypeVariant `json:"variant,omitempty"`
	Directive  string      `json:"directive,omitempty"`
	Properties []Property  `json:"properties,omitempty"`
}

type DocType

type DocType string

type Example

type Example struct {
	Request  string `json:"request,omitempty"`
	Response string `json:"response,omitempty"`
}

type Property

type Property struct {
	Name       string     `json:"name,omitempty"`
	Comment    string     `json:"comment,omitempty"`
	Type       string     `json:"type,omitempty"`
	Directive  string     `json:"directive,omitempty"`
	Parameters []Property `json:"parameters,omitempty"`
	IsScalar   bool       `json:"is_scalar,omitempty"`
	IsNullable bool       `json:"is_nullable,omitempty"`
	IsList     bool       `json:"is_list,omitempty"`
	Example    Example    `json:"example,omitempty"`
}

type ScalarVariant

type ScalarVariant int

type Spec

type Spec struct {
	Name        string       `json:"name,omitempty"`
	Queries     []Property   `json:"queries,omitempty"`
	Mutations   []Property   `json:"mutations,omitempty"`
	Definitions []Definition `json:"definitions,omitempty"`
}

type Template

type Template string

const (
	JSON       Template = "json"
	Markdown   Template = "md"
	HTML       Template = "html"
	Confluence Template = "confluence"
)

type TypeVariant

type TypeVariant string