doc

type Document struct {
	Version  int              `yaml:"version" json:"version"`
	Domain   DocumentDomain   `yaml:"domain" json:"domain"`
	Sections DocumentSections `yaml:"sections" json:"sections"`
}

type DocumentDomain struct {
	Key   string `yaml:"key" json:"key"`
	Title string `yaml:"title" json:"title"`
}

type DocumentError DocumentErrorFragment

type DocumentErrorArgument DocumentErrorArgumentFragment

type DocumentErrorArgumentFragment struct {
	Type        string      `yaml:"type" json:"type"`
	Description string      `yaml:"description" json:"description"`
	Validators  []string    `yaml:"validators" json:"validators"`
	Default     interface{} `yaml:"default" json:"default"`
}

type DocumentErrorArgumentItem struct {
	Name     string
	Argument *DocumentErrorArgument
}

type DocumentErrorArguments map[string]*DocumentErrorArgument

type DocumentErrorDescription DocumentErrorDescriptionFragment

type DocumentErrorDescriptionFragment struct {
	Friendly  string `yaml:"friendly" json:"friendly"`
	Technical string `yaml:"technical" json:"technical"`
}

type DocumentErrorFragment struct {
	Title            string                      `json:"title"`
	Traits           []string                    `json:"traits"`
	Sensitivity      string                      `json:"sensitivity,omitempty"`
	Description      *DocumentErrorDescription   `json:"description"`
	Arguments        DocumentErrorArguments      `json:"arguments"`
	OrderedArguments []DocumentErrorArgumentItem `json:"-"`
	Metadata         DocumentErrorMetadata       `json:"metadata"`
}

type DocumentErrorHTTPMetadata DocumentErrorHTTPMetadataFragment

type DocumentErrorHTTPMetadataFragment struct {
	Status         int                                   `json:"status"`
	Headers        DocumentErrorHTTPMetadataHeaders      `json:"headers,omitempty"`
	OrderedHeaders []DocumentErrorHTTPMetadataHeaderItem `json:"-"`
}

type DocumentErrorHTTPMetadataHeader []string

type DocumentErrorHTTPMetadataHeaderItem struct {
	Name   string
	Values DocumentErrorHTTPMetadataHeader
}

type DocumentErrorHTTPMetadataHeaders map[string]DocumentErrorHTTPMetadataHeader

type DocumentErrorMetadata struct {
	HTTP *DocumentErrorHTTPMetadata `yaml:"http" json:"http"`
}

type DocumentErrors map[string]DocumentError

type DocumentSection struct {
	Title  string         `yaml:"title" json:"title"`
	Errors DocumentErrors `yaml:"errors" json:"errors"`
}

type DocumentSections map[string]DocumentSection

type DocumentVersionFragment struct {
	Version string `yaml:"version" json:"version"`
}