key

package
v0.0.0-...-27ac458 Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2024 License: GPL-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const AddKeyBadRequestCode int = 400

AddKeyBadRequestCode is the HTTP code returned for type AddKeyBadRequest

View Source
const AddKeyOKCode int = 200

AddKeyOKCode is the HTTP code returned for type AddKeyOK

View Source
const AddKeyUnauthorizedCode int = 401

AddKeyUnauthorizedCode is the HTTP code returned for type AddKeyUnauthorized

View Source
const DeleteKeyBadRequestCode int = 400

DeleteKeyBadRequestCode is the HTTP code returned for type DeleteKeyBadRequest

View Source
const DeleteKeyOKCode int = 200

DeleteKeyOKCode is the HTTP code returned for type DeleteKeyOK

View Source
const GetKeysBadRequestCode int = 400

GetKeysBadRequestCode is the HTTP code returned for type GetKeysBadRequest

View Source
const GetKeysOKCode int = 200

GetKeysOKCode is the HTTP code returned for type GetKeysOK

Variables

This section is empty.

Functions

This section is empty.

Types

type AddKey

type AddKey struct {
	Context *middleware.Context
	Handler AddKeyHandler
}
AddKey swagger:route POST /key key addKey

Add a new API key

func NewAddKey

func NewAddKey(ctx *middleware.Context, handler AddKeyHandler) *AddKey

NewAddKey creates a new http.Handler for the add key operation

func (*AddKey) ServeHTTP

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

type AddKeyBadRequest

type AddKeyBadRequest struct {
}

AddKeyBadRequest Invalid input

swagger:response addKeyBadRequest

func NewAddKeyBadRequest

func NewAddKeyBadRequest() *AddKeyBadRequest

NewAddKeyBadRequest creates AddKeyBadRequest with default headers values

func (*AddKeyBadRequest) WriteResponse

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

WriteResponse to the client

type AddKeyHandler

type AddKeyHandler interface {
	Handle(AddKeyParams, *models.AuthPrincipal) middleware.Responder
}

AddKeyHandler interface for that can handle valid add key params

type AddKeyHandlerFunc

type AddKeyHandlerFunc func(AddKeyParams, *models.AuthPrincipal) middleware.Responder

AddKeyHandlerFunc turns a function with the right signature into a add key handler

func (AddKeyHandlerFunc) Handle

Handle executing the request and returning a response

type AddKeyOK

type AddKeyOK struct {

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

AddKeyOK successful operation

swagger:response addKeyOK

func NewAddKeyOK

func NewAddKeyOK() *AddKeyOK

NewAddKeyOK creates AddKeyOK with default headers values

func (*AddKeyOK) SetPayload

func (o *AddKeyOK) SetPayload(payload *models.CreateKeyResult)

SetPayload sets the payload to the add key o k response

func (*AddKeyOK) WithPayload

func (o *AddKeyOK) WithPayload(payload *models.CreateKeyResult) *AddKeyOK

WithPayload adds the payload to the add key o k response

func (*AddKeyOK) WriteResponse

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

WriteResponse to the client

type AddKeyParams

type AddKeyParams struct {

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

	/*Key object that needs to be added to the store
	  In: body
	*/
	Body *models.CreateKeyBody
}

AddKeyParams contains all the bound params for the add key operation typically these are obtained from a http.Request

swagger:parameters addKey

func NewAddKeyParams

func NewAddKeyParams() AddKeyParams

NewAddKeyParams creates a new AddKeyParams object

There are no default values defined in the spec.

func (*AddKeyParams) BindRequest

func (o *AddKeyParams) 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 NewAddKeyParams() beforehand.

type AddKeyURL

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

AddKeyURL generates an URL for the add key operation

func (*AddKeyURL) Build

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

Build a url path and query string

func (*AddKeyURL) BuildFull

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

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

func (*AddKeyURL) Must

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

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

func (*AddKeyURL) SetBasePath

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

func (o *AddKeyURL) String() string

String returns the string representation of the path with query string

func (*AddKeyURL) StringFull

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

StringFull returns the string representation of a complete url

func (*AddKeyURL) WithBasePath

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

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 AddKeyUnauthorized

type AddKeyUnauthorized struct {
}

AddKeyUnauthorized Unauthenticated

swagger:response addKeyUnauthorized

func NewAddKeyUnauthorized

func NewAddKeyUnauthorized() *AddKeyUnauthorized

NewAddKeyUnauthorized creates AddKeyUnauthorized with default headers values

func (*AddKeyUnauthorized) WriteResponse

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

WriteResponse to the client

type DeleteKey

type DeleteKey struct {
	Context *middleware.Context
	Handler DeleteKeyHandler
}
DeleteKey swagger:route DELETE /key/{id} key deleteKey

Delete key by ID

func NewDeleteKey

func NewDeleteKey(ctx *middleware.Context, handler DeleteKeyHandler) *DeleteKey

NewDeleteKey creates a new http.Handler for the delete key operation

func (*DeleteKey) ServeHTTP

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

type DeleteKeyBadRequest

type DeleteKeyBadRequest struct {
}

DeleteKeyBadRequest Invalid request supplied

swagger:response deleteKeyBadRequest

func NewDeleteKeyBadRequest

func NewDeleteKeyBadRequest() *DeleteKeyBadRequest

NewDeleteKeyBadRequest creates DeleteKeyBadRequest with default headers values

func (*DeleteKeyBadRequest) WriteResponse

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

WriteResponse to the client

type DeleteKeyHandler

type DeleteKeyHandler interface {
	Handle(DeleteKeyParams, *models.AuthPrincipal) middleware.Responder
}

DeleteKeyHandler interface for that can handle valid delete key params

type DeleteKeyHandlerFunc

type DeleteKeyHandlerFunc func(DeleteKeyParams, *models.AuthPrincipal) middleware.Responder

DeleteKeyHandlerFunc turns a function with the right signature into a delete key handler

func (DeleteKeyHandlerFunc) Handle

Handle executing the request and returning a response

type DeleteKeyOK

type DeleteKeyOK struct {
}

DeleteKeyOK successful operation

swagger:response deleteKeyOK

func NewDeleteKeyOK

func NewDeleteKeyOK() *DeleteKeyOK

NewDeleteKeyOK creates DeleteKeyOK with default headers values

func (*DeleteKeyOK) WriteResponse

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

WriteResponse to the client

type DeleteKeyParams

type DeleteKeyParams struct {

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

	/*Key id
	  Required: true
	  In: path
	*/
	ID string
}

DeleteKeyParams contains all the bound params for the delete key operation typically these are obtained from a http.Request

swagger:parameters deleteKey

func NewDeleteKeyParams

func NewDeleteKeyParams() DeleteKeyParams

NewDeleteKeyParams creates a new DeleteKeyParams object

There are no default values defined in the spec.

func (*DeleteKeyParams) BindRequest

func (o *DeleteKeyParams) 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 NewDeleteKeyParams() beforehand.

type DeleteKeyURL

type DeleteKeyURL struct {
	ID string
	// contains filtered or unexported fields
}

DeleteKeyURL generates an URL for the delete key operation

func (*DeleteKeyURL) Build

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

Build a url path and query string

func (*DeleteKeyURL) BuildFull

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

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

func (*DeleteKeyURL) Must

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

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

func (*DeleteKeyURL) SetBasePath

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

func (o *DeleteKeyURL) String() string

String returns the string representation of the path with query string

func (*DeleteKeyURL) StringFull

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

StringFull returns the string representation of a complete url

func (*DeleteKeyURL) WithBasePath

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

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 GetKeys

type GetKeys struct {
	Context *middleware.Context
	Handler GetKeysHandler
}
GetKeys swagger:route GET /key key getKeys

Get filtered key list

func NewGetKeys

func NewGetKeys(ctx *middleware.Context, handler GetKeysHandler) *GetKeys

NewGetKeys creates a new http.Handler for the get keys operation

func (*GetKeys) ServeHTTP

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

type GetKeysBadRequest

type GetKeysBadRequest struct {
}

GetKeysBadRequest Invalid request supplied

swagger:response getKeysBadRequest

func NewGetKeysBadRequest

func NewGetKeysBadRequest() *GetKeysBadRequest

NewGetKeysBadRequest creates GetKeysBadRequest with default headers values

func (*GetKeysBadRequest) WriteResponse

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

WriteResponse to the client

type GetKeysHandler

type GetKeysHandler interface {
	Handle(GetKeysParams, *models.AuthPrincipal) middleware.Responder
}

GetKeysHandler interface for that can handle valid get keys params

type GetKeysHandlerFunc

type GetKeysHandlerFunc func(GetKeysParams, *models.AuthPrincipal) middleware.Responder

GetKeysHandlerFunc turns a function with the right signature into a get keys handler

func (GetKeysHandlerFunc) Handle

Handle executing the request and returning a response

type GetKeysOK

type GetKeysOK struct {

	/*
	  In: Body
	*/
	Payload []*models.GetKeysResult `json:"body,omitempty"`
}

GetKeysOK successful operation

swagger:response getKeysOK

func NewGetKeysOK

func NewGetKeysOK() *GetKeysOK

NewGetKeysOK creates GetKeysOK with default headers values

func (*GetKeysOK) SetPayload

func (o *GetKeysOK) SetPayload(payload []*models.GetKeysResult)

SetPayload sets the payload to the get keys o k response

func (*GetKeysOK) WithPayload

func (o *GetKeysOK) WithPayload(payload []*models.GetKeysResult) *GetKeysOK

WithPayload adds the payload to the get keys o k response

func (*GetKeysOK) WriteResponse

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

WriteResponse to the client

type GetKeysParams

type GetKeysParams struct {

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

	/*Cursor, last item ID
	  In: query
	*/
	After *string
	/*JSON object with filter values
	  Required: true
	  In: query
	*/
	Filter string
	/*Default limit value is 50
	  In: query
	*/
	Limit *float64
}

GetKeysParams contains all the bound params for the get keys operation typically these are obtained from a http.Request

swagger:parameters getKeys

func NewGetKeysParams

func NewGetKeysParams() GetKeysParams

NewGetKeysParams creates a new GetKeysParams object

There are no default values defined in the spec.

func (*GetKeysParams) BindRequest

func (o *GetKeysParams) 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 NewGetKeysParams() beforehand.

type GetKeysURL

type GetKeysURL struct {
	After  *string
	Filter string
	Limit  *float64
	// contains filtered or unexported fields
}

GetKeysURL generates an URL for the get keys operation

func (*GetKeysURL) Build

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

Build a url path and query string

func (*GetKeysURL) BuildFull

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

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

func (*GetKeysURL) Must

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

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

func (*GetKeysURL) SetBasePath

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

func (o *GetKeysURL) String() string

String returns the string representation of the path with query string

func (*GetKeysURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetKeysURL) WithBasePath

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

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

Jump to

Keyboard shortcuts

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