api

Documentation

Index

• Constants
• type AboutGet
  • func NewAboutGet(ctx *middleware.Context, handler AboutGetHandler) *AboutGet
  • func (o *AboutGet) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type AboutGetDefault
  • func NewAboutGetDefault(code int) *AboutGetDefault
  • func (o *AboutGetDefault) SetPayload(payload *models.ErrorResponse)
  • func (o *AboutGetDefault) SetStatusCode(code int)
  • func (o *AboutGetDefault) WithPayload(payload *models.ErrorResponse) *AboutGetDefault
  • func (o *AboutGetDefault) WithStatusCode(code int) *AboutGetDefault
  • func (o *AboutGetDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type AboutGetHandler
• type AboutGetHandlerFunc
  • func (fn AboutGetHandlerFunc) Handle(params AboutGetParams, principal interface{}) middleware.Responder
• type AboutGetOK
  • func NewAboutGetOK() *AboutGetOK
  • func (o *AboutGetOK) SetPayload(payload *models.About)
  • func (o *AboutGetOK) WithPayload(payload *models.About) *AboutGetOK
  • func (o *AboutGetOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type AboutGetParams
  • func NewAboutGetParams() AboutGetParams
  • func (o *AboutGetParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type AboutGetURL
  • func (o *AboutGetURL) Build() (*url.URL, error)
  • func (o *AboutGetURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *AboutGetURL) Must(u *url.URL, err error) *url.URL
  • func (o *AboutGetURL) SetBasePath(bp string)
  • func (o *AboutGetURL) String() string
  • func (o *AboutGetURL) StringFull(scheme, host string) string
  • func (o *AboutGetURL) WithBasePath(bp string) *AboutGetURL

Constants

const AboutGetOKCode int = 200

AboutGetOKCode is the HTTP code returned for type AboutGetOK

Types

type AboutGet

type AboutGet struct {
	Context *middleware.Context
	Handler AboutGetHandler
}

AboutGet swagger:route GET /about /api aboutGet

Get about

Information about on-network

func NewAboutGet

func NewAboutGet(ctx *middleware.Context, handler AboutGetHandler) *AboutGet

NewAboutGet creates a new http.Handler for the about get operation

func (*AboutGet) ServeHTTP

func (o *AboutGet) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type AboutGetDefault

type AboutGetDefault struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
	// contains filtered or unexported fields
}

AboutGetDefault Error

swagger:response aboutGetDefault

func NewAboutGetDefault

func NewAboutGetDefault(code int) *AboutGetDefault

NewAboutGetDefault creates AboutGetDefault with default headers values

func (*AboutGetDefault) SetPayload

func (o *AboutGetDefault) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the about get default response

func (*AboutGetDefault) SetStatusCode

func (o *AboutGetDefault) SetStatusCode(code int)

SetStatusCode sets the status to the about get default response

func (*AboutGetDefault) WithPayload

func (o *AboutGetDefault) WithPayload(payload *models.ErrorResponse) *AboutGetDefault

WithPayload adds the payload to the about get default response

func (*AboutGetDefault) WithStatusCode

func (o *AboutGetDefault) WithStatusCode(code int) *AboutGetDefault

WithStatusCode adds the status to the about get default response

func (*AboutGetDefault) WriteResponse

func (o *AboutGetDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AboutGetHandler

type AboutGetHandler interface {
	Handle(AboutGetParams, interface{}) middleware.Responder
}

AboutGetHandler interface for that can handle valid about get params

type AboutGetHandlerFunc

type AboutGetHandlerFunc func(AboutGetParams, interface{}) middleware.Responder

AboutGetHandlerFunc turns a function with the right signature into a about get handler

func (AboutGetHandlerFunc) Handle

func (fn AboutGetHandlerFunc) Handle(params AboutGetParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type AboutGetOK

type AboutGetOK struct {

	/*
	  In: Body
	*/
	Payload *models.About `json:"body,omitempty"`
}

AboutGetOK Successfully retrieved about

swagger:response aboutGetOK

func NewAboutGetOK

func NewAboutGetOK() *AboutGetOK

NewAboutGetOK creates AboutGetOK with default headers values

func (*AboutGetOK) SetPayload

func (o *AboutGetOK) SetPayload(payload *models.About)

SetPayload sets the payload to the about get o k response

func (*AboutGetOK) WithPayload

func (o *AboutGetOK) WithPayload(payload *models.About) *AboutGetOK

WithPayload adds the payload to the about get o k response

func (*AboutGetOK) WriteResponse

func (o *AboutGetOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AboutGetParams

type AboutGetParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request
}

AboutGetParams contains all the bound params for the about get operation typically these are obtained from a http.Request

swagger:parameters aboutGet

func NewAboutGetParams

func NewAboutGetParams() AboutGetParams

NewAboutGetParams creates a new AboutGetParams object with the default values initialized.

func (*AboutGetParams) BindRequest

func (o *AboutGetParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls

type AboutGetURL

type AboutGetURL struct {
	// contains filtered or unexported fields
}

AboutGetURL generates an URL for the about get operation

func (*AboutGetURL) Build

func (o *AboutGetURL) Build() (*url.URL, error)

Build a url path and query string

func (*AboutGetURL) BuildFull

func (o *AboutGetURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*AboutGetURL) Must

func (o *AboutGetURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*AboutGetURL) SetBasePath

func (o *AboutGetURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*AboutGetURL) String

func (o *AboutGetURL) String() string

String returns the string representation of the path with query string

func (*AboutGetURL) StringFull

func (o *AboutGetURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*AboutGetURL) WithBasePath

func (o *AboutGetURL) WithBasePath(bp string) *AboutGetURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string