Documentation
¶
Overview ¶
Package api_client provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.1-0.20260422212540-070fa9306958 DO NOT EDIT.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
type ClientInterface ¶
type ClientInterface interface {
// GetMetric request
GetMetric(ctx context.Context, metricName string, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetMetricWithResponse ¶
func (c *ClientWithResponses) GetMetricWithResponse(ctx context.Context, metricName string, reqEditors ...RequestEditorFn) (*GetMetricResponse, error)
GetMetricWithResponse request returning *GetMetricResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// GetMetricWithResponse request
GetMetricWithResponse(ctx context.Context, metricName string, reqEditors ...RequestEditorFn) (*GetMetricResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Error ¶
type Error struct {
Code *int32 `json:"code,omitempty"`
Message *string `json:"message,omitempty"`
}
Error defines model for Error.
type GetMetricResponse ¶
type GetMetricResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Metric
JSONDefault *Error
}
func ParseGetMetricResponse ¶
func ParseGetMetricResponse(rsp *http.Response) (*GetMetricResponse, error)
ParseGetMetricResponse parses an HTTP response from a GetMetricWithResponse call
func (GetMetricResponse) Status ¶
func (r GetMetricResponse) Status() string
Status returns HTTPResponse.Status
func (GetMetricResponse) StatusCode ¶
func (r GetMetricResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.