Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthRequest ¶
type AuthRequest struct {
// User's email
// Example: js@example.org
// Required: true
Email *string `json:"email"`
// User's password
// Example: some_password
// Required: true
Password *string `json:"password"`
}
AuthRequest auth request
swagger:model AuthRequest
func (*AuthRequest) ContextValidate ¶
ContextValidate validates this auth request based on context it is used
func (*AuthRequest) MarshalBinary ¶
func (m *AuthRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthRequest) UnmarshalBinary ¶
func (m *AuthRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthResponse ¶
type AuthResponse struct {
// user
User *User `json:"user,omitempty"`
}
AuthResponse auth response
swagger:model AuthResponse
func (*AuthResponse) ContextValidate ¶
ContextValidate validate this auth response based on the context it is used
func (*AuthResponse) MarshalBinary ¶
func (m *AuthResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthResponse) UnmarshalBinary ¶
func (m *AuthResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct {
// a human-readable explanation of the error
// Example: Bad Authentication data.
Message string `json:"message,omitempty"`
// the HTTP response code
// Example: 401
Status int64 `json:"status,omitempty"`
// Type of the error message
// Example: OAuthException
Type string `json:"type,omitempty"`
}
ErrorResponse error response
swagger:model ErrorResponse
func (*ErrorResponse) ContextValidate ¶
ContextValidate validates this error response based on context it is used
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SignupRequest ¶
type SignupRequest struct {
// User's email
// Example: js@example.org
// Required: true
// Format: email
Email *strfmt.Email `json:"email"`
// User's first name
// Example: John
// Required: true
Firstname *string `json:"firstname"`
// User's last name
// Example: Smith
// Required: true
Lastname *string `json:"lastname"`
// User's password
// Example: some_password
// Required: true
Password *string `json:"password"`
}
SignupRequest signup request
swagger:model SignupRequest
func (*SignupRequest) ContextValidate ¶
ContextValidate validates this signup request based on context it is used
func (*SignupRequest) MarshalBinary ¶
func (m *SignupRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SignupRequest) UnmarshalBinary ¶
func (m *SignupRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SignupResponse ¶
type SignupResponse struct {
// user
User *User `json:"user,omitempty"`
}
SignupResponse signup response
swagger:model SignupResponse
func (*SignupResponse) ContextValidate ¶
ContextValidate validate this signup response based on the context it is used
func (*SignupResponse) MarshalBinary ¶
func (m *SignupResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SignupResponse) UnmarshalBinary ¶
func (m *SignupResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type User ¶
type User struct {
// User's first name
// Example: John
Firstname string `json:"firstname,omitempty"`
// User's API Key that the client needs to provide when making API calls.
// Example: some_api_key
Key string `json:"key,omitempty"`
// User's last name
// Example: Smith
Lastname string `json:"lastname,omitempty"`
// User's session ID
// Example: 6c160004-35c8-45b1-a4da-0ab67076afde
Sid string `json:"sid,omitempty"`
// User's ID in the system
// Example: 545648798
UID int64 `json:"uid,omitempty"`
}
User user
swagger:model User
func (*User) ContextValidate ¶
ContextValidate validates this user based on context it is used
func (*User) MarshalBinary ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserState ¶
type UserState struct {
// User's ID exp points in the system
// Example: 545648798
Exp int64 `json:"exp,omitempty"`
// Some User's flags.
// Example: 99
Flags int64 `json:"flags,omitempty"`
// Game's ID (if game_id == 0 or absent then user in the lobby)
// Example: 144
GameID int32 `json:"game_id,omitempty"`
// User's ID lives count in the system
// Example: 5
Lives int64 `json:"lives,omitempty"`
// Generated nickname in the system
// Example: John
Nickname string `json:"nickname,omitempty"`
// User's ID in the system
// Example: 545648798
UID int64 `json:"uid,omitempty"`
}
UserState user state
swagger:model UserState
func (*UserState) ContextValidate ¶
ContextValidate validates this user state based on context it is used
func (*UserState) MarshalBinary ¶
MarshalBinary interface implementation
func (*UserState) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserStateRequest ¶
type UserStateRequest struct {
// User's ID
// Example: 100500
// Required: true
UID *int64 `json:"uid"`
}
UserStateRequest user state request
swagger:model UserStateRequest
func (*UserStateRequest) ContextValidate ¶
ContextValidate validates this user state request based on context it is used
func (*UserStateRequest) MarshalBinary ¶
func (m *UserStateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserStateRequest) UnmarshalBinary ¶
func (m *UserStateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserStateResponse ¶
type UserStateResponse struct {
// user state
UserState *UserState `json:"user_state,omitempty"`
}
UserStateResponse user state response
swagger:model UserStateResponse
func (*UserStateResponse) ContextValidate ¶
ContextValidate validate this user state response based on the context it is used
func (*UserStateResponse) MarshalBinary ¶
func (m *UserStateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserStateResponse) UnmarshalBinary ¶
func (m *UserStateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation