spec

type Binding struct {
	Arg    *ifacetool.Param // The method argument.
	Params []*Parameter     // The corresponding request parameters
}

type Location string

type Metadata struct {
	// Relative path to the OAS documentation.
	DocsPath string

	Title       string
	Version     string
	Description string
	BasePath    string

	// Default tags for operations those have no tags.
	DefaultTags []string
}

type Operation struct {
	// In cases where multiple `//kun:op` are specified for one Go method,
	// Name and GoMethodName will be different.
	Name         string
	GoMethodName string

	Method           string
	Pattern          string
	Request          *Request
	SuccessResponse  *Response
	FailureResponses []*Response
	Description      string
	Tags             []string
}

type Parameter struct {
	In          Location // The location of the parameter.
	Name        string   // The name of the parameter.
	Required    bool     // Whether this parameter is mandatory.
	Type        string   // The type of the parameter.
	Description string   // A brief description of the parameter.
}

type Request struct {
	MediaType string

	// The name of the request field whose value is mapped to the HTTP request body.
	// Otherwise, all fields not located in path/query/header will be mapped to the HTTP body
	BodyField string

	Bindings []*Binding
}

type Response struct {
	StatusCode int
	MediaType  string
	Schema     interface{}

	// The name of the response field whose value is mapped to the HTTP response body.
	// When omitted, the entire response struct will be used as the HTTP response body.
	BodyField string
}

type Specification struct {
	Metadata   *Metadata
	Operations []*Operation
}