Documentation
¶
Index ¶
- Constants
- type AdminInfo
- type AdminInfoDefault
- func (o *AdminInfoDefault) SetPayload(payload *models.APIError)
- func (o *AdminInfoDefault) SetStatusCode(code int)
- func (o *AdminInfoDefault) WithPayload(payload *models.APIError) *AdminInfoDefault
- func (o *AdminInfoDefault) WithStatusCode(code int) *AdminInfoDefault
- func (o *AdminInfoDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type AdminInfoHandler
- type AdminInfoHandlerFunc
- type AdminInfoOK
- type AdminInfoParams
- type AdminInfoURL
- func (o *AdminInfoURL) Build() (*url.URL, error)
- func (o *AdminInfoURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *AdminInfoURL) Must(u *url.URL, err error) *url.URL
- func (o *AdminInfoURL) SetBasePath(bp string)
- func (o *AdminInfoURL) String() string
- func (o *AdminInfoURL) StringFull(scheme, host string) string
- func (o *AdminInfoURL) WithBasePath(bp string) *AdminInfoURL
Constants ¶
const AdminInfoOKCode int = 200
AdminInfoOKCode is the HTTP code returned for type AdminInfoOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdminInfo ¶
type AdminInfo struct {
Context *middleware.Context
Handler AdminInfoHandler
}
AdminInfo swagger:route GET /admin/info System adminInfo
Returns information about the deployment
func NewAdminInfo ¶
func NewAdminInfo(ctx *middleware.Context, handler AdminInfoHandler) *AdminInfo
NewAdminInfo creates a new http.Handler for the admin info operation
type AdminInfoDefault ¶
type AdminInfoDefault struct {
/*
In: Body
*/
Payload *models.APIError `json:"body,omitempty"`
// contains filtered or unexported fields
}
AdminInfoDefault Generic error response.
swagger:response adminInfoDefault
func NewAdminInfoDefault ¶
func NewAdminInfoDefault(code int) *AdminInfoDefault
NewAdminInfoDefault creates AdminInfoDefault with default headers values
func (*AdminInfoDefault) SetPayload ¶
func (o *AdminInfoDefault) SetPayload(payload *models.APIError)
SetPayload sets the payload to the admin info default response
func (*AdminInfoDefault) SetStatusCode ¶
func (o *AdminInfoDefault) SetStatusCode(code int)
SetStatusCode sets the status to the admin info default response
func (*AdminInfoDefault) WithPayload ¶
func (o *AdminInfoDefault) WithPayload(payload *models.APIError) *AdminInfoDefault
WithPayload adds the payload to the admin info default response
func (*AdminInfoDefault) WithStatusCode ¶
func (o *AdminInfoDefault) WithStatusCode(code int) *AdminInfoDefault
WithStatusCode adds the status to the admin info default response
func (*AdminInfoDefault) WriteResponse ¶
func (o *AdminInfoDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type AdminInfoHandler ¶
type AdminInfoHandler interface {
Handle(AdminInfoParams, *models.Principal) middleware.Responder
}
AdminInfoHandler interface for that can handle valid admin info params
type AdminInfoHandlerFunc ¶
type AdminInfoHandlerFunc func(AdminInfoParams, *models.Principal) middleware.Responder
AdminInfoHandlerFunc turns a function with the right signature into a admin info handler
func (AdminInfoHandlerFunc) Handle ¶
func (fn AdminInfoHandlerFunc) Handle(params AdminInfoParams, principal *models.Principal) middleware.Responder
Handle executing the request and returning a response
type AdminInfoOK ¶
type AdminInfoOK struct {
/*
In: Body
*/
Payload *models.AdminInfoResponse `json:"body,omitempty"`
}
AdminInfoOK A successful response.
swagger:response adminInfoOK
func NewAdminInfoOK ¶
func NewAdminInfoOK() *AdminInfoOK
NewAdminInfoOK creates AdminInfoOK with default headers values
func (*AdminInfoOK) SetPayload ¶
func (o *AdminInfoOK) SetPayload(payload *models.AdminInfoResponse)
SetPayload sets the payload to the admin info o k response
func (*AdminInfoOK) WithPayload ¶
func (o *AdminInfoOK) WithPayload(payload *models.AdminInfoResponse) *AdminInfoOK
WithPayload adds the payload to the admin info o k response
func (*AdminInfoOK) WriteResponse ¶
func (o *AdminInfoOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type AdminInfoParams ¶
type AdminInfoParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*
In: query
Default: false
*/
DefaultOnly *bool
}
AdminInfoParams contains all the bound params for the admin info operation typically these are obtained from a http.Request
swagger:parameters AdminInfo
func NewAdminInfoParams ¶
func NewAdminInfoParams() AdminInfoParams
NewAdminInfoParams creates a new AdminInfoParams object with the default values initialized.
func (*AdminInfoParams) BindRequest ¶
func (o *AdminInfoParams) 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 NewAdminInfoParams() beforehand.
type AdminInfoURL ¶
type AdminInfoURL struct {
DefaultOnly *bool
// contains filtered or unexported fields
}
AdminInfoURL generates an URL for the admin info operation
func (*AdminInfoURL) Build ¶
func (o *AdminInfoURL) Build() (*url.URL, error)
Build a url path and query string
func (*AdminInfoURL) BuildFull ¶
func (o *AdminInfoURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*AdminInfoURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*AdminInfoURL) SetBasePath ¶
func (o *AdminInfoURL) 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 (*AdminInfoURL) String ¶
func (o *AdminInfoURL) String() string
String returns the string representation of the path with query string
func (*AdminInfoURL) StringFull ¶
func (o *AdminInfoURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*AdminInfoURL) WithBasePath ¶
func (o *AdminInfoURL) WithBasePath(bp string) *AdminInfoURL
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