Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- func IsNil(i interface{}) bool
- 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
- type APIKey
- type APIResponse
- type BasicAuth
- type Configuration
- type FunctionsApi
- type FunctionsApiService
- func (a *FunctionsApiService) V1FunctionsBuildPost(ctx context.Context) FunctionsApiV1FunctionsBuildPostRequest
- func (a *FunctionsApiService) V1FunctionsBuildPostExecute(r FunctionsApiV1FunctionsBuildPostRequest) (string, *http.Response, error)
- func (a *FunctionsApiService) V1FunctionsIdGet(ctx context.Context, id string) FunctionsApiV1FunctionsIdGetRequest
- func (a *FunctionsApiService) V1FunctionsIdGetExecute(r FunctionsApiV1FunctionsIdGetRequest) (string, *http.Response, error)
- type FunctionsApiV1FunctionsBuildPostRequest
- func (r FunctionsApiV1FunctionsBuildPostRequest) Archive(archive *os.File) FunctionsApiV1FunctionsBuildPostRequest
- func (r FunctionsApiV1FunctionsBuildPostRequest) Execute() (string, *http.Response, error)
- func (r FunctionsApiV1FunctionsBuildPostRequest) Name(name string) FunctionsApiV1FunctionsBuildPostRequest
- func (r FunctionsApiV1FunctionsBuildPostRequest) Runtime(runtime string) FunctionsApiV1FunctionsBuildPostRequest
- type FunctionsApiV1FunctionsIdGetRequest
- type GenericOpenAPIError
- type MappedNullable
- type NullableBool
- type NullableFloat32
- type NullableFloat64
- type NullableInt
- type NullableInt32
- type NullableInt64
- type NullableString
- type NullableTime
- type ServerConfiguration
- type ServerConfigurations
- type ServerVariable
Constants ¶
This section is empty.
Variables ¶
var ( // 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") )
Functions ¶
func CacheExpires ¶
CacheExpires helper function to determine remaining time before repeating a request.
func PtrFloat32 ¶
PtrFloat32 is a helper routine that returns a pointer to given float value.
func PtrFloat64 ¶
PtrFloat64 is a helper routine that returns a pointer to given float value.
Types ¶
type APIClient ¶
type APIClient struct { FunctionsApi FunctionsApi // contains filtered or unexported fields }
APIClient manages communication with the Morty Registry - API Documentation API v1.0.0 In most cases there should be only one, shared, APIClient.
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 APIResponse ¶
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:"-"` }
APIResponse stores the API response returned by the server.
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 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 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 }
Configuration stores the configuration of the API 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) ServerURLWithContext ¶
ServerURLWithContext returns a new server URL given an endpoint
type FunctionsApi ¶
type FunctionsApi interface { /* V1FunctionsBuildPost Build a function and push the image into the registry. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return FunctionsApiV1FunctionsBuildPostRequest */ V1FunctionsBuildPost(ctx context.Context) FunctionsApiV1FunctionsBuildPostRequest // V1FunctionsBuildPostExecute executes the request // @return string V1FunctionsBuildPostExecute(r FunctionsApiV1FunctionsBuildPostRequest) (string, *http.Response, error) /* V1FunctionsIdGet Get a download link for the image of the given function @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param id The identifier of the function to upload. @return FunctionsApiV1FunctionsIdGetRequest */ V1FunctionsIdGet(ctx context.Context, id string) FunctionsApiV1FunctionsIdGetRequest // V1FunctionsIdGetExecute executes the request // @return string V1FunctionsIdGetExecute(r FunctionsApiV1FunctionsIdGetRequest) (string, *http.Response, error) }
type FunctionsApiService ¶
type FunctionsApiService service
FunctionsApiService FunctionsApi service
func (*FunctionsApiService) V1FunctionsBuildPost ¶
func (a *FunctionsApiService) V1FunctionsBuildPost(ctx context.Context) FunctionsApiV1FunctionsBuildPostRequest
V1FunctionsBuildPost Build a function and push the image into the registry.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return FunctionsApiV1FunctionsBuildPostRequest
func (*FunctionsApiService) V1FunctionsBuildPostExecute ¶
func (a *FunctionsApiService) V1FunctionsBuildPostExecute(r FunctionsApiV1FunctionsBuildPostRequest) (string, *http.Response, error)
Execute executes the request
@return string
func (*FunctionsApiService) V1FunctionsIdGet ¶
func (a *FunctionsApiService) V1FunctionsIdGet(ctx context.Context, id string) FunctionsApiV1FunctionsIdGetRequest
V1FunctionsIdGet Get a download link for the image of the given function
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param id The identifier of the function to upload. @return FunctionsApiV1FunctionsIdGetRequest
func (*FunctionsApiService) V1FunctionsIdGetExecute ¶
func (a *FunctionsApiService) V1FunctionsIdGetExecute(r FunctionsApiV1FunctionsIdGetRequest) (string, *http.Response, error)
Execute executes the request
@return string
type FunctionsApiV1FunctionsBuildPostRequest ¶
type FunctionsApiV1FunctionsBuildPostRequest struct { ApiService FunctionsApi // contains filtered or unexported fields }
func (FunctionsApiV1FunctionsBuildPostRequest) Archive ¶
func (r FunctionsApiV1FunctionsBuildPostRequest) Archive(archive *os.File) FunctionsApiV1FunctionsBuildPostRequest
func (FunctionsApiV1FunctionsBuildPostRequest) Execute ¶
func (r FunctionsApiV1FunctionsBuildPostRequest) Execute() (string, *http.Response, error)
func (FunctionsApiV1FunctionsBuildPostRequest) Name ¶
func (r FunctionsApiV1FunctionsBuildPostRequest) Name(name string) FunctionsApiV1FunctionsBuildPostRequest
The name of the function.
func (FunctionsApiV1FunctionsBuildPostRequest) Runtime ¶
func (r FunctionsApiV1FunctionsBuildPostRequest) Runtime(runtime string) FunctionsApiV1FunctionsBuildPostRequest
The name of the runtime to use.
type FunctionsApiV1FunctionsIdGetRequest ¶
type FunctionsApiV1FunctionsIdGetRequest struct { ApiService FunctionsApi // contains filtered or unexported fields }
type GenericOpenAPIError ¶
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
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
type MappedNullable ¶
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 ¶
type ServerConfiguration struct { URL string Description string Variables map[string]ServerVariable }
ServerConfiguration stores the information about a server
type ServerConfigurations ¶
type ServerConfigurations []ServerConfiguration
ServerConfigurations stores multiple ServerConfiguration items
type ServerVariable ¶
ServerVariable stores the information about a server variable