Documentation
¶
Overview ¶
Package additional_properties provides primitives to interact with the openapi HTTP API.
Code generated by github.com/KosyanMedia/oapi-codegen/v2 version (devel) DO NOT EDIT.
Index ¶
- func NewDoSomethingRequest(server string) (*http.Request, error)
- type Client
- type ClientDoSomethingResponse
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- type ClientWithResponsesInterface
- type HttpRequestDoer
- type MustBeMap
- type MustBeMapToo
- type MustBeMapWithStructs
- type MustBeStruct
- type RequestEditorFn
- type SimpleObject
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.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) DoSomething ¶
type ClientDoSomethingResponse ¶
type ClientDoSomethingResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 MustBeMap
JSON201 MustBeMapToo
JSON202 *MustBeStruct
JSON203 MustBeMapWithStructs
}
func ParseDoSomethingResponse ¶
func ParseDoSomethingResponse(rsp *http.Response) (*ClientDoSomethingResponse, error)
ParseDoSomethingResponse parses an HTTP response from a DoSomethingWithResponse call
func (ClientDoSomethingResponse) RawResponse ¶ added in v2.1.17
func (r ClientDoSomethingResponse) RawResponse() *http.Response
RawResponse returns pointer to the raw http.Response
func (ClientDoSomethingResponse) ResponseBody ¶ added in v2.0.8
func (r ClientDoSomethingResponse) ResponseBody() []byte
ResponseBody returns HTTPResponse.Body as byte array
func (ClientDoSomethingResponse) Status ¶
func (r ClientDoSomethingResponse) Status() string
Status returns HTTPResponse.Status
func (ClientDoSomethingResponse) StatusCode ¶
func (r ClientDoSomethingResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ClientInterface ¶
type ClientInterface interface {
// DoSomething request
DoSomething(ctx context.Context, 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) DoSomethingWithResponse ¶
func (c *ClientWithResponses) DoSomethingWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ClientDoSomethingResponse, error)
DoSomethingWithResponse request returning *DoSomethingResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// DoSomething request
DoSomethingWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ClientDoSomethingResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type MustBeMapToo ¶
type MustBeMapToo map[string]interface{}
MustBeMapToo defines model for MustBeMapToo.
type MustBeMapWithStructs ¶
type MustBeMapWithStructs map[string]SimpleObject
MustBeMapWithStructs defines model for MustBeMapWithStructs.
type MustBeStruct ¶
type MustBeStruct struct {
StringField string `json:"string_field" validate:"required"`
AdditionalProperties map[string]string `json:"-"`
}
MustBeStruct defines model for MustBeStruct.
func (MustBeStruct) Get ¶
func (a MustBeStruct) Get(fieldName string) (value string, found bool)
Getter for additional properties for MustBeStruct. Returns the specified element and whether it was found
func (MustBeStruct) MarshalJSON ¶
func (a MustBeStruct) MarshalJSON() ([]byte, error)
Override default JSON handling for MustBeStruct to handle AdditionalProperties
func (*MustBeStruct) Set ¶
func (a *MustBeStruct) Set(fieldName string, value string)
Setter for additional properties for MustBeStruct
func (*MustBeStruct) UnmarshalJSON ¶
func (a *MustBeStruct) UnmarshalJSON(b []byte) error
Override default JSON handling for MustBeStruct to handle AdditionalProperties
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SimpleObject ¶
type SimpleObject struct {
StringField string `json:"string_field" validate:"required"`
}
SimpleObject defines model for SimpleObject.
Source Files