Documentation
¶
Index ¶
- Constants
- type SystemAlive
- type SystemAliveHandler
- type SystemAliveHandlerFunc
- type SystemAliveOK
- type SystemAliveParams
- type SystemAliveURL
- func (o *SystemAliveURL) Build() (*url.URL, error)
- func (o *SystemAliveURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *SystemAliveURL) Must(u *url.URL, err error) *url.URL
- func (o *SystemAliveURL) SetBasePath(bp string)
- func (o *SystemAliveURL) String() string
- func (o *SystemAliveURL) StringFull(scheme, host string) string
- func (o *SystemAliveURL) WithBasePath(bp string) *SystemAliveURL
Constants ¶
const SystemAliveOKCode int = 200
SystemAliveOKCode is the HTTP code returned for type SystemAliveOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SystemAlive ¶ added in v0.0.3
type SystemAlive struct {
Context *middleware.Context
Handler SystemAliveHandler
}
SystemAlive swagger:route GET /api/alive system systemAlive
Used by Caddy or other reverse proxy to determine if the service is alive.
Used by Caddy or other reverse proxy to determine if the service is alive.
func NewSystemAlive ¶ added in v0.0.3
func NewSystemAlive(ctx *middleware.Context, handler SystemAliveHandler) *SystemAlive
NewSystemAlive creates a new http.Handler for the system alive operation
func (*SystemAlive) ServeHTTP ¶ added in v0.0.3
func (o *SystemAlive) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type SystemAliveHandler ¶ added in v0.0.3
type SystemAliveHandler interface {
Handle(SystemAliveParams) middleware.Responder
}
SystemAliveHandler interface for that can handle valid system alive params
type SystemAliveHandlerFunc ¶ added in v0.0.3
type SystemAliveHandlerFunc func(SystemAliveParams) middleware.Responder
SystemAliveHandlerFunc turns a function with the right signature into a system alive handler
func (SystemAliveHandlerFunc) Handle ¶ added in v0.0.3
func (fn SystemAliveHandlerFunc) Handle(params SystemAliveParams) middleware.Responder
Handle executing the request and returning a response
type SystemAliveOK ¶ added in v0.0.3
type SystemAliveOK struct {
}
SystemAliveOK Service is alive.
swagger:response systemAliveOK
func NewSystemAliveOK ¶ added in v0.0.3
func NewSystemAliveOK() *SystemAliveOK
NewSystemAliveOK creates SystemAliveOK with default headers values
func (*SystemAliveOK) WriteResponse ¶ added in v0.0.3
func (o *SystemAliveOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type SystemAliveParams ¶ added in v0.0.3
SystemAliveParams contains all the bound params for the system alive operation typically these are obtained from a http.Request
swagger:parameters systemAlive
func NewSystemAliveParams ¶ added in v0.0.3
func NewSystemAliveParams() SystemAliveParams
NewSystemAliveParams creates a new SystemAliveParams object
There are no default values defined in the spec.
func (*SystemAliveParams) BindRequest ¶ added in v0.0.3
func (o *SystemAliveParams) 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 NewSystemAliveParams() beforehand.
type SystemAliveURL ¶ added in v0.0.3
type SystemAliveURL struct {
// contains filtered or unexported fields
}
SystemAliveURL generates an URL for the system alive operation
func (*SystemAliveURL) Build ¶ added in v0.0.3
func (o *SystemAliveURL) Build() (*url.URL, error)
Build a url path and query string
func (*SystemAliveURL) BuildFull ¶ added in v0.0.3
func (o *SystemAliveURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*SystemAliveURL) Must ¶ added in v0.0.3
Must is a helper function to panic when the url builder returns an error
func (*SystemAliveURL) SetBasePath ¶ added in v0.0.3
func (o *SystemAliveURL) 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 (*SystemAliveURL) String ¶ added in v0.0.3
func (o *SystemAliveURL) String() string
String returns the string representation of the path with query string
func (*SystemAliveURL) StringFull ¶ added in v0.0.3
func (o *SystemAliveURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*SystemAliveURL) WithBasePath ¶ added in v0.0.3
func (o *SystemAliveURL) WithBasePath(bp string) *SystemAliveURL
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