api_session

package
v0.21.251 Latest Latest
Warning

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

Go to latest
Published: Jun 9, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const DeleteAPISessionsForbiddenCode int = 403

DeleteAPISessionsForbiddenCode is the HTTP code returned for type DeleteAPISessionsForbidden

View Source
const DeleteAPISessionsNotFoundCode int = 404

DeleteAPISessionsNotFoundCode is the HTTP code returned for type DeleteAPISessionsNotFound

View Source
const DeleteAPISessionsOKCode int = 200

DeleteAPISessionsOKCode is the HTTP code returned for type DeleteAPISessionsOK

View Source
const DetailAPISessionsNotFoundCode int = 404

DetailAPISessionsNotFoundCode is the HTTP code returned for type DetailAPISessionsNotFound

View Source
const DetailAPISessionsOKCode int = 200

DetailAPISessionsOKCode is the HTTP code returned for type DetailAPISessionsOK

View Source
const DetailAPISessionsUnauthorizedCode int = 401

DetailAPISessionsUnauthorizedCode is the HTTP code returned for type DetailAPISessionsUnauthorized

View Source
const ListAPISessionsBadRequestCode int = 400

ListAPISessionsBadRequestCode is the HTTP code returned for type ListAPISessionsBadRequest

View Source
const ListAPISessionsOKCode int = 200

ListAPISessionsOKCode is the HTTP code returned for type ListAPISessionsOK

View Source
const ListAPISessionsUnauthorizedCode int = 401

ListAPISessionsUnauthorizedCode is the HTTP code returned for type ListAPISessionsUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type DeleteAPISessions

type DeleteAPISessions struct {
	Context *middleware.Context
	Handler DeleteAPISessionsHandler
}
DeleteAPISessions swagger:route DELETE /api-sessions/{id} API Session deleteApiSessions

Deletes an API Sessions

Deletes and API sesion by id. Requires admin access.

func NewDeleteAPISessions

func NewDeleteAPISessions(ctx *middleware.Context, handler DeleteAPISessionsHandler) *DeleteAPISessions

NewDeleteAPISessions creates a new http.Handler for the delete API sessions operation

func (*DeleteAPISessions) ServeHTTP

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

type DeleteAPISessionsForbidden

type DeleteAPISessionsForbidden struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DeleteAPISessionsForbidden The currently supplied session does not have the correct access rights to request this resource

swagger:response deleteApiSessionsForbidden

func NewDeleteAPISessionsForbidden

func NewDeleteAPISessionsForbidden() *DeleteAPISessionsForbidden

NewDeleteAPISessionsForbidden creates DeleteAPISessionsForbidden with default headers values

func (*DeleteAPISessionsForbidden) SetPayload

func (o *DeleteAPISessionsForbidden) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the delete Api sessions forbidden response

func (*DeleteAPISessionsForbidden) WithPayload

WithPayload adds the payload to the delete Api sessions forbidden response

func (*DeleteAPISessionsForbidden) WriteResponse

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

WriteResponse to the client

type DeleteAPISessionsHandler

type DeleteAPISessionsHandler interface {
	Handle(DeleteAPISessionsParams, interface{}) middleware.Responder
}

DeleteAPISessionsHandler interface for that can handle valid delete API sessions params

type DeleteAPISessionsHandlerFunc

type DeleteAPISessionsHandlerFunc func(DeleteAPISessionsParams, interface{}) middleware.Responder

DeleteAPISessionsHandlerFunc turns a function with the right signature into a delete API sessions handler

func (DeleteAPISessionsHandlerFunc) Handle

func (fn DeleteAPISessionsHandlerFunc) Handle(params DeleteAPISessionsParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type DeleteAPISessionsNotFound

type DeleteAPISessionsNotFound struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DeleteAPISessionsNotFound The requested resource does not exist

swagger:response deleteApiSessionsNotFound

func NewDeleteAPISessionsNotFound

func NewDeleteAPISessionsNotFound() *DeleteAPISessionsNotFound

NewDeleteAPISessionsNotFound creates DeleteAPISessionsNotFound with default headers values

func (*DeleteAPISessionsNotFound) SetPayload

func (o *DeleteAPISessionsNotFound) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the delete Api sessions not found response

func (*DeleteAPISessionsNotFound) WithPayload

WithPayload adds the payload to the delete Api sessions not found response

func (*DeleteAPISessionsNotFound) WriteResponse

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

WriteResponse to the client

type DeleteAPISessionsOK

type DeleteAPISessionsOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.Empty `json:"body,omitempty"`
}

DeleteAPISessionsOK The delete request was successful and the resource has been removed

swagger:response deleteApiSessionsOK

func NewDeleteAPISessionsOK

func NewDeleteAPISessionsOK() *DeleteAPISessionsOK

NewDeleteAPISessionsOK creates DeleteAPISessionsOK with default headers values

func (*DeleteAPISessionsOK) SetPayload

func (o *DeleteAPISessionsOK) SetPayload(payload *rest_model.Empty)

SetPayload sets the payload to the delete Api sessions o k response

func (*DeleteAPISessionsOK) WithPayload

func (o *DeleteAPISessionsOK) WithPayload(payload *rest_model.Empty) *DeleteAPISessionsOK

WithPayload adds the payload to the delete Api sessions o k response

func (*DeleteAPISessionsOK) WriteResponse

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

WriteResponse to the client

type DeleteAPISessionsParams

type DeleteAPISessionsParams struct {

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

	/*The id of the requested resource
	  Required: true
	  In: path
	*/
	ID string
}

DeleteAPISessionsParams contains all the bound params for the delete API sessions operation typically these are obtained from a http.Request

swagger:parameters deleteAPISessions

func NewDeleteAPISessionsParams

func NewDeleteAPISessionsParams() DeleteAPISessionsParams

NewDeleteAPISessionsParams creates a new DeleteAPISessionsParams object

There are no default values defined in the spec.

func (*DeleteAPISessionsParams) BindRequest

func (o *DeleteAPISessionsParams) 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 NewDeleteAPISessionsParams() beforehand.

type DeleteAPISessionsURL

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

DeleteAPISessionsURL generates an URL for the delete API sessions operation

func (*DeleteAPISessionsURL) Build

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

Build a url path and query string

func (*DeleteAPISessionsURL) BuildFull

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

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

func (*DeleteAPISessionsURL) Must

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

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

func (*DeleteAPISessionsURL) SetBasePath

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

func (o *DeleteAPISessionsURL) String() string

String returns the string representation of the path with query string

func (*DeleteAPISessionsURL) StringFull

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

StringFull returns the string representation of a complete url

func (*DeleteAPISessionsURL) WithBasePath

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

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 DetailAPISessions

type DetailAPISessions struct {
	Context *middleware.Context
	Handler DetailAPISessionsHandler
}
DetailAPISessions swagger:route GET /api-sessions/{id} API Session detailApiSessions

Retrieves a single API Session

Retrieves a single API Session by id. Requires admin access.

func NewDetailAPISessions

func NewDetailAPISessions(ctx *middleware.Context, handler DetailAPISessionsHandler) *DetailAPISessions

NewDetailAPISessions creates a new http.Handler for the detail API sessions operation

func (*DetailAPISessions) ServeHTTP

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

type DetailAPISessionsHandler

type DetailAPISessionsHandler interface {
	Handle(DetailAPISessionsParams, interface{}) middleware.Responder
}

DetailAPISessionsHandler interface for that can handle valid detail API sessions params

type DetailAPISessionsHandlerFunc

type DetailAPISessionsHandlerFunc func(DetailAPISessionsParams, interface{}) middleware.Responder

DetailAPISessionsHandlerFunc turns a function with the right signature into a detail API sessions handler

func (DetailAPISessionsHandlerFunc) Handle

func (fn DetailAPISessionsHandlerFunc) Handle(params DetailAPISessionsParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type DetailAPISessionsNotFound

type DetailAPISessionsNotFound struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DetailAPISessionsNotFound The requested resource does not exist

swagger:response detailApiSessionsNotFound

func NewDetailAPISessionsNotFound

func NewDetailAPISessionsNotFound() *DetailAPISessionsNotFound

NewDetailAPISessionsNotFound creates DetailAPISessionsNotFound with default headers values

func (*DetailAPISessionsNotFound) SetPayload

func (o *DetailAPISessionsNotFound) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the detail Api sessions not found response

func (*DetailAPISessionsNotFound) WithPayload

WithPayload adds the payload to the detail Api sessions not found response

func (*DetailAPISessionsNotFound) WriteResponse

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

WriteResponse to the client

type DetailAPISessionsOK

type DetailAPISessionsOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.DetailAPISessionEnvelope `json:"body,omitempty"`
}

DetailAPISessionsOK Retrieves a singular API Session by id

swagger:response detailApiSessionsOK

func NewDetailAPISessionsOK

func NewDetailAPISessionsOK() *DetailAPISessionsOK

NewDetailAPISessionsOK creates DetailAPISessionsOK with default headers values

func (*DetailAPISessionsOK) SetPayload

SetPayload sets the payload to the detail Api sessions o k response

func (*DetailAPISessionsOK) WithPayload

WithPayload adds the payload to the detail Api sessions o k response

func (*DetailAPISessionsOK) WriteResponse

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

WriteResponse to the client

type DetailAPISessionsParams

type DetailAPISessionsParams struct {

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

	/*The id of the requested resource
	  Required: true
	  In: path
	*/
	ID string
}

DetailAPISessionsParams contains all the bound params for the detail API sessions operation typically these are obtained from a http.Request

swagger:parameters detailAPISessions

func NewDetailAPISessionsParams

func NewDetailAPISessionsParams() DetailAPISessionsParams

NewDetailAPISessionsParams creates a new DetailAPISessionsParams object

There are no default values defined in the spec.

func (*DetailAPISessionsParams) BindRequest

func (o *DetailAPISessionsParams) 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 NewDetailAPISessionsParams() beforehand.

type DetailAPISessionsURL

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

DetailAPISessionsURL generates an URL for the detail API sessions operation

func (*DetailAPISessionsURL) Build

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

Build a url path and query string

func (*DetailAPISessionsURL) BuildFull

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

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

func (*DetailAPISessionsURL) Must

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

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

func (*DetailAPISessionsURL) SetBasePath

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

func (o *DetailAPISessionsURL) String() string

String returns the string representation of the path with query string

func (*DetailAPISessionsURL) StringFull

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

StringFull returns the string representation of a complete url

func (*DetailAPISessionsURL) WithBasePath

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

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 DetailAPISessionsUnauthorized

type DetailAPISessionsUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DetailAPISessionsUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response detailApiSessionsUnauthorized

func NewDetailAPISessionsUnauthorized

func NewDetailAPISessionsUnauthorized() *DetailAPISessionsUnauthorized

NewDetailAPISessionsUnauthorized creates DetailAPISessionsUnauthorized with default headers values

func (*DetailAPISessionsUnauthorized) SetPayload

SetPayload sets the payload to the detail Api sessions unauthorized response

func (*DetailAPISessionsUnauthorized) WithPayload

WithPayload adds the payload to the detail Api sessions unauthorized response

func (*DetailAPISessionsUnauthorized) WriteResponse

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

WriteResponse to the client

type ListAPISessions

type ListAPISessions struct {
	Context *middleware.Context
	Handler ListAPISessionsHandler
}
ListAPISessions swagger:route GET /api-sessions API Session listApiSessions

List active API sessions

Returns a list of active API sessions. The resources can be sorted, filtered, and paginated. This endpoint requries admin access.

func NewListAPISessions

func NewListAPISessions(ctx *middleware.Context, handler ListAPISessionsHandler) *ListAPISessions

NewListAPISessions creates a new http.Handler for the list API sessions operation

func (*ListAPISessions) ServeHTTP

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

type ListAPISessionsBadRequest added in v0.19.176

type ListAPISessionsBadRequest struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

ListAPISessionsBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

swagger:response listApiSessionsBadRequest

func NewListAPISessionsBadRequest added in v0.19.176

func NewListAPISessionsBadRequest() *ListAPISessionsBadRequest

NewListAPISessionsBadRequest creates ListAPISessionsBadRequest with default headers values

func (*ListAPISessionsBadRequest) SetPayload added in v0.19.176

func (o *ListAPISessionsBadRequest) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the list Api sessions bad request response

func (*ListAPISessionsBadRequest) WithPayload added in v0.19.176

WithPayload adds the payload to the list Api sessions bad request response

func (*ListAPISessionsBadRequest) WriteResponse added in v0.19.176

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

WriteResponse to the client

type ListAPISessionsHandler

type ListAPISessionsHandler interface {
	Handle(ListAPISessionsParams, interface{}) middleware.Responder
}

ListAPISessionsHandler interface for that can handle valid list API sessions params

type ListAPISessionsHandlerFunc

type ListAPISessionsHandlerFunc func(ListAPISessionsParams, interface{}) middleware.Responder

ListAPISessionsHandlerFunc turns a function with the right signature into a list API sessions handler

func (ListAPISessionsHandlerFunc) Handle

func (fn ListAPISessionsHandlerFunc) Handle(params ListAPISessionsParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type ListAPISessionsOK

type ListAPISessionsOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.ListAPISessionsEnvelope `json:"body,omitempty"`
}

ListAPISessionsOK A list of active API Sessions

swagger:response listApiSessionsOK

func NewListAPISessionsOK

func NewListAPISessionsOK() *ListAPISessionsOK

NewListAPISessionsOK creates ListAPISessionsOK with default headers values

func (*ListAPISessionsOK) SetPayload

func (o *ListAPISessionsOK) SetPayload(payload *rest_model.ListAPISessionsEnvelope)

SetPayload sets the payload to the list Api sessions o k response

func (*ListAPISessionsOK) WithPayload

WithPayload adds the payload to the list Api sessions o k response

func (*ListAPISessionsOK) WriteResponse

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

WriteResponse to the client

type ListAPISessionsParams

type ListAPISessionsParams struct {

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

	/*
	  In: query
	*/
	Filter *string
	/*
	  In: query
	*/
	Limit *int64
	/*
	  In: query
	*/
	Offset *int64
}

ListAPISessionsParams contains all the bound params for the list API sessions operation typically these are obtained from a http.Request

swagger:parameters listAPISessions

func NewListAPISessionsParams

func NewListAPISessionsParams() ListAPISessionsParams

NewListAPISessionsParams creates a new ListAPISessionsParams object

There are no default values defined in the spec.

func (*ListAPISessionsParams) BindRequest

func (o *ListAPISessionsParams) 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 NewListAPISessionsParams() beforehand.

type ListAPISessionsURL

type ListAPISessionsURL struct {
	Filter *string
	Limit  *int64
	Offset *int64
	// contains filtered or unexported fields
}

ListAPISessionsURL generates an URL for the list API sessions operation

func (*ListAPISessionsURL) Build

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

Build a url path and query string

func (*ListAPISessionsURL) BuildFull

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

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

func (*ListAPISessionsURL) Must

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

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

func (*ListAPISessionsURL) SetBasePath

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

func (o *ListAPISessionsURL) String() string

String returns the string representation of the path with query string

func (*ListAPISessionsURL) StringFull

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

StringFull returns the string representation of a complete url

func (*ListAPISessionsURL) WithBasePath

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

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 ListAPISessionsUnauthorized added in v0.19.173

type ListAPISessionsUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

ListAPISessionsUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response listApiSessionsUnauthorized

func NewListAPISessionsUnauthorized added in v0.19.173

func NewListAPISessionsUnauthorized() *ListAPISessionsUnauthorized

NewListAPISessionsUnauthorized creates ListAPISessionsUnauthorized with default headers values

func (*ListAPISessionsUnauthorized) SetPayload added in v0.19.173

SetPayload sets the payload to the list Api sessions unauthorized response

func (*ListAPISessionsUnauthorized) WithPayload added in v0.19.173

WithPayload adds the payload to the list Api sessions unauthorized response

func (*ListAPISessionsUnauthorized) WriteResponse added in v0.19.173

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