operations

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 27, 2023 License: AGPL-3.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const AllowBadRequestCode int = 400

AllowBadRequestCode is the HTTP code returned for type AllowBadRequest

View Source
const AllowNoContentCode int = 204

AllowNoContentCode is the HTTP code returned for type AllowNoContent

View Source
const AllowUnauthorizedCode int = 401

AllowUnauthorizedCode is the HTTP code returned for type AllowUnauthorized

View Source
const DenyBadRequestCode int = 400

DenyBadRequestCode is the HTTP code returned for type DenyBadRequest

View Source
const DenyNoContentCode int = 204

DenyNoContentCode is the HTTP code returned for type DenyNoContent

View Source
const DenyUnauthorizedCode int = 401

DenyUnauthorizedCode is the HTTP code returned for type DenyUnauthorized

View Source
const ListAllowedOKCode int = 200

ListAllowedOKCode is the HTTP code returned for type ListAllowedOK

View Source
const ListAllowedUnauthorizedCode int = 401

ListAllowedUnauthorizedCode is the HTTP code returned for type ListAllowedUnauthorized

View Source
const ListDeniedOKCode int = 200

ListDeniedOKCode is the HTTP code returned for type ListDeniedOK

View Source
const ListDeniedUnauthorizedCode int = 401

ListDeniedUnauthorizedCode is the HTTP code returned for type ListDeniedUnauthorized

View Source
const SessionBadRequestCode int = 400

SessionBadRequestCode is the HTTP code returned for type SessionBadRequest

View Source
const SessionOKCode int = 200

SessionOKCode is the HTTP code returned for type SessionOK

View Source
const SessionUnauthorizedCode int = 401

SessionUnauthorizedCode is the HTTP code returned for type SessionUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessAPI

type AccessAPI 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

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// BearerAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key Authorization provided in the header
	BearerAuth func(string) (interface{}, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// AllowHandler sets the operation handler for the allow operation
	AllowHandler AllowHandler
	// DenyHandler sets the operation handler for the deny operation
	DenyHandler DenyHandler
	// ListAllowedHandler sets the operation handler for the list allowed operation
	ListAllowedHandler ListAllowedHandler
	// ListDeniedHandler sets the operation handler for the list denied operation
	ListDeniedHandler ListDeniedHandler
	// SessionHandler sets the operation handler for the session operation
	SessionHandler SessionHandler

	// 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
}

AccessAPI API for accessing github.com/practable/relay websocket relay. Note scheme http and host localhost due to running behind proxy

func NewAccessAPI

func NewAccessAPI(spec *loads.Document) *AccessAPI

NewAccessAPI creates a new Access instance

func (*AccessAPI) AddMiddlewareFor

func (o *AccessAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*AccessAPI) AuthenticatorsFor

func (o *AccessAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*AccessAPI) Authorizer

func (o *AccessAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*AccessAPI) ConsumersFor

func (o *AccessAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*AccessAPI) Context

func (o *AccessAPI) Context() *middleware.Context

Context returns the middleware context for the access API

func (*AccessAPI) DefaultConsumes

func (o *AccessAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*AccessAPI) DefaultProduces

func (o *AccessAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*AccessAPI) Formats

func (o *AccessAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*AccessAPI) HandlerFor

func (o *AccessAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*AccessAPI) Init

func (o *AccessAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*AccessAPI) ProducersFor

func (o *AccessAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*AccessAPI) RegisterConsumer

func (o *AccessAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*AccessAPI) RegisterFormat

func (o *AccessAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*AccessAPI) RegisterProducer

func (o *AccessAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*AccessAPI) Serve

func (o *AccessAPI) 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 (*AccessAPI) ServeErrorFor

func (o *AccessAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*AccessAPI) SetDefaultConsumes

func (o *AccessAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*AccessAPI) SetDefaultProduces

func (o *AccessAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*AccessAPI) SetSpec

func (o *AccessAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*AccessAPI) UseRedoc

func (o *AccessAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*AccessAPI) UseSwaggerUI

func (o *AccessAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*AccessAPI) Validate

func (o *AccessAPI) Validate() error

Validate validates the registrations in the AccessAPI

type Allow added in v0.3.0

type Allow struct {
	Context *middleware.Context
	Handler AllowHandler
}
Allow swagger:route POST /bids/allow allow

Undo the denial of a booking id

Undo the denial of a booking id

func NewAllow added in v0.3.0

func NewAllow(ctx *middleware.Context, handler AllowHandler) *Allow

NewAllow creates a new http.Handler for the allow operation

func (*Allow) ServeHTTP added in v0.3.0

func (o *Allow) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type AllowBadRequest added in v0.3.0

type AllowBadRequest struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

AllowBadRequest BadRequest

swagger:response allowBadRequest

func NewAllowBadRequest added in v0.3.0

func NewAllowBadRequest() *AllowBadRequest

NewAllowBadRequest creates AllowBadRequest with default headers values

func (*AllowBadRequest) SetPayload added in v0.3.0

func (o *AllowBadRequest) SetPayload(payload *models.Error)

SetPayload sets the payload to the allow bad request response

func (*AllowBadRequest) WithPayload added in v0.3.0

func (o *AllowBadRequest) WithPayload(payload *models.Error) *AllowBadRequest

WithPayload adds the payload to the allow bad request response

func (*AllowBadRequest) WriteResponse added in v0.3.0

func (o *AllowBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AllowHandler added in v0.3.0

type AllowHandler interface {
	Handle(AllowParams, interface{}) middleware.Responder
}

AllowHandler interface for that can handle valid allow params

type AllowHandlerFunc added in v0.3.0

type AllowHandlerFunc func(AllowParams, interface{}) middleware.Responder

AllowHandlerFunc turns a function with the right signature into a allow handler

func (AllowHandlerFunc) Handle added in v0.3.0

func (fn AllowHandlerFunc) Handle(params AllowParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type AllowNoContent added in v0.3.0

type AllowNoContent struct {
}

AllowNoContent The bid was allowed successfully.

swagger:response allowNoContent

func NewAllowNoContent added in v0.3.0

func NewAllowNoContent() *AllowNoContent

NewAllowNoContent creates AllowNoContent with default headers values

func (*AllowNoContent) WriteResponse added in v0.3.0

func (o *AllowNoContent) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type AllowParams added in v0.3.0

type AllowParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: query
	*/
	Bid string
	/*
	  Required: true
	  In: query
	*/
	Exp int64
}

AllowParams contains all the bound params for the allow operation typically these are obtained from a http.Request

swagger:parameters allow

func NewAllowParams added in v0.3.0

func NewAllowParams() AllowParams

NewAllowParams creates a new AllowParams object

There are no default values defined in the spec.

func (*AllowParams) BindRequest added in v0.3.0

func (o *AllowParams) 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 NewAllowParams() beforehand.

type AllowURL added in v0.3.0

type AllowURL struct {
	Bid string
	Exp int64
	// contains filtered or unexported fields
}

AllowURL generates an URL for the allow operation

func (*AllowURL) Build added in v0.3.0

func (o *AllowURL) Build() (*url.URL, error)

Build a url path and query string

func (*AllowURL) BuildFull added in v0.3.0

func (o *AllowURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*AllowURL) Must added in v0.3.0

func (o *AllowURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*AllowURL) SetBasePath added in v0.3.0

func (o *AllowURL) 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 (*AllowURL) String added in v0.3.0

func (o *AllowURL) String() string

String returns the string representation of the path with query string

func (*AllowURL) StringFull added in v0.3.0

func (o *AllowURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*AllowURL) WithBasePath added in v0.3.0

func (o *AllowURL) WithBasePath(bp string) *AllowURL

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 AllowUnauthorized added in v0.3.0

type AllowUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

AllowUnauthorized Unauthorized

swagger:response allowUnauthorized

func NewAllowUnauthorized added in v0.3.0

func NewAllowUnauthorized() *AllowUnauthorized

NewAllowUnauthorized creates AllowUnauthorized with default headers values

func (*AllowUnauthorized) SetPayload added in v0.3.0

func (o *AllowUnauthorized) SetPayload(payload *models.Error)

SetPayload sets the payload to the allow unauthorized response

func (*AllowUnauthorized) WithPayload added in v0.3.0

func (o *AllowUnauthorized) WithPayload(payload *models.Error) *AllowUnauthorized

WithPayload adds the payload to the allow unauthorized response

func (*AllowUnauthorized) WriteResponse added in v0.3.0

func (o *AllowUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type Deny added in v0.3.0

type Deny struct {
	Context *middleware.Context
	Handler DenyHandler
}
Deny swagger:route POST /bids/deny deny

Refuse sessions to new connections using tokens with the bid(s) (booking ids), and disconnect any current sessions immediately.

Refuse sessions to new connections using tokens with the bid (booking id), and disconnect any current sessions immediately. The exp term is the unix time in UTC when the booking finishes (i.e. the earliest time it is safe to remove the bid from the deny list)

func NewDeny added in v0.3.0

func NewDeny(ctx *middleware.Context, handler DenyHandler) *Deny

NewDeny creates a new http.Handler for the deny operation

func (*Deny) ServeHTTP added in v0.3.0

func (o *Deny) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type DenyBadRequest added in v0.3.0

type DenyBadRequest struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

DenyBadRequest BadRequest

swagger:response denyBadRequest

func NewDenyBadRequest added in v0.3.0

func NewDenyBadRequest() *DenyBadRequest

NewDenyBadRequest creates DenyBadRequest with default headers values

func (*DenyBadRequest) SetPayload added in v0.3.0

func (o *DenyBadRequest) SetPayload(payload *models.Error)

SetPayload sets the payload to the deny bad request response

func (*DenyBadRequest) WithPayload added in v0.3.0

func (o *DenyBadRequest) WithPayload(payload *models.Error) *DenyBadRequest

WithPayload adds the payload to the deny bad request response

func (*DenyBadRequest) WriteResponse added in v0.3.0

func (o *DenyBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DenyHandler added in v0.3.0

type DenyHandler interface {
	Handle(DenyParams, interface{}) middleware.Responder
}

DenyHandler interface for that can handle valid deny params

type DenyHandlerFunc added in v0.3.0

type DenyHandlerFunc func(DenyParams, interface{}) middleware.Responder

DenyHandlerFunc turns a function with the right signature into a deny handler

func (DenyHandlerFunc) Handle added in v0.3.0

func (fn DenyHandlerFunc) Handle(params DenyParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type DenyNoContent added in v0.3.0

type DenyNoContent struct {
}

DenyNoContent The bid was denied successfully.

swagger:response denyNoContent

func NewDenyNoContent added in v0.3.0

func NewDenyNoContent() *DenyNoContent

NewDenyNoContent creates DenyNoContent with default headers values

func (*DenyNoContent) WriteResponse added in v0.3.0

func (o *DenyNoContent) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DenyParams added in v0.3.0

type DenyParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: query
	*/
	Bid string
	/*
	  Required: true
	  In: query
	*/
	Exp int64
}

DenyParams contains all the bound params for the deny operation typically these are obtained from a http.Request

swagger:parameters deny

func NewDenyParams added in v0.3.0

func NewDenyParams() DenyParams

NewDenyParams creates a new DenyParams object

There are no default values defined in the spec.

func (*DenyParams) BindRequest added in v0.3.0

func (o *DenyParams) 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 NewDenyParams() beforehand.

type DenyURL added in v0.3.0

type DenyURL struct {
	Bid string
	Exp int64
	// contains filtered or unexported fields
}

DenyURL generates an URL for the deny operation

func (*DenyURL) Build added in v0.3.0

func (o *DenyURL) Build() (*url.URL, error)

Build a url path and query string

func (*DenyURL) BuildFull added in v0.3.0

func (o *DenyURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*DenyURL) Must added in v0.3.0

func (o *DenyURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*DenyURL) SetBasePath added in v0.3.0

func (o *DenyURL) 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 (*DenyURL) String added in v0.3.0

func (o *DenyURL) String() string

String returns the string representation of the path with query string

func (*DenyURL) StringFull added in v0.3.0

func (o *DenyURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*DenyURL) WithBasePath added in v0.3.0

func (o *DenyURL) WithBasePath(bp string) *DenyURL

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 DenyUnauthorized added in v0.3.0

type DenyUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

DenyUnauthorized Unauthorized

swagger:response denyUnauthorized

func NewDenyUnauthorized added in v0.3.0

func NewDenyUnauthorized() *DenyUnauthorized

NewDenyUnauthorized creates DenyUnauthorized with default headers values

func (*DenyUnauthorized) SetPayload added in v0.3.0

func (o *DenyUnauthorized) SetPayload(payload *models.Error)

SetPayload sets the payload to the deny unauthorized response

func (*DenyUnauthorized) WithPayload added in v0.3.0

func (o *DenyUnauthorized) WithPayload(payload *models.Error) *DenyUnauthorized

WithPayload adds the payload to the deny unauthorized response

func (*DenyUnauthorized) WriteResponse added in v0.3.0

func (o *DenyUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListAllowed added in v0.3.0

type ListAllowed struct {
	Context *middleware.Context
	Handler ListAllowedHandler
}
ListAllowed swagger:route GET /bids/allow listAllowed

Get a list of all currently-allowed bids

Get a list of all currently-allowed bids (booking ids) with an ongoing or recent live connection

func NewListAllowed added in v0.3.0

func NewListAllowed(ctx *middleware.Context, handler ListAllowedHandler) *ListAllowed

NewListAllowed creates a new http.Handler for the list allowed operation

func (*ListAllowed) ServeHTTP added in v0.3.0

func (o *ListAllowed) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type ListAllowedHandler added in v0.3.0

type ListAllowedHandler interface {
	Handle(ListAllowedParams, interface{}) middleware.Responder
}

ListAllowedHandler interface for that can handle valid list allowed params

type ListAllowedHandlerFunc added in v0.3.0

type ListAllowedHandlerFunc func(ListAllowedParams, interface{}) middleware.Responder

ListAllowedHandlerFunc turns a function with the right signature into a list allowed handler

func (ListAllowedHandlerFunc) Handle added in v0.3.0

func (fn ListAllowedHandlerFunc) Handle(params ListAllowedParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type ListAllowedOK added in v0.3.0

type ListAllowedOK struct {

	/*
	  In: Body
	*/
	Payload *models.BookingIDs `json:"body,omitempty"`
}

ListAllowedOK Current or recently in-use allowed bids

swagger:response listAllowedOK

func NewListAllowedOK added in v0.3.0

func NewListAllowedOK() *ListAllowedOK

NewListAllowedOK creates ListAllowedOK with default headers values

func (*ListAllowedOK) SetPayload added in v0.3.0

func (o *ListAllowedOK) SetPayload(payload *models.BookingIDs)

SetPayload sets the payload to the list allowed o k response

func (*ListAllowedOK) WithPayload added in v0.3.0

func (o *ListAllowedOK) WithPayload(payload *models.BookingIDs) *ListAllowedOK

WithPayload adds the payload to the list allowed o k response

func (*ListAllowedOK) WriteResponse added in v0.3.0

func (o *ListAllowedOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListAllowedParams added in v0.3.0

type ListAllowedParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

ListAllowedParams contains all the bound params for the list allowed operation typically these are obtained from a http.Request

swagger:parameters listAllowed

func NewListAllowedParams added in v0.3.0

func NewListAllowedParams() ListAllowedParams

NewListAllowedParams creates a new ListAllowedParams object

There are no default values defined in the spec.

func (*ListAllowedParams) BindRequest added in v0.3.0

func (o *ListAllowedParams) 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 NewListAllowedParams() beforehand.

type ListAllowedURL added in v0.3.0

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

ListAllowedURL generates an URL for the list allowed operation

func (*ListAllowedURL) Build added in v0.3.0

func (o *ListAllowedURL) Build() (*url.URL, error)

Build a url path and query string

func (*ListAllowedURL) BuildFull added in v0.3.0

func (o *ListAllowedURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*ListAllowedURL) Must added in v0.3.0

func (o *ListAllowedURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*ListAllowedURL) SetBasePath added in v0.3.0

func (o *ListAllowedURL) 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 (*ListAllowedURL) String added in v0.3.0

func (o *ListAllowedURL) String() string

String returns the string representation of the path with query string

func (*ListAllowedURL) StringFull added in v0.3.0

func (o *ListAllowedURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*ListAllowedURL) WithBasePath added in v0.3.0

func (o *ListAllowedURL) WithBasePath(bp string) *ListAllowedURL

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 ListAllowedUnauthorized added in v0.3.0

type ListAllowedUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

ListAllowedUnauthorized Unauthorized

swagger:response listAllowedUnauthorized

func NewListAllowedUnauthorized added in v0.3.0

func NewListAllowedUnauthorized() *ListAllowedUnauthorized

NewListAllowedUnauthorized creates ListAllowedUnauthorized with default headers values

func (*ListAllowedUnauthorized) SetPayload added in v0.3.0

func (o *ListAllowedUnauthorized) SetPayload(payload *models.Error)

SetPayload sets the payload to the list allowed unauthorized response

func (*ListAllowedUnauthorized) WithPayload added in v0.3.0

func (o *ListAllowedUnauthorized) WithPayload(payload *models.Error) *ListAllowedUnauthorized

WithPayload adds the payload to the list allowed unauthorized response

func (*ListAllowedUnauthorized) WriteResponse added in v0.3.0

func (o *ListAllowedUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListDenied added in v0.3.0

type ListDenied struct {
	Context *middleware.Context
	Handler ListDeniedHandler
}
ListDenied swagger:route GET /bids/deny listDenied

Get a list of all currently-denied bids

Get a list of all currently-denied bids

func NewListDenied added in v0.3.0

func NewListDenied(ctx *middleware.Context, handler ListDeniedHandler) *ListDenied

NewListDenied creates a new http.Handler for the list denied operation

func (*ListDenied) ServeHTTP added in v0.3.0

func (o *ListDenied) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type ListDeniedHandler added in v0.3.0

type ListDeniedHandler interface {
	Handle(ListDeniedParams, interface{}) middleware.Responder
}

ListDeniedHandler interface for that can handle valid list denied params

type ListDeniedHandlerFunc added in v0.3.0

type ListDeniedHandlerFunc func(ListDeniedParams, interface{}) middleware.Responder

ListDeniedHandlerFunc turns a function with the right signature into a list denied handler

func (ListDeniedHandlerFunc) Handle added in v0.3.0

func (fn ListDeniedHandlerFunc) Handle(params ListDeniedParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type ListDeniedOK added in v0.3.0

type ListDeniedOK struct {

	/*
	  In: Body
	*/
	Payload *models.BookingIDs `json:"body,omitempty"`
}

ListDeniedOK List of current denied bids

swagger:response listDeniedOK

func NewListDeniedOK added in v0.3.0

func NewListDeniedOK() *ListDeniedOK

NewListDeniedOK creates ListDeniedOK with default headers values

func (*ListDeniedOK) SetPayload added in v0.3.0

func (o *ListDeniedOK) SetPayload(payload *models.BookingIDs)

SetPayload sets the payload to the list denied o k response

func (*ListDeniedOK) WithPayload added in v0.3.0

func (o *ListDeniedOK) WithPayload(payload *models.BookingIDs) *ListDeniedOK

WithPayload adds the payload to the list denied o k response

func (*ListDeniedOK) WriteResponse added in v0.3.0

func (o *ListDeniedOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListDeniedParams added in v0.3.0

type ListDeniedParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

ListDeniedParams contains all the bound params for the list denied operation typically these are obtained from a http.Request

swagger:parameters listDenied

func NewListDeniedParams added in v0.3.0

func NewListDeniedParams() ListDeniedParams

NewListDeniedParams creates a new ListDeniedParams object

There are no default values defined in the spec.

func (*ListDeniedParams) BindRequest added in v0.3.0

func (o *ListDeniedParams) 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 NewListDeniedParams() beforehand.

type ListDeniedURL added in v0.3.0

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

ListDeniedURL generates an URL for the list denied operation

func (*ListDeniedURL) Build added in v0.3.0

func (o *ListDeniedURL) Build() (*url.URL, error)

Build a url path and query string

func (*ListDeniedURL) BuildFull added in v0.3.0

func (o *ListDeniedURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*ListDeniedURL) Must added in v0.3.0

func (o *ListDeniedURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*ListDeniedURL) SetBasePath added in v0.3.0

func (o *ListDeniedURL) 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 (*ListDeniedURL) String added in v0.3.0

func (o *ListDeniedURL) String() string

String returns the string representation of the path with query string

func (*ListDeniedURL) StringFull added in v0.3.0

func (o *ListDeniedURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*ListDeniedURL) WithBasePath added in v0.3.0

func (o *ListDeniedURL) WithBasePath(bp string) *ListDeniedURL

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 ListDeniedUnauthorized added in v0.3.0

type ListDeniedUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

ListDeniedUnauthorized Unauthorized

swagger:response listDeniedUnauthorized

func NewListDeniedUnauthorized added in v0.3.0

func NewListDeniedUnauthorized() *ListDeniedUnauthorized

NewListDeniedUnauthorized creates ListDeniedUnauthorized with default headers values

func (*ListDeniedUnauthorized) SetPayload added in v0.3.0

func (o *ListDeniedUnauthorized) SetPayload(payload *models.Error)

SetPayload sets the payload to the list denied unauthorized response

func (*ListDeniedUnauthorized) WithPayload added in v0.3.0

func (o *ListDeniedUnauthorized) WithPayload(payload *models.Error) *ListDeniedUnauthorized

WithPayload adds the payload to the list denied unauthorized response

func (*ListDeniedUnauthorized) WriteResponse added in v0.3.0

func (o *ListDeniedUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type Session

type Session struct {
	Context *middleware.Context
	Handler SessionHandler
}
Session swagger:route POST /session/{session_id} session

session

access the specified session

func NewSession

func NewSession(ctx *middleware.Context, handler SessionHandler) *Session

NewSession creates a new http.Handler for the session operation

func (*Session) ServeHTTP

func (o *Session) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type SessionBadRequest added in v0.3.0

type SessionBadRequest struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

SessionBadRequest BadRequest

swagger:response sessionBadRequest

func NewSessionBadRequest added in v0.3.0

func NewSessionBadRequest() *SessionBadRequest

NewSessionBadRequest creates SessionBadRequest with default headers values

func (*SessionBadRequest) SetPayload added in v0.3.0

func (o *SessionBadRequest) SetPayload(payload *models.Error)

SetPayload sets the payload to the session bad request response

func (*SessionBadRequest) WithPayload added in v0.3.0

func (o *SessionBadRequest) WithPayload(payload *models.Error) *SessionBadRequest

WithPayload adds the payload to the session bad request response

func (*SessionBadRequest) WriteResponse added in v0.3.0

func (o *SessionBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type SessionHandler

type SessionHandler interface {
	Handle(SessionParams, interface{}) middleware.Responder
}

SessionHandler interface for that can handle valid session params

type SessionHandlerFunc

type SessionHandlerFunc func(SessionParams, interface{}) middleware.Responder

SessionHandlerFunc turns a function with the right signature into a session handler

func (SessionHandlerFunc) Handle

func (fn SessionHandlerFunc) Handle(params SessionParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type SessionOK

type SessionOK struct {

	/*
	  In: Body
	*/
	Payload *SessionOKBody `json:"body,omitempty"`
}

SessionOK session o k

swagger:response sessionOK

func NewSessionOK

func NewSessionOK() *SessionOK

NewSessionOK creates SessionOK with default headers values

func (*SessionOK) SetPayload

func (o *SessionOK) SetPayload(payload *SessionOKBody)

SetPayload sets the payload to the session o k response

func (*SessionOK) WithPayload

func (o *SessionOK) WithPayload(payload *SessionOKBody) *SessionOK

WithPayload adds the payload to the session o k response

func (*SessionOK) WriteResponse

func (o *SessionOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type SessionOKBody

type SessionOKBody struct {

	// uri
	URI string `json:"uri,omitempty"`
}

SessionOKBody session o k body

swagger:model SessionOKBody

func (*SessionOKBody) ContextValidate added in v0.3.0

func (o *SessionOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this session o k body based on context it is used

func (*SessionOKBody) MarshalBinary

func (o *SessionOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SessionOKBody) UnmarshalBinary

func (o *SessionOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SessionOKBody) Validate

func (o *SessionOKBody) Validate(formats strfmt.Registry) error

Validate validates this session o k body

type SessionParams

type SessionParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Session identification code
	  Required: true
	  In: path
	*/
	SessionID string
}

SessionParams contains all the bound params for the session operation typically these are obtained from a http.Request

swagger:parameters session

func NewSessionParams

func NewSessionParams() SessionParams

NewSessionParams creates a new SessionParams object

There are no default values defined in the spec.

func (*SessionParams) BindRequest

func (o *SessionParams) 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 NewSessionParams() beforehand.

type SessionURL

type SessionURL struct {
	SessionID string
	// contains filtered or unexported fields
}

SessionURL generates an URL for the session operation

func (*SessionURL) Build

func (o *SessionURL) Build() (*url.URL, error)

Build a url path and query string

func (*SessionURL) BuildFull

func (o *SessionURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*SessionURL) Must

func (o *SessionURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*SessionURL) SetBasePath

func (o *SessionURL) 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 (*SessionURL) String

func (o *SessionURL) String() string

String returns the string representation of the path with query string

func (*SessionURL) StringFull

func (o *SessionURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*SessionURL) WithBasePath

func (o *SessionURL) WithBasePath(bp string) *SessionURL

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 SessionUnauthorized

type SessionUnauthorized struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

SessionUnauthorized Unauthorized

swagger:response sessionUnauthorized

func NewSessionUnauthorized

func NewSessionUnauthorized() *SessionUnauthorized

NewSessionUnauthorized creates SessionUnauthorized with default headers values

func (*SessionUnauthorized) SetPayload

func (o *SessionUnauthorized) SetPayload(payload interface{})

SetPayload sets the payload to the session unauthorized response

func (*SessionUnauthorized) WithPayload

func (o *SessionUnauthorized) WithPayload(payload interface{}) *SessionUnauthorized

WithPayload adds the payload to the session unauthorized response

func (*SessionUnauthorized) WriteResponse

func (o *SessionUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL