types

package
v0.0.0-...-8a38cc6 Latest Latest
Warning

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

Go to latest
Published: Oct 6, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetUserInfoResponse

type GetUserInfoResponse struct {

	// Email address of user, if available
	// Example: user@example.com
	// Required: true
	// Max Length: 255
	// Format: email
	Email *strfmt.Email `json:"email"`

	// ID of user
	// Example: 82ebdfad-c586-4407-a873-4cc1c33d56fc
	// Required: true
	ID *string `json:"id"`

	// Name of user
	// Example: John Doe
	// Required: true
	Name *string `json:"name"`
}

GetUserInfoResponse get user info response

swagger:model getUserInfoResponse

func (*GetUserInfoResponse) ContextValidate

func (m *GetUserInfoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get user info response based on context it is used

func (*GetUserInfoResponse) MarshalBinary

func (m *GetUserInfoResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetUserInfoResponse) UnmarshalBinary

func (m *GetUserInfoResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetUserInfoResponse) Validate

func (m *GetUserInfoResponse) Validate(formats strfmt.Registry) error

Validate validates this get user info response

type HTTPValidationErrorDetail

type HTTPValidationErrorDetail struct {

	// Error describing field validation failure
	// Required: true
	Error *string `json:"error"`

	// Indicates how the invalid field was provided
	// Required: true
	In *string `json:"in"`

	// Key of field failing validation
	// Required: true
	Key *string `json:"key"`
}

HTTPValidationErrorDetail http validation error detail

swagger:model httpValidationErrorDetail

func (*HTTPValidationErrorDetail) ContextValidate

func (m *HTTPValidationErrorDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this http validation error detail based on context it is used

func (*HTTPValidationErrorDetail) MarshalBinary

func (m *HTTPValidationErrorDetail) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*HTTPValidationErrorDetail) UnmarshalBinary

func (m *HTTPValidationErrorDetail) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*HTTPValidationErrorDetail) Validate

func (m *HTTPValidationErrorDetail) Validate(formats strfmt.Registry) error

Validate validates this http validation error detail

type OrderDir

type OrderDir string

OrderDir order dir

swagger:model orderDir

const (

	// OrderDirAsc captures enum value "asc"
	OrderDirAsc OrderDir = "asc"

	// OrderDirDesc captures enum value "desc"
	OrderDirDesc OrderDir = "desc"
)

func NewOrderDir

func NewOrderDir(value OrderDir) *OrderDir

func (OrderDir) ContextValidate

func (m OrderDir) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this order dir based on context it is used

func (OrderDir) Pointer

func (m OrderDir) Pointer() *OrderDir

Pointer returns a pointer to a freshly-allocated OrderDir.

func (OrderDir) Validate

func (m OrderDir) Validate(formats strfmt.Registry) error

Validate validates this order dir

type PostLoginPayload

type PostLoginPayload struct {

	// Email of user to authenticate as
	// Example: user@example.com
	// Required: true
	// Max Length: 255
	// Min Length: 1
	// Format: email
	Email *strfmt.Email `json:"email"`

	// Password of user to authenticate as
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 255
	// Min Length: 1
	Password *string `json:"password"`
}

PostLoginPayload post login payload

swagger:model postLoginPayload

func (*PostLoginPayload) ContextValidate

func (m *PostLoginPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post login payload based on context it is used

func (*PostLoginPayload) MarshalBinary

func (m *PostLoginPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLoginPayload) UnmarshalBinary

func (m *PostLoginPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLoginPayload) Validate

func (m *PostLoginPayload) Validate(formats strfmt.Registry) error

Validate validates this post login payload

type PostLoginResponse

type PostLoginResponse struct {

	// Access token required for accessing protected API endpoints
	// Example: eyJhdWQiOiJjdXN0b2...
	// Required: true
	AccessToken *string `json:"access_token"`

	// Refresh token for refreshing the access token once it expires
	// Example: eyJhdWQiOiJjdXN0b2...
	// Required: true
	RefreshToken *string `json:"refresh_token"`
}

PostLoginResponse post login response

swagger:model postLoginResponse

func (*PostLoginResponse) ContextValidate

func (m *PostLoginResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post login response based on context it is used

func (*PostLoginResponse) MarshalBinary

func (m *PostLoginResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLoginResponse) UnmarshalBinary

func (m *PostLoginResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLoginResponse) Validate

func (m *PostLoginResponse) Validate(formats strfmt.Registry) error

Validate validates this post login response

type PostRegisterPayload

type PostRegisterPayload struct {

	// Email to register with
	// Example: user@example.com
	// Required: true
	// Max Length: 255
	// Min Length: 1
	// Format: email
	Email *strfmt.Email `json:"email"`

	// Name to register with
	// Example: John Doe
	// Required: true
	// Max Length: 255
	// Min Length: 1
	Name *string `json:"name"`

	// Password to register with
	// Example: correct horse battery staple
	// Required: true
	// Max Length: 255
	// Min Length: 1
	Password *string `json:"password"`
}

PostRegisterPayload post register payload

swagger:model postRegisterPayload

func (*PostRegisterPayload) ContextValidate

func (m *PostRegisterPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post register payload based on context it is used

func (*PostRegisterPayload) MarshalBinary

func (m *PostRegisterPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostRegisterPayload) UnmarshalBinary

func (m *PostRegisterPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostRegisterPayload) Validate

func (m *PostRegisterPayload) Validate(formats strfmt.Registry) error

Validate validates this post register payload

type PublicHTTPError

type PublicHTTPError struct {

	// HTTP status code returned for the error
	// Example: 403
	// Required: true
	// Maximum: 599
	// Minimum: 100
	Code *int64 `json:"status"`

	// More detailed, human-readable, optional explanation of the error
	// Example: User is lacking permission to access this resource
	Detail string `json:"detail,omitempty"`

	// Short, human-readable description of the error
	// Example: Forbidden
	// Required: true
	Title *string `json:"title"`

	// Type of error returned, should be used for client-side error handling
	// Example: generic
	// Required: true
	Type *string `json:"type"`
}

PublicHTTPError public Http error

swagger:model publicHttpError

func (*PublicHTTPError) ContextValidate

func (m *PublicHTTPError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this public Http error based on context it is used

func (*PublicHTTPError) MarshalBinary

func (m *PublicHTTPError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PublicHTTPError) UnmarshalBinary

func (m *PublicHTTPError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PublicHTTPError) Validate

func (m *PublicHTTPError) Validate(formats strfmt.Registry) error

Validate validates this public Http error

type PublicHTTPValidationError

type PublicHTTPValidationError struct {
	PublicHTTPError

	// List of errors received while validating payload against schema
	// Required: true
	ValidationErrors []*HTTPValidationErrorDetail `json:"validationErrors"`
}

PublicHTTPValidationError public Http validation error

swagger:model publicHttpValidationError

func (*PublicHTTPValidationError) ContextValidate

func (m *PublicHTTPValidationError) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this public Http validation error based on the context it is used

func (*PublicHTTPValidationError) MarshalBinary

func (m *PublicHTTPValidationError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (PublicHTTPValidationError) MarshalJSON

func (m PublicHTTPValidationError) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*PublicHTTPValidationError) UnmarshalBinary

func (m *PublicHTTPValidationError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PublicHTTPValidationError) UnmarshalJSON

func (m *PublicHTTPValidationError) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*PublicHTTPValidationError) Validate

func (m *PublicHTTPValidationError) Validate(formats strfmt.Registry) error

Validate validates this public Http validation error

type StreamEvent

type StreamEvent struct {

	// Action performed on stream
	// Example: publish
	// Required: true
	Action *string `json:"action"`

	// App of stream
	// Example: app
	// Required: true
	App *string `json:"app"`

	// Client ID of stream
	// Example: 891d37d3-c74f-493e-aea8-af73efd92016
	// Required: true
	ClientID *string `json:"client_id"`

	// IP address of stream
	// Example: 89.207.132.170
	// Required: true
	IP *string `json:"ip"`

	// Param of stream
	// Example: param
	// Required: true
	Param *string `json:"param"`

	// Server ID of stream
	// Example: 891d37d3-c74f-493e-aea8-af73efd92016
	// Required: true
	ServerID *string `json:"server_id"`

	// Stream of stream
	// Example: stream
	// Required: true
	Stream *string `json:"stream"`

	// Stream ID of stream
	// Example: 891d37d3-c74f-493e-aea8-af73efd92016
	// Required: true
	StreamID *string `json:"stream_id"`

	// Stream URL of stream
	// Example: stream_url
	// Required: true
	StreamURL *string `json:"stream_url"`

	// VHost of stream
	// Example: vhost
	// Required: true
	Vhost *string `json:"vhost"`
}

StreamEvent stream event

swagger:model streamEvent

func (*StreamEvent) ContextValidate

func (m *StreamEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this stream event based on context it is used

func (*StreamEvent) MarshalBinary

func (m *StreamEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StreamEvent) UnmarshalBinary

func (m *StreamEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StreamEvent) Validate

func (m *StreamEvent) Validate(formats strfmt.Registry) error

Validate validates this stream event

type StreamEventResponse

type StreamEventResponse struct {

	// Response code
	// Example: 0
	// Required: true
	Code *int64 `json:"code"`
}

StreamEventResponse stream event response

swagger:model streamEventResponse

func (*StreamEventResponse) ContextValidate

func (m *StreamEventResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this stream event response based on context it is used

func (*StreamEventResponse) MarshalBinary

func (m *StreamEventResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StreamEventResponse) UnmarshalBinary

func (m *StreamEventResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StreamEventResponse) Validate

func (m *StreamEventResponse) Validate(formats strfmt.Registry) error

Validate validates this stream event response

type SwaggerSpec

type SwaggerSpec struct {
	Handlers map[string]map[string]bool
}

SwaggerSpec API documentation

func NewSwaggerSpec

func NewSwaggerSpec() *SwaggerSpec

NewSwaggerSpec creates a new SwaggerSpec instance

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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