model

Documentation

Index

• type Endpoint
  • func (e *Endpoint) Clone() *Endpoint
• type Param
  • func (p *Param) Clone() *Param
• type ParamSchema
  • func (p *ParamSchema) Clone() *ParamSchema
• type ParamType
  • func (pt ParamType) String() string
• type Preview
• type RequestBody
  • func (b *RequestBody) Clone() *RequestBody
• type Response
  • func (r *Response) Clone() *Response

Types

type Endpoint

type Endpoint struct {
	GithubCloudOnly  bool
	EnabledForApps   bool
	Legacy           bool
	Deprecated       bool
	ID               string
	Path             string
	Method           string
	Name             string
	Concern          string
	DocsURL          string
	Summary          string
	HelpText         string
	PathParams       []*Param
	QueryParams      []*Param
	Headers          []*Param
	Previews         []*Preview
	RequestBody      *RequestBody
	Responses        map[int]*Response
	SuccessMediaType string
}

func (*Endpoint) Clone

func (e *Endpoint) Clone() *Endpoint

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 {
	Nullable     bool
	Ref          string
	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
	ParamTypeNumber
	ParamTypeInterface
	ParamTypeObject
	ParamTypeArray
	ParamTypeOneOf
)

func (ParamType) String

func (pt ParamType) String() string

type Preview

type Preview struct {
	Required bool
	Name     string
	Note     string
}

type RequestBody

type RequestBody struct {
	MediaType string
	Schema    *ParamSchema
}

func (*RequestBody) Clone

func (b *RequestBody) Clone() *RequestBody

type Response

type Response struct {
	MediaType  string
	Body       *ParamSchema
	HasExample bool
}

func (*Response) Clone

func (r *Response) Clone() *Response