characters

package
v0.0.0-...-32392be Latest Latest
Warning

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

 Go to latest Published: Nov 15, 2019 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const GetCharacterNotFoundCode int = 404

GetCharacterNotFoundCode is the HTTP code returned for type GetCharacterNotFound

View Source 
const GetCharacterOKCode int = 200

GetCharacterOKCode is the HTTP code returned for type GetCharacterOK

View Source 
const GetCharactersNotAcceptableCode int = 406

GetCharactersNotAcceptableCode is the HTTP code returned for type GetCharactersNotAcceptable

View Source 
const GetCharactersNotFoundCode int = 404

GetCharactersNotFoundCode is the HTTP code returned for type GetCharactersNotFound

View Source 
const GetCharactersOKCode int = 200

GetCharactersOKCode is the HTTP code returned for type GetCharactersOK

Variables

This section is empty.

Functions

This section is empty.

Types

type GetCharacter 

type GetCharacter struct {
	Context *middleware.Context
	Handler GetCharacterHandler
}

GetCharacter swagger:route GET /characters/{characterId} Characters getCharacter

Return an existing character from Id

func NewGetCharacter 

func NewGetCharacter(ctx *middleware.Context, handler GetCharacterHandler) *GetCharacter

NewGetCharacter creates a new http.Handler for the get character operation

func (*GetCharacter) ServeHTTP 

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

type GetCharacterHandler 

type GetCharacterHandler interface {
	Handle(GetCharacterParams) middleware.Responder
}

GetCharacterHandler interface for that can handle valid get character params

type GetCharacterHandlerFunc 

type GetCharacterHandlerFunc func(GetCharacterParams) middleware.Responder

GetCharacterHandlerFunc turns a function with the right signature into a get character handler

func (GetCharacterHandlerFunc) Handle 

func (fn GetCharacterHandlerFunc) Handle(params GetCharacterParams) middleware.Responder

Handle executing the request and returning a response

type GetCharacterNotFound 

type GetCharacterNotFound struct {
}

GetCharacterNotFound Error, the specified character doesn't exists

swagger:response getCharacterNotFound

func NewGetCharacterNotFound 

func NewGetCharacterNotFound() *GetCharacterNotFound

NewGetCharacterNotFound creates GetCharacterNotFound with default headers values

func (*GetCharacterNotFound) WriteResponse 

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

WriteResponse to the client

type GetCharacterOK 

type GetCharacterOK struct {

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

GetCharacterOK Success

swagger:response getCharacterOK

func NewGetCharacterOK 

func NewGetCharacterOK() *GetCharacterOK

NewGetCharacterOK creates GetCharacterOK with default headers values

func (*GetCharacterOK) SetPayload 

func (o *GetCharacterOK) SetPayload(payload *models.Character)

SetPayload sets the payload to the get character o k response

func (*GetCharacterOK) WithPayload 

func (o *GetCharacterOK) WithPayload(payload *models.Character) *GetCharacterOK

WithPayload adds the payload to the get character o k response

func (*GetCharacterOK) WriteResponse 

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

WriteResponse to the client

type GetCharacterParams 

type GetCharacterParams struct {

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

	/*The character's Id used to retrieve the character
	  Required: true
	  In: path
	*/
	CharacterID string
}

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

swagger:parameters getCharacter

func NewGetCharacterParams 

func NewGetCharacterParams() GetCharacterParams

NewGetCharacterParams creates a new GetCharacterParams object no default values defined in spec.

func (*GetCharacterParams) BindRequest 

func (o *GetCharacterParams) 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 NewGetCharacterParams() beforehand.

type GetCharacterURL 

type GetCharacterURL struct {
	CharacterID string
	// contains filtered or unexported fields
}

GetCharacterURL generates an URL for the get character operation

func (*GetCharacterURL) Build 

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

Build a url path and query string

func (*GetCharacterURL) BuildFull 

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

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

func (*GetCharacterURL) Must 

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

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

func (*GetCharacterURL) SetBasePath 

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

func (o *GetCharacterURL) String() string

String returns the string representation of the path with query string

func (*GetCharacterURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetCharacterURL) WithBasePath 

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

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 GetCharacters 

type GetCharacters struct {
	Context *middleware.Context
	Handler GetCharactersHandler
}

GetCharacters swagger:route GET /characters Characters getCharacters

Return all characters

func NewGetCharacters 

func NewGetCharacters(ctx *middleware.Context, handler GetCharactersHandler) *GetCharacters

NewGetCharacters creates a new http.Handler for the get characters operation

func (*GetCharacters) ServeHTTP 

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

type GetCharactersHandler 

type GetCharactersHandler interface {
	Handle(GetCharactersParams) middleware.Responder
}

GetCharactersHandler interface for that can handle valid get characters params

type GetCharactersHandlerFunc 

type GetCharactersHandlerFunc func(GetCharactersParams) middleware.Responder

GetCharactersHandlerFunc turns a function with the right signature into a get characters handler

func (GetCharactersHandlerFunc) Handle 

func (fn GetCharactersHandlerFunc) Handle(params GetCharactersParams) middleware.Responder

Handle executing the request and returning a response

type GetCharactersNotAcceptable 

type GetCharactersNotAcceptable struct {
}

GetCharactersNotAcceptable Error, at least one one of the specified gameServerId is invalid

swagger:response getCharactersNotAcceptable

func NewGetCharactersNotAcceptable 

func NewGetCharactersNotAcceptable() *GetCharactersNotAcceptable

NewGetCharactersNotAcceptable creates GetCharactersNotAcceptable with default headers values

func (*GetCharactersNotAcceptable) WriteResponse 

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

WriteResponse to the client

type GetCharactersNotFound 

type GetCharactersNotFound struct {
}

GetCharactersNotFound Error, at least one of the specified accounts doesn't exists

swagger:response getCharactersNotFound

func NewGetCharactersNotFound 

func NewGetCharactersNotFound() *GetCharactersNotFound

NewGetCharactersNotFound creates GetCharactersNotFound with default headers values

func (*GetCharactersNotFound) WriteResponse 

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

WriteResponse to the client

type GetCharactersOK 

type GetCharactersOK struct {

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

GetCharactersOK A list of characters

swagger:response getCharactersOK

func NewGetCharactersOK 

func NewGetCharactersOK() *GetCharactersOK

NewGetCharactersOK creates GetCharactersOK with default headers values

func (*GetCharactersOK) SetPayload 

func (o *GetCharactersOK) SetPayload(payload []*models.Character)

SetPayload sets the payload to the get characters o k response

func (*GetCharactersOK) WithPayload 

func (o *GetCharactersOK) WithPayload(payload []*models.Character) *GetCharactersOK

WithPayload adds the payload to the get characters o k response

func (*GetCharactersOK) WriteResponse 

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

WriteResponse to the client

type GetCharactersParams 

type GetCharactersParams struct {

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

	/*An optional value to filter the returned character list by accounts
	  Unique: true
	  In: query
	*/
	AccountNameFilter []string
	/*An optional value to filter the returned character list by gameServerIds
	  Unique: true
	  In: query
	*/
	GameServerIDFilter []int64
}

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

swagger:parameters getCharacters

func NewGetCharactersParams 

func NewGetCharactersParams() GetCharactersParams

NewGetCharactersParams creates a new GetCharactersParams object no default values defined in spec.

func (*GetCharactersParams) BindRequest 

func (o *GetCharactersParams) 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 NewGetCharactersParams() beforehand.

type GetCharactersURL 

type GetCharactersURL struct {
	AccountNameFilter  []string
	GameServerIDFilter []int64
	// contains filtered or unexported fields
}

GetCharactersURL generates an URL for the get characters operation

func (*GetCharactersURL) Build 

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

Build a url path and query string

func (*GetCharactersURL) BuildFull 

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

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

func (*GetCharactersURL) Must 

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

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

func (*GetCharactersURL) SetBasePath 

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

func (o *GetCharactersURL) String() string

String returns the string representation of the path with query string

func (*GetCharactersURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetCharactersURL) WithBasePath 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.