model

Documentation

Index

• type Endpoint
• type Param
  • func (p Param) Clone() Param
• type ParamSchema
  • func (p *ParamSchema) Clone() *ParamSchema
• type ParamType
• type Params
  • func (p Params) Clone() Params
• type Preview

Types

type Endpoint

type Endpoint struct {
	GithubCloudOnly bool
	EnabledForApps  bool
	Legacy          bool
	Deprecated      bool
	JSONBodySchema  *ParamSchema
	ID              string
	Path            string
	Method          string
	Name            string
	Concern         string
	DocsURL         string
	Summary         string
	HelpText        string
	PathParams      Params
	QueryParams     Params
	Headers         Params
	Previews        []Preview
}

type Param

type Param struct {
	Required bool
	Name     string
	HelpText string
	Schema   *ParamSchema
}

func (Param) Clone

func (p Param) Clone() Param

type ParamSchema

type ParamSchema struct {
	Type         ParamType
	ItemSchema   *ParamSchema
	ObjectParams []Param
}

func (*ParamSchema) Clone

func (p *ParamSchema) Clone() *ParamSchema

type ParamType

type ParamType int

const (
	ParamTypeInvalid ParamType = iota
	ParamTypeString
	ParamTypeInt
	ParamTypeBool
	ParamTypeObject
	ParamTypeArray
)

type Params

type Params []Param

func (Params) Clone

func (p Params) Clone() Params

type Preview

type Preview struct {
	Required bool
	Name     string
	Note     string
}