users

package
v0.0.0-...-c407d37 Latest Latest
Warning

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

Go to latest
Published: Apr 12, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const GetUserBadRequestCode int = 400

GetUserBadRequestCode is the HTTP code returned for type GetUserBadRequest

View Source
const GetUserInternalServerErrorCode int = 500

GetUserInternalServerErrorCode is the HTTP code returned for type GetUserInternalServerError

View Source
const GetUserNotFoundCode int = 404

GetUserNotFoundCode is the HTTP code returned for type GetUserNotFound

View Source
const GetUserOKCode int = 200

GetUserOKCode is the HTTP code returned for type GetUserOK

View Source
const GetUserUnauthorizedCode int = 401

GetUserUnauthorizedCode is the HTTP code returned for type GetUserUnauthorized

View Source
const IndexUsersBadRequestCode int = 400

IndexUsersBadRequestCode is the HTTP code returned for type IndexUsersBadRequest

View Source
const IndexUsersInternalServerErrorCode int = 500

IndexUsersInternalServerErrorCode is the HTTP code returned for type IndexUsersInternalServerError

View Source
const IndexUsersNotFoundCode int = 404

IndexUsersNotFoundCode is the HTTP code returned for type IndexUsersNotFound

View Source
const IndexUsersOKCode int = 200

IndexUsersOKCode is the HTTP code returned for type IndexUsersOK

View Source
const IndexUsersUnauthorizedCode int = 401

IndexUsersUnauthorizedCode is the HTTP code returned for type IndexUsersUnauthorized

View Source
const UpdateUserBadRequestCode int = 400

UpdateUserBadRequestCode is the HTTP code returned for type UpdateUserBadRequest

View Source
const UpdateUserForbiddenCode int = 403

UpdateUserForbiddenCode is the HTTP code returned for type UpdateUserForbidden

View Source
const UpdateUserInternalServerErrorCode int = 500

UpdateUserInternalServerErrorCode is the HTTP code returned for type UpdateUserInternalServerError

View Source
const UpdateUserNotFoundCode int = 404

UpdateUserNotFoundCode is the HTTP code returned for type UpdateUserNotFound

View Source
const UpdateUserOKCode int = 200

UpdateUserOKCode is the HTTP code returned for type UpdateUserOK

View Source
const UpdateUserUnauthorizedCode int = 401

UpdateUserUnauthorizedCode is the HTTP code returned for type UpdateUserUnauthorized

View Source
const UpdateUserUnprocessableEntityCode int = 422

UpdateUserUnprocessableEntityCode is the HTTP code returned for type UpdateUserUnprocessableEntity

Variables

This section is empty.

Functions

This section is empty.

Types

type GetUser

type GetUser struct {
	Context *middleware.Context
	Handler GetUserHandler
}
GetUser swagger:route GET /users/{userId} Users getUser

Get information about a User

This endpoint returns a single User by ID. This also returns the User's sessions as well. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

func NewGetUser

func NewGetUser(ctx *middleware.Context, handler GetUserHandler) *GetUser

NewGetUser creates a new http.Handler for the get user operation

func (*GetUser) ServeHTTP

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

type GetUserBadRequest

type GetUserBadRequest struct {
}

GetUserBadRequest invalid request

swagger:response getUserBadRequest

func NewGetUserBadRequest

func NewGetUserBadRequest() *GetUserBadRequest

NewGetUserBadRequest creates GetUserBadRequest with default headers values

func (*GetUserBadRequest) WriteResponse

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

WriteResponse to the client

type GetUserHandler

type GetUserHandler interface {
	Handle(GetUserParams) middleware.Responder
}

GetUserHandler interface for that can handle valid get user params

type GetUserHandlerFunc

type GetUserHandlerFunc func(GetUserParams) middleware.Responder

GetUserHandlerFunc turns a function with the right signature into a get user handler

func (GetUserHandlerFunc) Handle

Handle executing the request and returning a response

type GetUserInternalServerError

type GetUserInternalServerError struct {
}

GetUserInternalServerError server error

swagger:response getUserInternalServerError

func NewGetUserInternalServerError

func NewGetUserInternalServerError() *GetUserInternalServerError

NewGetUserInternalServerError creates GetUserInternalServerError with default headers values

func (*GetUserInternalServerError) WriteResponse

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

WriteResponse to the client

type GetUserNotFound

type GetUserNotFound struct {
}

GetUserNotFound User not found

swagger:response getUserNotFound

func NewGetUserNotFound

func NewGetUserNotFound() *GetUserNotFound

NewGetUserNotFound creates GetUserNotFound with default headers values

func (*GetUserNotFound) WriteResponse

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

WriteResponse to the client

type GetUserOK

type GetUserOK struct {

	/*
	  In: Body
	*/
	Payload *adminmessages.User `json:"body,omitempty"`
}

GetUserOK success

swagger:response getUserOK

func NewGetUserOK

func NewGetUserOK() *GetUserOK

NewGetUserOK creates GetUserOK with default headers values

func (*GetUserOK) SetPayload

func (o *GetUserOK) SetPayload(payload *adminmessages.User)

SetPayload sets the payload to the get user o k response

func (*GetUserOK) WithPayload

func (o *GetUserOK) WithPayload(payload *adminmessages.User) *GetUserOK

WithPayload adds the payload to the get user o k response

func (*GetUserOK) WriteResponse

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

WriteResponse to the client

type GetUserParams

type GetUserParams struct {

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

	/*
	  Required: true
	  In: path
	*/
	UserID strfmt.UUID
}

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

swagger:parameters getUser

func NewGetUserParams

func NewGetUserParams() GetUserParams

NewGetUserParams creates a new GetUserParams object

There are no default values defined in the spec.

func (*GetUserParams) BindRequest

func (o *GetUserParams) 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 NewGetUserParams() beforehand.

type GetUserURL

type GetUserURL struct {
	UserID strfmt.UUID
	// contains filtered or unexported fields
}

GetUserURL generates an URL for the get user operation

func (*GetUserURL) Build

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

Build a url path and query string

func (*GetUserURL) BuildFull

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

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

func (*GetUserURL) Must

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

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

func (*GetUserURL) SetBasePath

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

func (o *GetUserURL) String() string

String returns the string representation of the path with query string

func (*GetUserURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetUserURL) WithBasePath

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

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 GetUserUnauthorized

type GetUserUnauthorized struct {
}

GetUserUnauthorized request requires user authentication

swagger:response getUserUnauthorized

func NewGetUserUnauthorized

func NewGetUserUnauthorized() *GetUserUnauthorized

NewGetUserUnauthorized creates GetUserUnauthorized with default headers values

func (*GetUserUnauthorized) WriteResponse

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

WriteResponse to the client

type IndexUsers

type IndexUsers struct {
	Context *middleware.Context
	Handler IndexUsersHandler
}
IndexUsers swagger:route GET /users Users indexUsers

List Users

This endpoint returns a list of Users. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

func NewIndexUsers

func NewIndexUsers(ctx *middleware.Context, handler IndexUsersHandler) *IndexUsers

NewIndexUsers creates a new http.Handler for the index users operation

func (*IndexUsers) ServeHTTP

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

type IndexUsersBadRequest

type IndexUsersBadRequest struct {
}

IndexUsersBadRequest invalid request

swagger:response indexUsersBadRequest

func NewIndexUsersBadRequest

func NewIndexUsersBadRequest() *IndexUsersBadRequest

NewIndexUsersBadRequest creates IndexUsersBadRequest with default headers values

func (*IndexUsersBadRequest) WriteResponse

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

WriteResponse to the client

type IndexUsersHandler

type IndexUsersHandler interface {
	Handle(IndexUsersParams) middleware.Responder
}

IndexUsersHandler interface for that can handle valid index users params

type IndexUsersHandlerFunc

type IndexUsersHandlerFunc func(IndexUsersParams) middleware.Responder

IndexUsersHandlerFunc turns a function with the right signature into a index users handler

func (IndexUsersHandlerFunc) Handle

Handle executing the request and returning a response

type IndexUsersInternalServerError

type IndexUsersInternalServerError struct {
}

IndexUsersInternalServerError server error

swagger:response indexUsersInternalServerError

func NewIndexUsersInternalServerError

func NewIndexUsersInternalServerError() *IndexUsersInternalServerError

NewIndexUsersInternalServerError creates IndexUsersInternalServerError with default headers values

func (*IndexUsersInternalServerError) WriteResponse

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

WriteResponse to the client

type IndexUsersNotFound

type IndexUsersNotFound struct {
}

IndexUsersNotFound Users not found

swagger:response indexUsersNotFound

func NewIndexUsersNotFound

func NewIndexUsersNotFound() *IndexUsersNotFound

NewIndexUsersNotFound creates IndexUsersNotFound with default headers values

func (*IndexUsersNotFound) WriteResponse

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

WriteResponse to the client

type IndexUsersOK

type IndexUsersOK struct {
	/*Used for pagination

	 */
	ContentRange string `json:"Content-Range"`

	/*
	  In: Body
	*/
	Payload adminmessages.Users `json:"body,omitempty"`
}

IndexUsersOK success

swagger:response indexUsersOK

func NewIndexUsersOK

func NewIndexUsersOK() *IndexUsersOK

NewIndexUsersOK creates IndexUsersOK with default headers values

func (*IndexUsersOK) SetContentRange

func (o *IndexUsersOK) SetContentRange(contentRange string)

SetContentRange sets the contentRange to the index users o k response

func (*IndexUsersOK) SetPayload

func (o *IndexUsersOK) SetPayload(payload adminmessages.Users)

SetPayload sets the payload to the index users o k response

func (*IndexUsersOK) WithContentRange

func (o *IndexUsersOK) WithContentRange(contentRange string) *IndexUsersOK

WithContentRange adds the contentRange to the index users o k response

func (*IndexUsersOK) WithPayload

func (o *IndexUsersOK) WithPayload(payload adminmessages.Users) *IndexUsersOK

WithPayload adds the payload to the index users o k response

func (*IndexUsersOK) WriteResponse

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

WriteResponse to the client

type IndexUsersParams

type IndexUsersParams struct {

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

	/*
	  In: query
	*/
	Filter *string
	/*
	  In: query
	*/
	Order *bool
	/*
	  In: query
	*/
	Page *int64
	/*
	  In: query
	*/
	PerPage *int64
	/*
	  In: query
	*/
	Sort *string
}

IndexUsersParams contains all the bound params for the index users operation typically these are obtained from a http.Request

swagger:parameters indexUsers

func NewIndexUsersParams

func NewIndexUsersParams() IndexUsersParams

NewIndexUsersParams creates a new IndexUsersParams object

There are no default values defined in the spec.

func (*IndexUsersParams) BindRequest

func (o *IndexUsersParams) 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 NewIndexUsersParams() beforehand.

type IndexUsersURL

type IndexUsersURL struct {
	Filter  *string
	Order   *bool
	Page    *int64
	PerPage *int64
	Sort    *string
	// contains filtered or unexported fields
}

IndexUsersURL generates an URL for the index users operation

func (*IndexUsersURL) Build

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

Build a url path and query string

func (*IndexUsersURL) BuildFull

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

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

func (*IndexUsersURL) Must

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

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

func (*IndexUsersURL) SetBasePath

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

func (o *IndexUsersURL) String() string

String returns the string representation of the path with query string

func (*IndexUsersURL) StringFull

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

StringFull returns the string representation of a complete url

func (*IndexUsersURL) WithBasePath

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

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 IndexUsersUnauthorized

type IndexUsersUnauthorized struct {
}

IndexUsersUnauthorized request requires user authentication

swagger:response indexUsersUnauthorized

func NewIndexUsersUnauthorized

func NewIndexUsersUnauthorized() *IndexUsersUnauthorized

NewIndexUsersUnauthorized creates IndexUsersUnauthorized with default headers values

func (*IndexUsersUnauthorized) WriteResponse

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

WriteResponse to the client

type UpdateUser

type UpdateUser struct {
	Context *middleware.Context
	Handler UpdateUserHandler
}
UpdateUser swagger:route PATCH /users/{userId} Users updateUser

Update a User's session or active status

This endpoint updates a single User by ID. This can be used by the Admin User to update the User's session or the User's active status. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.

func NewUpdateUser

func NewUpdateUser(ctx *middleware.Context, handler UpdateUserHandler) *UpdateUser

NewUpdateUser creates a new http.Handler for the update user operation

func (*UpdateUser) ServeHTTP

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

type UpdateUserBadRequest

type UpdateUserBadRequest struct {
}

UpdateUserBadRequest Invalid Request

swagger:response updateUserBadRequest

func NewUpdateUserBadRequest

func NewUpdateUserBadRequest() *UpdateUserBadRequest

NewUpdateUserBadRequest creates UpdateUserBadRequest with default headers values

func (*UpdateUserBadRequest) WriteResponse

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

WriteResponse to the client

type UpdateUserForbidden

type UpdateUserForbidden struct {
}

UpdateUserForbidden Not authorized to update this User

swagger:response updateUserForbidden

func NewUpdateUserForbidden

func NewUpdateUserForbidden() *UpdateUserForbidden

NewUpdateUserForbidden creates UpdateUserForbidden with default headers values

func (*UpdateUserForbidden) WriteResponse

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

WriteResponse to the client

type UpdateUserHandler

type UpdateUserHandler interface {
	Handle(UpdateUserParams) middleware.Responder
}

UpdateUserHandler interface for that can handle valid update user params

type UpdateUserHandlerFunc

type UpdateUserHandlerFunc func(UpdateUserParams) middleware.Responder

UpdateUserHandlerFunc turns a function with the right signature into a update user handler

func (UpdateUserHandlerFunc) Handle

Handle executing the request and returning a response

type UpdateUserInternalServerError

type UpdateUserInternalServerError struct {
}

UpdateUserInternalServerError Server error

swagger:response updateUserInternalServerError

func NewUpdateUserInternalServerError

func NewUpdateUserInternalServerError() *UpdateUserInternalServerError

NewUpdateUserInternalServerError creates UpdateUserInternalServerError with default headers values

func (*UpdateUserInternalServerError) WriteResponse

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

WriteResponse to the client

type UpdateUserNotFound

type UpdateUserNotFound struct {
}

UpdateUserNotFound Not found

swagger:response updateUserNotFound

func NewUpdateUserNotFound

func NewUpdateUserNotFound() *UpdateUserNotFound

NewUpdateUserNotFound creates UpdateUserNotFound with default headers values

func (*UpdateUserNotFound) WriteResponse

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

WriteResponse to the client

type UpdateUserOK

type UpdateUserOK struct {

	/*
	  In: Body
	*/
	Payload *adminmessages.User `json:"body,omitempty"`
}

UpdateUserOK Successfully updated User

swagger:response updateUserOK

func NewUpdateUserOK

func NewUpdateUserOK() *UpdateUserOK

NewUpdateUserOK creates UpdateUserOK with default headers values

func (*UpdateUserOK) SetPayload

func (o *UpdateUserOK) SetPayload(payload *adminmessages.User)

SetPayload sets the payload to the update user o k response

func (*UpdateUserOK) WithPayload

func (o *UpdateUserOK) WithPayload(payload *adminmessages.User) *UpdateUserOK

WithPayload adds the payload to the update user o k response

func (*UpdateUserOK) WriteResponse

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

WriteResponse to the client

type UpdateUserParams

type UpdateUserParams struct {

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

	/*User information
	  Required: true
	  In: body
	*/
	User *adminmessages.UserUpdate
	/*
	  Required: true
	  In: path
	*/
	UserID strfmt.UUID
}

UpdateUserParams contains all the bound params for the update user operation typically these are obtained from a http.Request

swagger:parameters updateUser

func NewUpdateUserParams

func NewUpdateUserParams() UpdateUserParams

NewUpdateUserParams creates a new UpdateUserParams object

There are no default values defined in the spec.

func (*UpdateUserParams) BindRequest

func (o *UpdateUserParams) 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 NewUpdateUserParams() beforehand.

type UpdateUserURL

type UpdateUserURL struct {
	UserID strfmt.UUID
	// contains filtered or unexported fields
}

UpdateUserURL generates an URL for the update user operation

func (*UpdateUserURL) Build

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

Build a url path and query string

func (*UpdateUserURL) BuildFull

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

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

func (*UpdateUserURL) Must

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

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

func (*UpdateUserURL) SetBasePath

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

func (o *UpdateUserURL) String() string

String returns the string representation of the path with query string

func (*UpdateUserURL) StringFull

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

StringFull returns the string representation of a complete url

func (*UpdateUserURL) WithBasePath

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

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 UpdateUserUnauthorized

type UpdateUserUnauthorized struct {
}

UpdateUserUnauthorized Must be authenticated to use this end point

swagger:response updateUserUnauthorized

func NewUpdateUserUnauthorized

func NewUpdateUserUnauthorized() *UpdateUserUnauthorized

NewUpdateUserUnauthorized creates UpdateUserUnauthorized with default headers values

func (*UpdateUserUnauthorized) WriteResponse

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

WriteResponse to the client

type UpdateUserUnprocessableEntity

type UpdateUserUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *adminmessages.ValidationError `json:"body,omitempty"`
}

UpdateUserUnprocessableEntity Validation error

swagger:response updateUserUnprocessableEntity

func NewUpdateUserUnprocessableEntity

func NewUpdateUserUnprocessableEntity() *UpdateUserUnprocessableEntity

NewUpdateUserUnprocessableEntity creates UpdateUserUnprocessableEntity with default headers values

func (*UpdateUserUnprocessableEntity) SetPayload

SetPayload sets the payload to the update user unprocessable entity response

func (*UpdateUserUnprocessableEntity) WithPayload

WithPayload adds the payload to the update user unprocessable entity response

func (*UpdateUserUnprocessableEntity) WriteResponse

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