raml

type Documentation struct {
	// Title of the document.
	// Its value MUST be a non-empty string.
	Title string `yaml:"title"`
	// Content of the document.
	// Its value MUST be a non-empty string and MAY be formatted using markdown.
	Content string `yaml:"content"`
}

type Header struct {
	Description string `yaml:"description,omitempty"`
	Type        string `yaml:"type"`
}

type Property struct {
	Type string `yaml:"type"`
	// Specifies that the Property is required or not.
	Required bool `yaml:"required"`
}

type Raml struct {
	// A short, plain-text label for the API.
	// Its value is a string.
	Title string `yaml:"title"`
	// A substantial, human-friendly description of the API.
	// Its value is a string and MAY be formatted using markdown.
	Description string `yaml:"description"`
	// The version of the API, for example "v1".
	// Its value is a string.
	Version string `yaml:"version"`
	// A URI that serves as the base for URIs of all resources.
	// Often used as the base of the URL of each resource containing the location of the API.
	// Can be a template URI.
	BaseUri string `yaml:"baseUri"`
	// The default media types to use for request and response bodies (payloads), for example "application/json".
	MediaType []string `yaml:"mediaType"`
	// Additional overall documentation for the API.
	Documentation []Documentation             `yaml:"documentation"`
	Types         map[string]Type             `yaml:"types"`
	Routes        map[string]map[string]Route `yaml:"-"`
}

type Response struct {
	Body map[string]Type `yaml:"body"`
}

type Route struct {
	Headers     map[string]Header   `yaml:"headers,omitempty"`
	Body        map[string]Type     `yaml:"body,omitempty"`
	Responses   map[string]Response `yaml:"responses"`
	Description string              `yaml:"description,omitempty"`
}

type Type struct {
	// The type which the current type extends or just wraps.
	// The value of a type node MUST be either
	// a) the name of a user-defined type or
	// b) the name of a built-in RAML data type (object, array, or one of the scalar types)
	Type string `yaml:"type"`
	// An alternate, human-friendly name for the type
	DisplayName string `yaml:"displayName,omitempty"`
	// A substantial, human-friendly description of the type.
	// Its value is a string and MAY be formatted using markdown.
	Description string              `yaml:"description,omitempty"`
	Properties  map[string]Property `yaml:"properties,omitempty"`
}