Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.13.4 DO NOT EDIT.
Index ¶
- func GetSwagger() (swagger *openapi3.T, err error)
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type BadRequestProblemResponse
- type ChiServerOptions
- type CreateMeterJSONRequestBody
- type CreateMeterParams
- type CreateNamespaceJSONRequestBody
- type DeleteMeterParams
- type Event
- type GetMeterParams
- type GetMeterValuesParams
- type IdOrSlug
- type IngestEventsApplicationCloudeventsBatchPlusJSONBody
- type IngestEventsApplicationCloudeventsBatchPlusJSONRequestBody
- type IngestEventsApplicationCloudeventsPlusJSONRequestBody
- type IngestEventsParams
- type InvalidParamFormatError
- type ListMeterSubjectsParams
- type ListMetersParams
- type Meter
- type MeterAggregation
- type MeterIdOrSlug
- type MeterQueryRow
- type MeterValue
- type MiddlewareFunc
- type Namespace
- type NamespaceInput
- type NotFoundProblemResponse
- type NotImplementedProblemResponse
- type Problem
- type QueryMeterParams
- type RequiredHeaderError
- type RequiredParamError
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) CreateMeter(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateNamespace(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteMeter(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetMeter(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetMeterValues(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) IngestEvents(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListMeterSubjects(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListMeters(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) QueryMeter(w http.ResponseWriter, r *http.Request)
- type TooManyValuesForParamError
- type UnescapedCookieParamError
- type UnexpectedProblemResponse
- type Unimplemented
- func (_ Unimplemented) CreateMeter(w http.ResponseWriter, r *http.Request, params CreateMeterParams)
- func (_ Unimplemented) CreateNamespace(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) DeleteMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, ...)
- func (_ Unimplemented) GetMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, ...)
- func (_ Unimplemented) GetMeterValues(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, ...)
- func (_ Unimplemented) IngestEvents(w http.ResponseWriter, r *http.Request, params IngestEventsParams)
- func (_ Unimplemented) ListMeterSubjects(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, ...)
- func (_ Unimplemented) ListMeters(w http.ResponseWriter, r *http.Request, params ListMetersParams)
- func (_ Unimplemented) QueryMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, ...)
- type UnmarshalingParamError
- type WindowSize
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type BadRequestProblemResponse ¶
type BadRequestProblemResponse = Problem
BadRequestProblemResponse A Problem Details object (RFC 7807)
type ChiServerOptions ¶
type ChiServerOptions struct {
BaseURL string
BaseRouter chi.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type CreateMeterJSONRequestBody ¶
type CreateMeterJSONRequestBody = Meter
CreateMeterJSONRequestBody defines body for CreateMeter for application/json ContentType.
type CreateMeterParams ¶
type CreateMeterParams struct {
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
CreateMeterParams defines parameters for CreateMeter.
type CreateNamespaceJSONRequestBody ¶
type CreateNamespaceJSONRequestBody = Namespace
CreateNamespaceJSONRequestBody defines body for CreateNamespace for application/json ContentType.
type DeleteMeterParams ¶
type DeleteMeterParams struct {
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
DeleteMeterParams defines parameters for DeleteMeter.
type GetMeterParams ¶
type GetMeterParams struct {
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
GetMeterParams defines parameters for GetMeter.
type GetMeterValuesParams ¶
type GetMeterValuesParams struct {
Subject *string `form:"subject,omitempty" json:"subject,omitempty"`
// From Start date-time in RFC 3339 format in UTC timezone.
// Must be aligned with the window size.
// Inclusive.
From *time.Time `form:"from,omitempty" json:"from,omitempty"`
// To End date-time in RFC 3339 format in UTC timezone.
// Must be aligned with the window size.
// Inclusive.
To *time.Time `form:"to,omitempty" json:"to,omitempty"`
// WindowSize If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
WindowSize *WindowSize `form:"windowSize,omitempty" json:"windowSize,omitempty"`
// Aggregation If not specified, OpenMeter will use the default aggregation type.
// As OpenMeter stores aggregates defined by meter config, passing a different aggregate can lead to inaccurate results.
// For example getting the MIN of SUMs.
Aggregation *MeterAggregation `form:"aggregation,omitempty" json:"aggregation,omitempty"`
// GroupBy If not specified a single aggregate will be returned for each subject and time window.
GroupBy *string `form:"groupBy,omitempty" json:"groupBy,omitempty"`
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
GetMeterValuesParams defines parameters for GetMeterValues.
type IngestEventsApplicationCloudeventsBatchPlusJSONBody ¶
type IngestEventsApplicationCloudeventsBatchPlusJSONBody = []Event
IngestEventsApplicationCloudeventsBatchPlusJSONBody defines parameters for IngestEvents.
type IngestEventsApplicationCloudeventsBatchPlusJSONRequestBody ¶
type IngestEventsApplicationCloudeventsBatchPlusJSONRequestBody = IngestEventsApplicationCloudeventsBatchPlusJSONBody
IngestEventsApplicationCloudeventsBatchPlusJSONRequestBody defines body for IngestEvents for application/cloudevents-batch+json ContentType.
type IngestEventsApplicationCloudeventsPlusJSONRequestBody ¶
type IngestEventsApplicationCloudeventsPlusJSONRequestBody = Event
IngestEventsApplicationCloudeventsPlusJSONRequestBody defines body for IngestEvents for application/cloudevents+json ContentType.
type IngestEventsParams ¶
type IngestEventsParams struct {
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
IngestEventsParams defines parameters for IngestEvents.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListMeterSubjectsParams ¶
type ListMeterSubjectsParams struct {
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
ListMeterSubjectsParams defines parameters for ListMeterSubjects.
type ListMetersParams ¶
type ListMetersParams struct {
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
ListMetersParams defines parameters for ListMeters.
type MeterAggregation ¶
type MeterAggregation = models.MeterAggregation
MeterAggregation The aggregation type to use for the meter.
type MeterQueryRow ¶
type MeterQueryRow = models.MeterQueryRow
MeterQueryRow defines model for MeterQueryRow.
type Namespace ¶
type Namespace struct {
// Namespace A namespace
Namespace string `json:"namespace"`
}
Namespace defines model for Namespace.
type NotFoundProblemResponse ¶
type NotFoundProblemResponse = Problem
NotFoundProblemResponse A Problem Details object (RFC 7807)
type NotImplementedProblemResponse ¶
type NotImplementedProblemResponse = Problem
NotImplementedProblemResponse A Problem Details object (RFC 7807)
type QueryMeterParams ¶
type QueryMeterParams struct {
// From Start date-time in RFC 3339 format in UTC timezone.
// Must be aligned with the window size.
// Inclusive.
From *time.Time `form:"from,omitempty" json:"from,omitempty"`
// To End date-time in RFC 3339 format in UTC timezone.
// Must be aligned with the window size.
// Inclusive.
To *time.Time `form:"to,omitempty" json:"to,omitempty"`
// WindowSize If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
WindowSize *WindowSize `form:"windowSize,omitempty" json:"windowSize,omitempty"`
// Aggregation If not specified, OpenMeter will use the default aggregation type.
// As OpenMeter stores aggregates defined by meter config, passing a different aggregate can lead to inaccurate results.
// For example getting the MIN of SUMs.
Aggregation *MeterAggregation `form:"aggregation,omitempty" json:"aggregation,omitempty"`
Subject *[]string `form:"subject,omitempty" json:"subject,omitempty"`
// GroupBy If not specified a single aggregate will be returned for each subject and time window.
GroupBy *[]string `form:"groupBy,omitempty" json:"groupBy,omitempty"`
// OMNamespace Optional namespace
NamespaceInput *NamespaceInput `json:"OM-Namespace,omitempty"`
}
QueryMeterParams defines parameters for QueryMeter.
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type ServerInterface ¶
type ServerInterface interface {
// (POST /api/v1/events)
IngestEvents(w http.ResponseWriter, r *http.Request, params IngestEventsParams)
// (GET /api/v1/meters)
ListMeters(w http.ResponseWriter, r *http.Request, params ListMetersParams)
// (POST /api/v1/meters)
CreateMeter(w http.ResponseWriter, r *http.Request, params CreateMeterParams)
// (DELETE /api/v1/meters/{meterIdOrSlug})
DeleteMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params DeleteMeterParams)
// (GET /api/v1/meters/{meterIdOrSlug})
GetMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params GetMeterParams)
// (GET /api/v1/meters/{meterIdOrSlug}/query)
QueryMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params QueryMeterParams)
// (GET /api/v1/meters/{meterIdOrSlug}/subjects)
ListMeterSubjects(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params ListMeterSubjectsParams)
// (GET /api/v1/meters/{meterIdOrSlug}/values)
GetMeterValues(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params GetMeterValuesParams)
// (POST /api/v1/namespaces)
CreateNamespace(w http.ResponseWriter, r *http.Request)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) CreateMeter ¶
func (siw *ServerInterfaceWrapper) CreateMeter(w http.ResponseWriter, r *http.Request)
CreateMeter operation middleware
func (*ServerInterfaceWrapper) CreateNamespace ¶
func (siw *ServerInterfaceWrapper) CreateNamespace(w http.ResponseWriter, r *http.Request)
CreateNamespace operation middleware
func (*ServerInterfaceWrapper) DeleteMeter ¶
func (siw *ServerInterfaceWrapper) DeleteMeter(w http.ResponseWriter, r *http.Request)
DeleteMeter operation middleware
func (*ServerInterfaceWrapper) GetMeter ¶
func (siw *ServerInterfaceWrapper) GetMeter(w http.ResponseWriter, r *http.Request)
GetMeter operation middleware
func (*ServerInterfaceWrapper) GetMeterValues ¶
func (siw *ServerInterfaceWrapper) GetMeterValues(w http.ResponseWriter, r *http.Request)
GetMeterValues operation middleware
func (*ServerInterfaceWrapper) IngestEvents ¶
func (siw *ServerInterfaceWrapper) IngestEvents(w http.ResponseWriter, r *http.Request)
IngestEvents operation middleware
func (*ServerInterfaceWrapper) ListMeterSubjects ¶
func (siw *ServerInterfaceWrapper) ListMeterSubjects(w http.ResponseWriter, r *http.Request)
ListMeterSubjects operation middleware
func (*ServerInterfaceWrapper) ListMeters ¶
func (siw *ServerInterfaceWrapper) ListMeters(w http.ResponseWriter, r *http.Request)
ListMeters operation middleware
func (*ServerInterfaceWrapper) QueryMeter ¶
func (siw *ServerInterfaceWrapper) QueryMeter(w http.ResponseWriter, r *http.Request)
QueryMeter operation middleware
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type UnexpectedProblemResponse ¶
type UnexpectedProblemResponse = Problem
UnexpectedProblemResponse A Problem Details object (RFC 7807)
type Unimplemented ¶
type Unimplemented struct{}
func (Unimplemented) CreateMeter ¶
func (_ Unimplemented) CreateMeter(w http.ResponseWriter, r *http.Request, params CreateMeterParams)
(POST /api/v1/meters)
func (Unimplemented) CreateNamespace ¶
func (_ Unimplemented) CreateNamespace(w http.ResponseWriter, r *http.Request)
(POST /api/v1/namespaces)
func (Unimplemented) DeleteMeter ¶
func (_ Unimplemented) DeleteMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params DeleteMeterParams)
(DELETE /api/v1/meters/{meterIdOrSlug})
func (Unimplemented) GetMeter ¶
func (_ Unimplemented) GetMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params GetMeterParams)
(GET /api/v1/meters/{meterIdOrSlug})
func (Unimplemented) GetMeterValues ¶
func (_ Unimplemented) GetMeterValues(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params GetMeterValuesParams)
(GET /api/v1/meters/{meterIdOrSlug}/values)
func (Unimplemented) IngestEvents ¶
func (_ Unimplemented) IngestEvents(w http.ResponseWriter, r *http.Request, params IngestEventsParams)
(POST /api/v1/events)
func (Unimplemented) ListMeterSubjects ¶
func (_ Unimplemented) ListMeterSubjects(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params ListMeterSubjectsParams)
(GET /api/v1/meters/{meterIdOrSlug}/subjects)
func (Unimplemented) ListMeters ¶
func (_ Unimplemented) ListMeters(w http.ResponseWriter, r *http.Request, params ListMetersParams)
(GET /api/v1/meters)
func (Unimplemented) QueryMeter ¶
func (_ Unimplemented) QueryMeter(w http.ResponseWriter, r *http.Request, meterIdOrSlug MeterIdOrSlug, params QueryMeterParams)
(GET /api/v1/meters/{meterIdOrSlug}/query)
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error