...

Package openapi

import "go.formulabun.club/replays/staff/client"
Overview
Index

Overview ▾

Index ▾

Variables
func CacheExpires(r *http.Response) time.Time
func PtrBool(v bool) *bool
func PtrFloat32(v float32) *float32
func PtrFloat64(v float64) *float64
func PtrInt(v int) *int
func PtrInt32(v int32) *int32
func PtrInt64(v int64) *int64
func PtrString(v string) *string
func PtrTime(v time.Time) *time.Time
type APIClient
    func NewAPIClient(cfg *Configuration) *APIClient
    func (c *APIClient) GetConfig() *Configuration
type APIKey
type APIResponse
    func NewAPIResponse(r *http.Response) *APIResponse
    func NewAPIResponseWithError(errorMessage string) *APIResponse
type ApiReplayIdGetRequest
    func (r ApiReplayIdGetRequest) Execute() (**os.File, *http.Response, error)
type ApiStaffGetRequest
    func (r ApiStaffGetRequest) Execute() (**os.File, *http.Response, error)
    func (r ApiStaffGetRequest) Ids(ids []string) ApiStaffGetRequest
type BasicAuth
type Configuration
    func NewConfiguration() *Configuration
    func (c *Configuration) AddDefaultHeader(key string, value string)
    func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)
    func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)
type DefaultApiService
    func (a *DefaultApiService) ReplayIdGet(ctx context.Context, id string) ApiReplayIdGetRequest
    func (a *DefaultApiService) ReplayIdGetExecute(r ApiReplayIdGetRequest) (**os.File, *http.Response, error)
    func (a *DefaultApiService) StaffGet(ctx context.Context) ApiStaffGetRequest
    func (a *DefaultApiService) StaffGetExecute(r ApiStaffGetRequest) (**os.File, *http.Response, error)
type GenericOpenAPIError
    func (e GenericOpenAPIError) Body() []byte
    func (e GenericOpenAPIError) Error() string
    func (e GenericOpenAPIError) Model() interface{}
type NullableBool
    func NewNullableBool(val *bool) *NullableBool
    func (v NullableBool) Get() *bool
    func (v NullableBool) IsSet() bool
    func (v NullableBool) MarshalJSON() ([]byte, error)
    func (v *NullableBool) Set(val *bool)
    func (v *NullableBool) UnmarshalJSON(src []byte) error
    func (v *NullableBool) Unset()
type NullableFloat32
    func NewNullableFloat32(val *float32) *NullableFloat32
    func (v NullableFloat32) Get() *float32
    func (v NullableFloat32) IsSet() bool
    func (v NullableFloat32) MarshalJSON() ([]byte, error)
    func (v *NullableFloat32) Set(val *float32)
    func (v *NullableFloat32) UnmarshalJSON(src []byte) error
    func (v *NullableFloat32) Unset()
type NullableFloat64
    func NewNullableFloat64(val *float64) *NullableFloat64
    func (v NullableFloat64) Get() *float64
    func (v NullableFloat64) IsSet() bool
    func (v NullableFloat64) MarshalJSON() ([]byte, error)
    func (v *NullableFloat64) Set(val *float64)
    func (v *NullableFloat64) UnmarshalJSON(src []byte) error
    func (v *NullableFloat64) Unset()
type NullableInt
    func NewNullableInt(val *int) *NullableInt
    func (v NullableInt) Get() *int
    func (v NullableInt) IsSet() bool
    func (v NullableInt) MarshalJSON() ([]byte, error)
    func (v *NullableInt) Set(val *int)
    func (v *NullableInt) UnmarshalJSON(src []byte) error
    func (v *NullableInt) Unset()
type NullableInt32
    func NewNullableInt32(val *int32) *NullableInt32
    func (v NullableInt32) Get() *int32
    func (v NullableInt32) IsSet() bool
    func (v NullableInt32) MarshalJSON() ([]byte, error)
    func (v *NullableInt32) Set(val *int32)
    func (v *NullableInt32) UnmarshalJSON(src []byte) error
    func (v *NullableInt32) Unset()
type NullableInt64
    func NewNullableInt64(val *int64) *NullableInt64
    func (v NullableInt64) Get() *int64
    func (v NullableInt64) IsSet() bool
    func (v NullableInt64) MarshalJSON() ([]byte, error)
    func (v *NullableInt64) Set(val *int64)
    func (v *NullableInt64) UnmarshalJSON(src []byte) error
    func (v *NullableInt64) Unset()
type NullableString
    func NewNullableString(val *string) *NullableString
    func (v NullableString) Get() *string
    func (v NullableString) IsSet() bool
    func (v NullableString) MarshalJSON() ([]byte, error)
    func (v *NullableString) Set(val *string)
    func (v *NullableString) UnmarshalJSON(src []byte) error
    func (v *NullableString) Unset()
type NullableTime
    func NewNullableTime(val *time.Time) *NullableTime
    func (v NullableTime) Get() *time.Time
    func (v NullableTime) IsSet() bool
    func (v NullableTime) MarshalJSON() ([]byte, error)
    func (v *NullableTime) Set(val *time.Time)
    func (v *NullableTime) UnmarshalJSON(src []byte) error
    func (v *NullableTime) Unset()
type ServerConfiguration
type ServerConfigurations
    func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)
type ServerVariable

Package files

api_default.go client.go configuration.go response.go utils.go

Variables

var (
    // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
    ContextOAuth2 = contextKey("token")

    // ContextBasicAuth takes BasicAuth as authentication for the request.
    ContextBasicAuth = contextKey("basic")

    // ContextAccessToken takes a string oauth2 access token as authentication for the request.
    ContextAccessToken = contextKey("accesstoken")

    // ContextAPIKeys takes a string apikey as authentication for the request
    ContextAPIKeys = contextKey("apiKeys")

    // ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
    ContextHttpSignatureAuth = contextKey("httpsignature")

    // ContextServerIndex uses a server configuration from the index.
    ContextServerIndex = contextKey("serverIndex")

    // ContextOperationServerIndices uses a server configuration from the index mapping.
    ContextOperationServerIndices = contextKey("serverOperationIndices")

    // ContextServerVariables overrides a server configuration variables.
    ContextServerVariables = contextKey("serverVariables")

    // ContextOperationServerVariables overrides a server configuration variables using operation specific values.
    ContextOperationServerVariables = contextKey("serverOperationVariables")
)

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

type APIClient

APIClient manages communication with the GoBun replay download API v0.0.1 In most cases there should be only one, shared, APIClient.

type APIClient struct {
    DefaultApi *DefaultApiService
    // contains filtered or unexported fields
}

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIKey struct {
    Key    string
    Prefix string
}

type APIResponse

APIResponse stores the API response returned by the server.

type APIResponse struct {
    *http.Response `json:"-"`
    Message        string `json:"message,omitempty"`
    // Operation is the name of the OpenAPI operation.
    Operation string `json:"operation,omitempty"`
    // RequestURL is the request URL. This value is always available, even if the
    // embedded *http.Response is nil.
    RequestURL string `json:"url,omitempty"`
    // Method is the HTTP method used for the request.  This value is always
    // available, even if the embedded *http.Response is nil.
    Method string `json:"method,omitempty"`
    // Payload holds the contents of the response body (which may be nil or empty).
    // This is provided here as the raw response.Body() reader will have already
    // been drained.
    Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiReplayIdGetRequest

type ApiReplayIdGetRequest struct {
    ApiService *DefaultApiService
    // contains filtered or unexported fields
}

func (ApiReplayIdGetRequest) Execute

func (r ApiReplayIdGetRequest) Execute() (**os.File, *http.Response, error)

type ApiStaffGetRequest

type ApiStaffGetRequest struct {
    ApiService *DefaultApiService
    // contains filtered or unexported fields
}

func (ApiStaffGetRequest) Execute

func (r ApiStaffGetRequest) Execute() (**os.File, *http.Response, error)

func (ApiStaffGetRequest) Ids

func (r ApiStaffGetRequest) Ids(ids []string) ApiStaffGetRequest

List of replay ids

type BasicAuth

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BasicAuth struct {
    UserName string `json:"userName,omitempty"`
    Password string `json:"password,omitempty"`
}

type Configuration

Configuration stores the configuration of the API client

type Configuration struct {
    Host             string            `json:"host,omitempty"`
    Scheme           string            `json:"scheme,omitempty"`
    DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
    UserAgent        string            `json:"userAgent,omitempty"`
    Debug            bool              `json:"debug,omitempty"`
    Servers          ServerConfigurations
    OperationServers map[string]ServerConfigurations
    HTTPClient       *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DefaultApiService

DefaultApiService DefaultApi service

type DefaultApiService service

func (*DefaultApiService) ReplayIdGet

func (a *DefaultApiService) ReplayIdGet(ctx context.Context, id string) ApiReplayIdGetRequest

ReplayIdGet Get a replay

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id id of the replay
@return ApiReplayIdGetRequest

func (*DefaultApiService) ReplayIdGetExecute

func (a *DefaultApiService) ReplayIdGetExecute(r ApiReplayIdGetRequest) (**os.File, *http.Response, error)

Execute executes the request

@return *os.File

func (*DefaultApiService) StaffGet

func (a *DefaultApiService) StaffGet(ctx context.Context) ApiStaffGetRequest

StaffGet Get a replay as staff

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiStaffGetRequest

func (*DefaultApiService) StaffGetExecute

func (a *DefaultApiService) StaffGetExecute(r ApiStaffGetRequest) (**os.File, *http.Response, error)

Execute executes the request

@return *os.File

type GenericOpenAPIError

GenericOpenAPIError Provides access to the body, error and model on returned errors.

type GenericOpenAPIError struct {
    // contains filtered or unexported fields
}

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type NullableBool

type NullableBool struct {
    // contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableFloat32

type NullableFloat32 struct {
    // contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
    // contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

type NullableInt struct {
    // contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
    // contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
    // contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableString

type NullableString struct {
    // contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
    // contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type ServerConfiguration

ServerConfiguration stores the information about a server

type ServerConfiguration struct {
    URL         string
    Description string
    Variables   map[string]ServerVariable
}

type ServerConfigurations

ServerConfigurations stores multiple ServerConfiguration items

type ServerConfigurations []ServerConfiguration

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

ServerVariable stores the information about a server variable

type ServerVariable struct {
    Description  string
    DefaultValue string
    EnumValues   []string
}