Documentation
¶
Index ¶
- Constants
- type GetPing
- type GetPingHandler
- type GetPingHandlerFunc
- type GetPingOK
- type GetPingParams
- type GetPingURL
- func (o *GetPingURL) Build() (*url.URL, error)
- func (o *GetPingURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *GetPingURL) Must(u *url.URL, err error) *url.URL
- func (o *GetPingURL) SetBasePath(bp string)
- func (o *GetPingURL) String() string
- func (o *GetPingURL) StringFull(scheme, host string) string
- func (o *GetPingURL) WithBasePath(bp string) *GetPingURL
Constants ¶
const GetPingOKCode int = 200
GetPingOKCode is the HTTP code returned for type GetPingOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetPing ¶
type GetPing struct {
Context *middleware.Context
Handler GetPingHandler
}
GetPing swagger:route GET /ping ping getPing
Ping Harbor to check if it's alive.
This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.
func NewGetPing ¶
func NewGetPing(ctx *middleware.Context, handler GetPingHandler) *GetPing
NewGetPing creates a new http.Handler for the get ping operation
type GetPingHandler ¶
type GetPingHandler interface {
Handle(GetPingParams, interface{}) middleware.Responder
}
GetPingHandler interface for that can handle valid get ping params
type GetPingHandlerFunc ¶
type GetPingHandlerFunc func(GetPingParams, interface{}) middleware.Responder
GetPingHandlerFunc turns a function with the right signature into a get ping handler
func (GetPingHandlerFunc) Handle ¶
func (fn GetPingHandlerFunc) Handle(params GetPingParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type GetPingOK ¶
type GetPingOK struct {
/*
In: Body
*/
Payload string `json:"body,omitempty"`
}
GetPingOK The API server is alive
swagger:response getPingOK
func NewGetPingOK ¶
func NewGetPingOK() *GetPingOK
NewGetPingOK creates GetPingOK with default headers values
func (*GetPingOK) SetPayload ¶
SetPayload sets the payload to the get ping o k response
func (*GetPingOK) WithPayload ¶
WithPayload adds the payload to the get ping o k response
func (*GetPingOK) WriteResponse ¶
func (o *GetPingOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetPingParams ¶
GetPingParams contains all the bound params for the get ping operation typically these are obtained from a http.Request
swagger:parameters GetPing
func NewGetPingParams ¶
func NewGetPingParams() GetPingParams
NewGetPingParams creates a new GetPingParams object no default values defined in spec.
func (*GetPingParams) BindRequest ¶
func (o *GetPingParams) 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.
To ensure default values, the struct must have been initialized with NewGetPingParams() beforehand.
type GetPingURL ¶
type GetPingURL struct {
// contains filtered or unexported fields
}
GetPingURL generates an URL for the get ping operation
func (*GetPingURL) Build ¶
func (o *GetPingURL) Build() (*url.URL, error)
Build a url path and query string
func (*GetPingURL) BuildFull ¶
func (o *GetPingURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*GetPingURL) SetBasePath ¶
func (o *GetPingURL) 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 (*GetPingURL) String ¶
func (o *GetPingURL) String() string
String returns the string representation of the path with query string
func (*GetPingURL) StringFull ¶
func (o *GetPingURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*GetPingURL) WithBasePath ¶
func (o *GetPingURL) WithBasePath(bp string) *GetPingURL
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
Source Files