openapi

Documentation

Index

• Variables
• type Components
  • func (c Components) AllProperties() (result []openapi3.Schemas)
• type Content
  • func (c *Content) ContainsRef() bool
  • func (c *Content) CountFields() (result int)
• type Parameters
  • func FromParameterMap(paramMap openapi3.ParametersMap) Parameters
  • func (r Parameters) ContainsRef() bool
  • func (r Parameters) CountFields() int
  • func (r Parameters) RefsUsed() []string
• type RequestBody
  • func (r RequestBody) ContainsRef() (result bool)
  • func (r RequestBody) CountFields() (result int)
  • func (r RequestBody) RefsUsed() (result []string)
  • func (r RequestBody) Schemas() (result openapi3.SchemaRefs)
• type Response
  • func (r Response) ContainsRef() bool
  • func (r Response) CountFields() (result int)
  • func (r Response) RefsUsed() (result []string)
  • func (r Response) Schemas() (result []*openapi3.SchemaRef)
• type Responses
  • func (r Responses) RefsUsed() (result []string)
  • func (r Responses) Sorted() (result []Response)
• type SchemaRef
  • func (s SchemaRef) AllSchemas() (result openapi3.SchemaRefs)
  • func (s SchemaRef) HasAdditionalProperties() bool

Variables

var FuncMap = template.FuncMap{
	"requiredList": requiredList,
}

Types

type Components

type Components openapi3.Components

func (Components) AllProperties

func (c Components) AllProperties() (result []openapi3.Schemas)

type Content

type Content openapi3.Content

func (*Content) ContainsRef

func (c *Content) ContainsRef() bool

func (*Content) CountFields

func (c *Content) CountFields() (result int)

type Parameters

type Parameters openapi3.Parameters

func FromParameterMap

func FromParameterMap(paramMap openapi3.ParametersMap) Parameters

func (Parameters) ContainsRef

func (r Parameters) ContainsRef() bool

func (Parameters) CountFields

func (r Parameters) CountFields() int

func (Parameters) RefsUsed

func (r Parameters) RefsUsed() []string

type RequestBody

type RequestBody openapi3.RequestBodyRef

func (RequestBody) ContainsRef

func (r RequestBody) ContainsRef() (result bool)

func (RequestBody) CountFields

func (r RequestBody) CountFields() (result int)

func (RequestBody) RefsUsed

func (r RequestBody) RefsUsed() (result []string)

func (RequestBody) Schemas

func (r RequestBody) Schemas() (result openapi3.SchemaRefs)

type Response

type Response openapi3.ResponseRef

func (Response) ContainsRef

func (r Response) ContainsRef() bool

func (Response) CountFields

func (r Response) CountFields() (result int)

func (Response) RefsUsed

func (r Response) RefsUsed() (result []string)

func (Response) Schemas

func (r Response) Schemas() (result []*openapi3.SchemaRef)

type Responses

type Responses struct {
	openapi3.Responses
}

func (Responses) RefsUsed

func (r Responses) RefsUsed() (result []string)

func (Responses) Sorted

func (r Responses) Sorted() (result []Response)

type SchemaRef

type SchemaRef openapi3.SchemaRef

func (SchemaRef) AllSchemas

func (s SchemaRef) AllSchemas() (result openapi3.SchemaRefs)

AllSchemas will return every schemaRef object associated with this object Will Include: - The base schema - All the schemas part of the AllOf array (recursively) - Items, if the schema is an array (recursively)

func (SchemaRef) HasAdditionalProperties

func (s SchemaRef) HasAdditionalProperties() bool

HasAdditionalProperties returns true if the schema supports additionalProperties of any kind