route

Documentation

Index

• type ConnectionRes
• type Operation
  • func New(ctx provider) (*Operation, error)
  • func (o *Operation) Connection(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) GetRESTHandlers() []rest.Handler
  • func (o *Operation) Register(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) Unregister(rw http.ResponseWriter, req *http.Request)

Types

type ConnectionRes

type ConnectionRes struct {
	// in: body
	Params route.RegisterRoute
}

ConnectionRes model

response of get connection action

swagger:response getConnectionResponse

type Operation

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

Operation contains basic common operations provided by controller REST API

func New

func New(ctx provider) (*Operation, error)

New returns new common operations rest client instance

func (*Operation) Connection

func (o *Operation) Connection(rw http.ResponseWriter, req *http.Request)

Connection swagger:route GET /route/connection route routerConnection

Retrieves the router connection id.

Responses:

default: genericError
200: getConnectionResponse

func (*Operation) GetRESTHandlers

func (o *Operation) GetRESTHandlers() []rest.Handler

GetRESTHandlers get all controller API handler available for this service

func (*Operation) Register

func (o *Operation) Register(rw http.ResponseWriter, req *http.Request)

Register swagger:route POST /route/register route registerRouteRequest

Registers the agent with the router.

Responses:

default: genericError
200: registerRouteRes

func (*Operation) Unregister

func (o *Operation) Unregister(rw http.ResponseWriter, req *http.Request)

Unregister swagger:route DELETE /route/unregister route unregisterRouter

Unregisters the agent with the router.

Responses:

default: genericError