lib

type APIDefinitions struct {
	Host       string
	Schemes    []string
	BasePath   string
	Methods    []APIMethod
	StructDefs map[string]StructDef
}

type APIMethod struct {
	Path               string
	Method             string
	Use                string
	Tags               []string                 `yaml:"tags"`
	Summary            string                   `yaml:"summary"`
	Description        string                   `yaml:"description"`
	OperationID        string                   `yaml:"operationId"`
	Security           []map[string]interface{} `yaml:"security"`
	CLI                []string                 `yaml:"x-soracom-cli"`
	Pagination         *Pagination              `yaml:"x-soracom-cli-pagination"`
	Parameters         []APIParam               `yaml:"parameters"`
	Responses          map[string]APIResponse   `yaml:"responses"`
	Deprecated         bool                     `yaml:"deprecated"`
	AlternativeCommand string                   `yaml:"x-soracom-alternative-cli"`
}

type APIParam struct {
	Name        string             `yaml:"name"`
	In          string             `yaml:"in"`
	Required    bool               `yaml:"required"`
	Description string             `yaml:"description"`
	Type        string             `yaml:"type"`
	Enum        []string           `yaml:"enum"`
	Default     interface{}        `yaml:"default,omitempty"`
	Schema      APIParamSchema     `yaml:"schema"`
	Items       APIParamArrayItems `yaml:"items"`
}

type APIParamArrayItems struct {
	Type   string `yaml:"type"`
	Format string `yaml:"format"`
}

type APIParamSchema struct {
	Type   string          `yaml:"type"`
	Format string          `yaml:"format"`
	Items  *APIParamSchema `yaml:"items"`
	Ref    string          `yaml:"$ref"`
}

type APIResponse struct {
	Schema *APIParamSchema
}

type Pagination struct {
	Response Response `yaml:"response"`
	Request  Request  `yaml:"request"`
}

type Request struct {
	Param string `yaml:"param"`
}

type Response struct {
	Header string `yaml:"header"`
}

type StructDef struct {
	Properties []StructProperty
	References []StructReference
}

type StructProperty struct {
	Name        string
	Type        string
	Format      string
	Description string
	Required    bool
	Default     interface{}
}

type StructReference struct {
	Name    string
	RefType string
}