Documentation ¶
Index ¶
- Constants
- type GetHostname
- type GetHostnameDefault
- func (o *GetHostnameDefault) SetPayload(payload *models.Error)
- func (o *GetHostnameDefault) SetStatusCode(code int)
- func (o *GetHostnameDefault) WithPayload(payload *models.Error) *GetHostnameDefault
- func (o *GetHostnameDefault) WithStatusCode(code int) *GetHostnameDefault
- func (o *GetHostnameDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type GetHostnameHandler
- type GetHostnameHandlerFunc
- type GetHostnameOK
- type GetHostnameParams
- type GetHostnameURL
- func (o *GetHostnameURL) Build() (*url.URL, error)
- func (o *GetHostnameURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *GetHostnameURL) Must(u *url.URL, err error) *url.URL
- func (o *GetHostnameURL) SetBasePath(bp string)
- func (o *GetHostnameURL) String() string
- func (o *GetHostnameURL) StringFull(scheme, host string) string
- func (o *GetHostnameURL) WithBasePath(bp string) *GetHostnameURL
- type HelloAPI
- func (o *HelloAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *HelloAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *HelloAPI) Authorizer() runtime.Authorizer
- func (o *HelloAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *HelloAPI) Context() *middleware.Context
- func (o *HelloAPI) DefaultConsumes() string
- func (o *HelloAPI) DefaultProduces() string
- func (o *HelloAPI) Formats() strfmt.Registry
- func (o *HelloAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *HelloAPI) Init()
- func (o *HelloAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *HelloAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *HelloAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *HelloAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *HelloAPI) Serve(builder middleware.Builder) http.Handler
- func (o *HelloAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *HelloAPI) SetDefaultConsumes(mediaType string)
- func (o *HelloAPI) SetDefaultProduces(mediaType string)
- func (o *HelloAPI) SetSpec(spec *loads.Document)
- func (o *HelloAPI) UseRedoc()
- func (o *HelloAPI) UseSwaggerUI()
- func (o *HelloAPI) Validate() error
Constants ¶
const GetHostnameOKCode int = 200
GetHostnameOKCode is the HTTP code returned for type GetHostnameOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetHostname ¶
type GetHostname struct { Context *middleware.Context Handler GetHostnameHandler }
GetHostname swagger:route GET /hostname getHostname
GetHostname get hostname API
func NewGetHostname ¶
func NewGetHostname(ctx *middleware.Context, handler GetHostnameHandler) *GetHostname
NewGetHostname creates a new http.Handler for the get hostname operation
func (*GetHostname) ServeHTTP ¶
func (o *GetHostname) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type GetHostnameDefault ¶
type GetHostnameDefault struct { /* In: Body */ Payload *models.Error `json:"body,omitempty"` // contains filtered or unexported fields }
GetHostnameDefault error
swagger:response getHostnameDefault
func NewGetHostnameDefault ¶
func NewGetHostnameDefault(code int) *GetHostnameDefault
NewGetHostnameDefault creates GetHostnameDefault with default headers values
func (*GetHostnameDefault) SetPayload ¶
func (o *GetHostnameDefault) SetPayload(payload *models.Error)
SetPayload sets the payload to the get hostname default response
func (*GetHostnameDefault) SetStatusCode ¶
func (o *GetHostnameDefault) SetStatusCode(code int)
SetStatusCode sets the status to the get hostname default response
func (*GetHostnameDefault) WithPayload ¶
func (o *GetHostnameDefault) WithPayload(payload *models.Error) *GetHostnameDefault
WithPayload adds the payload to the get hostname default response
func (*GetHostnameDefault) WithStatusCode ¶
func (o *GetHostnameDefault) WithStatusCode(code int) *GetHostnameDefault
WithStatusCode adds the status to the get hostname default response
func (*GetHostnameDefault) WriteResponse ¶
func (o *GetHostnameDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetHostnameHandler ¶
type GetHostnameHandler interface {
Handle(GetHostnameParams) middleware.Responder
}
GetHostnameHandler interface for that can handle valid get hostname params
type GetHostnameHandlerFunc ¶
type GetHostnameHandlerFunc func(GetHostnameParams) middleware.Responder
GetHostnameHandlerFunc turns a function with the right signature into a get hostname handler
func (GetHostnameHandlerFunc) Handle ¶
func (fn GetHostnameHandlerFunc) Handle(params GetHostnameParams) middleware.Responder
Handle executing the request and returning a response
type GetHostnameOK ¶
type GetHostnameOK struct { /*the hostname of the machine In: Body */ Payload string `json:"body,omitempty"` }
GetHostnameOK returns the hostname of the machine
swagger:response getHostnameOK
func NewGetHostnameOK ¶
func NewGetHostnameOK() *GetHostnameOK
NewGetHostnameOK creates GetHostnameOK with default headers values
func (*GetHostnameOK) SetPayload ¶
func (o *GetHostnameOK) SetPayload(payload string)
SetPayload sets the payload to the get hostname o k response
func (*GetHostnameOK) WithPayload ¶
func (o *GetHostnameOK) WithPayload(payload string) *GetHostnameOK
WithPayload adds the payload to the get hostname o k response
func (*GetHostnameOK) WriteResponse ¶
func (o *GetHostnameOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetHostnameParams ¶
GetHostnameParams contains all the bound params for the get hostname operation typically these are obtained from a http.Request
swagger:parameters getHostname
func NewGetHostnameParams ¶
func NewGetHostnameParams() GetHostnameParams
NewGetHostnameParams creates a new GetHostnameParams object
There are no default values defined in the spec.
func (*GetHostnameParams) BindRequest ¶
func (o *GetHostnameParams) 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 NewGetHostnameParams() beforehand.
type GetHostnameURL ¶
type GetHostnameURL struct {
// contains filtered or unexported fields
}
GetHostnameURL generates an URL for the get hostname operation
func (*GetHostnameURL) Build ¶
func (o *GetHostnameURL) Build() (*url.URL, error)
Build a url path and query string
func (*GetHostnameURL) BuildFull ¶
func (o *GetHostnameURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*GetHostnameURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*GetHostnameURL) SetBasePath ¶
func (o *GetHostnameURL) 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 (*GetHostnameURL) String ¶
func (o *GetHostnameURL) String() string
String returns the string representation of the path with query string
func (*GetHostnameURL) StringFull ¶
func (o *GetHostnameURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*GetHostnameURL) WithBasePath ¶
func (o *GetHostnameURL) WithBasePath(bp string) *GetHostnameURL
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
type HelloAPI ¶
type HelloAPI struct { Middleware func(middleware.Builder) http.Handler // BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function. // It has a default implementation in the security package, however you can replace it for your particular usage. BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator // APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function. // It has a default implementation in the security package, however you can replace it for your particular usage. APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator // BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function. // It has a default implementation in the security package, however you can replace it for your particular usage. BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator // JSONConsumer registers a consumer for the following mime types: // - application/json JSONConsumer runtime.Consumer // TxtProducer registers a producer for the following mime types: // - text/plain TxtProducer runtime.Producer // GetHostnameHandler sets the operation handler for the get hostname operation GetHostnameHandler GetHostnameHandler // ServeError is called when an error is received, there is a default handler // but you can set your own with this ServeError func(http.ResponseWriter, *http.Request, error) // PreServerShutdown is called before the HTTP(S) server is shutdown // This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic PreServerShutdown func() // ServerShutdown is called when the HTTP(S) server is shut down and done // handling all active connections and does not accept connections any more ServerShutdown func() // Custom command line argument groups with their descriptions CommandLineOptionsGroups []swag.CommandLineOptionsGroup // User defined logger function. Logger func(string, ...interface{}) // contains filtered or unexported fields }
HelloAPI the hello API
func NewHelloAPI ¶
NewHelloAPI creates a new Hello instance
func (*HelloAPI) AddMiddlewareFor ¶
func (o *HelloAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*HelloAPI) AuthenticatorsFor ¶
func (o *HelloAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*HelloAPI) Authorizer ¶
func (o *HelloAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*HelloAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*HelloAPI) Context ¶
func (o *HelloAPI) Context() *middleware.Context
Context returns the middleware context for the hello API
func (*HelloAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*HelloAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*HelloAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*HelloAPI) Init ¶
func (o *HelloAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*HelloAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*HelloAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*HelloAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*HelloAPI) RegisterProducer ¶
RegisterProducer allows you to add (or override) a producer for a media type.
func (*HelloAPI) Serve ¶
func (o *HelloAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*HelloAPI) ServeErrorFor ¶
func (o *HelloAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*HelloAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*HelloAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
func (*HelloAPI) UseSwaggerUI ¶
func (o *HelloAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs