common

Documentation

Index

• Constants
• func CacheExpires(r *http.Response) time.Time
• func CallAPI(cfg Configuration, request *http.Request) (*http.Response, error)
• func Decode(v interface{}, b []byte, contentType string) (err error)
• func MultipartDecode(b []byte, v interface{}, boundary string) (err error)
• func MultipartEncode(v interface{}, body io.Writer) (string, error)
• func ParameterToString(obj interface{}, collectionFormat string) string
• func PrepareRequest(ctx context.Context, cfg Configuration, path string, method string, ...) (localVarRequest *http.Request, err error)
• func ReportError(format string, a ...interface{}) error
• func SelectHeaderAccept(accepts []string) string
• func TypeCheckParameter(obj interface{}, expected string, name string) error
• type APIKey
• type BasicAuth
• type Configuration
• type ContextKey
  • func (c ContextKey) String() string
• type GenericOpenAPIError
  • func (e GenericOpenAPIError) Body() []byte
  • func (e GenericOpenAPIError) Error() string
  • func (e GenericOpenAPIError) Model() interface{}

Constants

const (
	// 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")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = ContextKey("apikey")
)

Functions

func CacheExpires

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

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

func CallAPI

func CallAPI(cfg Configuration, request *http.Request) (*http.Response, error)

callAPI do the request.

func Decode

func Decode(v interface{}, b []byte, contentType string) (err error)

func MultipartDecode

func MultipartDecode(b []byte, v interface{}, boundary string) (err error)

func MultipartEncode

func MultipartEncode(v interface{}, body io.Writer) (string, error)

func ParameterToString

func ParameterToString(obj interface{}, collectionFormat string) string

ParameterToString convert interface{} parameters to string, using a delimiter if format is provided.

func PrepareRequest

func PrepareRequest(
	ctx context.Context,
	cfg Configuration,
	path string, method string,
	postBody interface{},
	headerParams map[string]string,
	queryParams url.Values,
	formParams url.Values,
	formFileName string,
	fileName string,
	fileBytes []byte) (localVarRequest *http.Request, err error)

prepareRequest build the request

func ReportError

func ReportError(format string, a ...interface{}) error

Prevent trying to import "fmt"

func SelectHeaderAccept

func SelectHeaderAccept(accepts []string) string

SelectHeaderAccept join all accept types and return

func TypeCheckParameter

func TypeCheckParameter(obj interface{}, expected string, name string) error

Verify optional parameters are of the correct type.

Types

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

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

type BasicAuth

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

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

type Configuration

type Configuration interface {
	BasePath() string
	Host() string
	UserAgent() string
	DefaultHeader() map[string]string
	HTTPClient() *http.Client
}

type ContextKey

type ContextKey string

func (ContextKey) String

func (c ContextKey) String() string

type GenericOpenAPIError

type GenericOpenAPIError struct {
	RawBody     []byte
	ErrorStatus string
	ErrorModel  interface{}
}

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

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