swagger

type Definition struct {
	// Type is probably always "object"
	Type                 string              `json:"type"`
	Properties           map[string]Property `json:"properties,omitempty"`
	AdditionalProperties any                 `json:"additionalProperties,omitempty"`
	Required             []string            `json:"required,omitempty"`
	Example              any                 `json:"example,omitempty"`
}

type Info struct {
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	Version     string `json:"version,omitempty"`
}

type Parameter struct {
	// Required. The location of the parameter. Possible values are "query",
	// "header", "path", "formData" or "body".
	In ParameterLocation `json:"in"`

	// Required. The name of the parameter. Parameter names are case sensitive.
	//  * If in is "path", the name field MUST correspond to the associated
	//    path segment from the path field in the Paths Object. See Path
	//    Templating for further information.
	//  * For all other cases, the name corresponds to the parameter name used
	//    based on the in property
	Name string `json:"name,omitempty"`

	// A brief description of the parameter. This could contain examples of
	// use. GFM syntax can be used for rich text representation.
	Description string `json:"description,omitempty"`

	// Determines whether this parameter is mandatory. If the parameter is in
	// "path", this property is required and its value MUST be true. Otherwise,
	// the property MAY be included and its default value is false.
	Required bool `json:"required,omitempty"`

	// If in is "body": Required. The schema defining the type used for the
	// body parameter.
	Schema any `json:"schema,omitempty"`

	// If in is any value other than "body"
	// Required. The type of the parameter. Since the parameter is not located
	// at the request body, it is limited to simple types (that is, not an
	// object). The value MUST be one of "string", "number", "integer",
	// "boolean", "array" or "file". If type is "file", the consumes MUST be
	// either "multipart/form-data", " application/x-www-form-urlencoded" or
	// both and the parameter MUST be in "formData".
	Type string `json:"type,omitempty"`
}

type ParameterLocation string

type Path map[RequestMethod]RequestDefinition

type Property struct {
	Type PropertyType `json:"type,omitempty"`

	// An optional format modifier serves as a hint at the contents and format
	// of the string
	Format PropertyFormat `json:"format,omitempty"`

	Example     any `json:"example,omitempty"`
	Ref         any `json:"$ref,omitempty"`
	Description any `json:"description,omitempty"`
	Items       any `json:"items,omitempty"`

	// If type is object
	Properties []Property `json:"properties,omitempty"`
}

type PropertyFormat string

type PropertyType string

type RequestDefinition struct {
	Summary     string           `json:"summary"`
	Description string           `json:"description"`
	Produces    []string         `json:"produces"`
	Consumes    []string         `json:"consumes"`
	Responses   map[int]Response `json:"responses"`
	Parameters  []Parameter      `json:"parameters"`
}

type RequestMethod string

type Response struct {
	Description string `json:"description,omitempty"`
	// This is a lookup into the responses section, not definitions
	Ref    string `json:"$ref,omitempty"`
	Schema any    `json:"schema,omitempty"`
}

type SchemaObject struct {
	Ref string `json:"$ref,omitempty"`
}

type Spec struct {
	Version     string                `json:"swagger"` // Must be 2.0
	Info        *Info                 `json:"info,omitempty"`
	Paths       map[string]Path       `json:"paths"`
	Definitions map[string]Definition `json:"definitions,omitempty"`
	Responses   map[string]Response   `json:"responses,omitempty"`
}