openapi

type API struct {
	Operations []*Operation
	Components *Components
}

type Components struct {
	Parameters    map[string]*Parameter
	Schemas       map[string]*jsonschema.Schema
	RequestBodies map[string]*RequestBody
	Responses     map[string]*Response
}

type Example struct {
	Ref           string          `json:"$ref,omitempty"` // ref object
	Summary       string          `json:"summary,omitempty"`
	Description   string          `json:"description,omitempty"`
	Value         json.RawMessage `json:"value,omitempty"`
	ExternalValue string          `json:"externalValue,omitempty"`
}

type OAuthFlow struct {
	AuthorizationURL string
	TokenURL         string
	RefreshURL       string
	Scopes           map[string]string // name -> description
}

type OAuthFlows struct {
	Implicit          *OAuthFlow
	Password          *OAuthFlow
	ClientCredentials *OAuthFlow
	AuthorizationCode *OAuthFlow
}

type Operation struct {
	OperationID string // optional
	Description string // optional
	HTTPMethod  string
	Path        Path
	Parameters  []*Parameter
	RequestBody *RequestBody // optional

	// Security requirements.
	Security []SecurityRequirements

	// Operation responses.
	// Map is always non-nil.
	//
	// Key can be:
	//  * HTTP Status code
	//  * default
	//  * 1XX, 2XX, 3XX, 4XX, 5XX
	Responses map[string]*Response
}

type Parameter struct {
	Name        string
	Description string
	Schema      *jsonschema.Schema

	In       ParameterLocation
	Style    ParameterStyle
	Explode  bool
	Required bool
}

type ParameterLocation string

type ParameterStyle string

type Path []PathPart

type PathPart struct {
	Raw   string
	Param *Parameter
}

type RequestBody struct {
	Contents map[string]*jsonschema.Schema
	Required bool
}

type Response struct {
	Ref      string
	Contents map[string]*jsonschema.Schema
}

type Security struct {
	Type             string
	Description      string
	Name             string
	In               string
	Scheme           string
	BearerFormat     string
	Flows            OAuthFlows
	OpenIDConnectURL string
}

type SecurityRequirements struct {
	Scopes   []string
	Name     string
	Security Security
}