Documentation
¶
Overview ¶
Package offerings provides primitives to interact with the openapi HTTP API.
Code generated by github.com/do87/oapi-codegen version v0.5.1 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 common.Client
}
Client which conforms to the OpenAPI3 specification for this service.
type ClientInterface ¶
type ClientInterface interface {
// Get request
Get(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetWithResponse ¶
func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
GetWithResponse request returning *GetResponse
func (*ClientWithResponses) ParseGetResponse ¶
func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a GetWithResponse call
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// Get request
GetWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type GetResponse ¶
type GetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Offerings
HasError error // Aggregated error
}
func (GetResponse) StatusCode ¶
func (r GetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type InstanceSchema ¶
InstanceSchema defines model for InstanceSchema.
type Offering ¶
type Offering struct {
Description string `json:"description"`
DocumentationUrl string `json:"documentationUrl"`
ImageUrl string `json:"imageUrl"`
Latest bool `json:"latest"`
Name string `json:"name"`
Plans []Plan `json:"plans"`
QuotaCount int `json:"quotaCount"`
Schema *InstanceSchema `json:"schema,omitempty"`
Version string `json:"version"`
}
Offering defines model for Offering.
type Offerings ¶
type Offerings struct {
Offerings []Offering `json:"offerings"`
}
Offerings defines model for Offerings.
type Plan ¶
type Plan struct {
Description string `json:"description"`
Free bool `json:"free"`
ID string `json:"id"`
Name string `json:"name"`
}
Plan defines model for Plan.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function