api

package

Go to main page

Versions in this module

v1

deprecated

v1.13.4

Aug 7, 2023

v1.13.3

Aug 3, 2023

Changes in this version

type UnionExampleResponse

+ ApplicationalternativeJSON200 *Example

v1.13.2

Jul 31, 2023

v1.13.1

Jul 31, 2023

Changes in this version

+ func NewUnionExampleRequest(server string, body UnionExampleJSONRequestBody) (*http.Request, error)

+ func NewUnionExampleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

type Client

+ func (c *Client) UnionExample(ctx context.Context, body UnionExampleJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) UnionExampleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

type ClientInterface

+ UnionExample func(ctx context.Context, body UnionExampleJSONRequestBody, ...) (*http.Response, error)

+ UnionExampleWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

type ClientWithResponses

+ func (c *ClientWithResponses) UnionExampleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UnionExampleResponse, error)

+ func (c *ClientWithResponses) UnionExampleWithResponse(ctx context.Context, body UnionExampleJSONRequestBody, ...) (*UnionExampleResponse, error)

type ClientWithResponsesInterface

+ UnionExampleWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*UnionExampleResponse, error)

+ UnionExampleWithResponse func(ctx context.Context, body UnionExampleJSONRequestBody, ...) (*UnionExampleResponse, error)

+ type UnionExampleJSONRequestBody = Example

+ type UnionExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 ...

+ func ParseUnionExampleResponse(rsp *http.Response) (*UnionExampleResponse, error)

+ func (r UnionExampleResponse) Status() string

+ func (r UnionExampleResponse) StatusCode() int

v1.13.0

Jun 2, 2023

Changes in this version

+ func NewReservedGoKeywordParametersRequest(server string, pType string) (*http.Request, error)

type Client

+ func (c *Client) ReservedGoKeywordParameters(ctx context.Context, pType string, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

+ ReservedGoKeywordParameters func(ctx context.Context, pType string, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientWithResponses

+ func (c *ClientWithResponses) ReservedGoKeywordParametersWithResponse(ctx context.Context, pType string, reqEditors ...RequestEditorFn) (*ReservedGoKeywordParametersResponse, error)

type ClientWithResponsesInterface

+ ReservedGoKeywordParametersWithResponse func(ctx context.Context, pType string, reqEditors ...RequestEditorFn) (*ReservedGoKeywordParametersResponse, error)

+ type ReservedGoKeywordParametersResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseReservedGoKeywordParametersResponse(rsp *http.Response) (*ReservedGoKeywordParametersResponse, error)

+ func (r ReservedGoKeywordParametersResponse) Status() string

+ func (r ReservedGoKeywordParametersResponse) StatusCode() int

v1.12.4

Dec 1, 2022

v1.12.3

Nov 21, 2022

v1.12.2

Oct 29, 2022

v1.12.1

Oct 28, 2022

v1.12.0

Oct 27, 2022

Changes in this version

+ func NewHeadersExampleRequest(server string, params *HeadersExampleParams, ...) (*http.Request, error)

+ func NewHeadersExampleRequestWithBody(server string, params *HeadersExampleParams, contentType string, ...) (*http.Request, error)

+ func NewJSONExampleRequest(server string, body JSONExampleJSONRequestBody) (*http.Request, error)

+ func NewJSONExampleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewMultipartExampleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewMultipleRequestAndResponseTypesRequest(server string, body MultipleRequestAndResponseTypesJSONRequestBody) (*http.Request, error)

+ func NewMultipleRequestAndResponseTypesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewMultipleRequestAndResponseTypesRequestWithFormdataBody(server string, body MultipleRequestAndResponseTypesFormdataRequestBody) (*http.Request, error)

+ func NewMultipleRequestAndResponseTypesRequestWithTextBody(server string, body MultipleRequestAndResponseTypesTextRequestBody) (*http.Request, error)

+ func NewReusableResponsesRequest(server string, body ReusableResponsesJSONRequestBody) (*http.Request, error)

+ func NewReusableResponsesRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewTextExampleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewTextExampleRequestWithTextBody(server string, body TextExampleTextRequestBody) (*http.Request, error)

+ func NewURLEncodedExampleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewURLEncodedExampleRequestWithFormdataBody(server string, body URLEncodedExampleFormdataRequestBody) (*http.Request, error)

+ func NewUnknownExampleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ func NewUnspecifiedContentTypeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

+ type Client struct

+ Client HttpRequestDoer

+ RequestEditors []RequestEditorFn

+ Server string

+ func NewClient(server string, opts ...ClientOption) (*Client, error)

+ func (c *Client) HeadersExample(ctx context.Context, params *HeadersExampleParams, ...) (*http.Response, error)

+ func (c *Client) HeadersExampleWithBody(ctx context.Context, params *HeadersExampleParams, contentType string, ...) (*http.Response, error)

+ func (c *Client) JSONExample(ctx context.Context, body JSONExampleJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) JSONExampleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) MultipartExampleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) MultipleRequestAndResponseTypes(ctx context.Context, body MultipleRequestAndResponseTypesJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) MultipleRequestAndResponseTypesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) MultipleRequestAndResponseTypesWithFormdataBody(ctx context.Context, body MultipleRequestAndResponseTypesFormdataRequestBody, ...) (*http.Response, error)

+ func (c *Client) MultipleRequestAndResponseTypesWithTextBody(ctx context.Context, body MultipleRequestAndResponseTypesTextRequestBody, ...) (*http.Response, error)

+ func (c *Client) ReusableResponses(ctx context.Context, body ReusableResponsesJSONRequestBody, ...) (*http.Response, error)

+ func (c *Client) ReusableResponsesWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) TextExampleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) TextExampleWithTextBody(ctx context.Context, body TextExampleTextRequestBody, ...) (*http.Response, error)

+ func (c *Client) URLEncodedExampleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) URLEncodedExampleWithFormdataBody(ctx context.Context, body URLEncodedExampleFormdataRequestBody, ...) (*http.Response, error)

+ func (c *Client) UnknownExampleWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) UnspecifiedContentTypeWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ type ClientInterface interface

+ HeadersExample func(ctx context.Context, params *HeadersExampleParams, ...) (*http.Response, error)

+ HeadersExampleWithBody func(ctx context.Context, params *HeadersExampleParams, contentType string, ...) (*http.Response, error)

+ JSONExample func(ctx context.Context, body JSONExampleJSONRequestBody, ...) (*http.Response, error)

+ JSONExampleWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ MultipartExampleWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ MultipleRequestAndResponseTypes func(ctx context.Context, body MultipleRequestAndResponseTypesJSONRequestBody, ...) (*http.Response, error)

+ MultipleRequestAndResponseTypesWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ MultipleRequestAndResponseTypesWithFormdataBody func(ctx context.Context, body MultipleRequestAndResponseTypesFormdataRequestBody, ...) (*http.Response, error)

+ MultipleRequestAndResponseTypesWithTextBody func(ctx context.Context, body MultipleRequestAndResponseTypesTextRequestBody, ...) (*http.Response, error)

+ ReusableResponses func(ctx context.Context, body ReusableResponsesJSONRequestBody, ...) (*http.Response, error)

+ ReusableResponsesWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ TextExampleWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ TextExampleWithTextBody func(ctx context.Context, body TextExampleTextRequestBody, ...) (*http.Response, error)

+ URLEncodedExampleWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ URLEncodedExampleWithFormdataBody func(ctx context.Context, body URLEncodedExampleFormdataRequestBody, ...) (*http.Response, error)

+ UnknownExampleWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ UnspecifiedContentTypeWithBody func(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)

+ type ClientOption func(*Client) error

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(doer HttpRequestDoer) ClientOption

+ func WithRequestEditorFn(fn RequestEditorFn) ClientOption

+ type ClientWithResponses struct

+ func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

+ func (c *ClientWithResponses) HeadersExampleWithBodyWithResponse(ctx context.Context, params *HeadersExampleParams, contentType string, ...) (*HeadersExampleResponse, error)

+ func (c *ClientWithResponses) HeadersExampleWithResponse(ctx context.Context, params *HeadersExampleParams, ...) (*HeadersExampleResponse, error)

+ func (c *ClientWithResponses) JSONExampleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*JSONExampleResponse, error)

+ func (c *ClientWithResponses) JSONExampleWithResponse(ctx context.Context, body JSONExampleJSONRequestBody, ...) (*JSONExampleResponse, error)

+ func (c *ClientWithResponses) MultipartExampleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*MultipartExampleResponse, error)

+ func (c *ClientWithResponses) MultipleRequestAndResponseTypesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ func (c *ClientWithResponses) MultipleRequestAndResponseTypesWithFormdataBodyWithResponse(ctx context.Context, body MultipleRequestAndResponseTypesFormdataRequestBody, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ func (c *ClientWithResponses) MultipleRequestAndResponseTypesWithResponse(ctx context.Context, body MultipleRequestAndResponseTypesJSONRequestBody, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ func (c *ClientWithResponses) MultipleRequestAndResponseTypesWithTextBodyWithResponse(ctx context.Context, body MultipleRequestAndResponseTypesTextRequestBody, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ func (c *ClientWithResponses) ReusableResponsesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*ReusableResponsesResponse, error)

+ func (c *ClientWithResponses) ReusableResponsesWithResponse(ctx context.Context, body ReusableResponsesJSONRequestBody, ...) (*ReusableResponsesResponse, error)

+ func (c *ClientWithResponses) TextExampleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*TextExampleResponse, error)

+ func (c *ClientWithResponses) TextExampleWithTextBodyWithResponse(ctx context.Context, body TextExampleTextRequestBody, ...) (*TextExampleResponse, error)

+ func (c *ClientWithResponses) URLEncodedExampleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*URLEncodedExampleResponse, error)

+ func (c *ClientWithResponses) URLEncodedExampleWithFormdataBodyWithResponse(ctx context.Context, body URLEncodedExampleFormdataRequestBody, ...) (*URLEncodedExampleResponse, error)

+ func (c *ClientWithResponses) UnknownExampleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UnknownExampleResponse, error)

+ func (c *ClientWithResponses) UnspecifiedContentTypeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UnspecifiedContentTypeResponse, error)

+ type ClientWithResponsesInterface interface

+ HeadersExampleWithBodyWithResponse func(ctx context.Context, params *HeadersExampleParams, contentType string, ...) (*HeadersExampleResponse, error)

+ HeadersExampleWithResponse func(ctx context.Context, params *HeadersExampleParams, ...) (*HeadersExampleResponse, error)

+ JSONExampleWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*JSONExampleResponse, error)

+ JSONExampleWithResponse func(ctx context.Context, body JSONExampleJSONRequestBody, ...) (*JSONExampleResponse, error)

+ MultipartExampleWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*MultipartExampleResponse, error)

+ MultipleRequestAndResponseTypesWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ MultipleRequestAndResponseTypesWithFormdataBodyWithResponse func(ctx context.Context, body MultipleRequestAndResponseTypesFormdataRequestBody, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ MultipleRequestAndResponseTypesWithResponse func(ctx context.Context, body MultipleRequestAndResponseTypesJSONRequestBody, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ MultipleRequestAndResponseTypesWithTextBodyWithResponse func(ctx context.Context, body MultipleRequestAndResponseTypesTextRequestBody, ...) (*MultipleRequestAndResponseTypesResponse, error)

+ ReusableResponsesWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*ReusableResponsesResponse, error)

+ ReusableResponsesWithResponse func(ctx context.Context, body ReusableResponsesJSONRequestBody, ...) (*ReusableResponsesResponse, error)

+ TextExampleWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*TextExampleResponse, error)

+ TextExampleWithTextBodyWithResponse func(ctx context.Context, body TextExampleTextRequestBody, ...) (*TextExampleResponse, error)

+ URLEncodedExampleWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*URLEncodedExampleResponse, error)

+ URLEncodedExampleWithFormdataBodyWithResponse func(ctx context.Context, body URLEncodedExampleFormdataRequestBody, ...) (*URLEncodedExampleResponse, error)

+ UnknownExampleWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*UnknownExampleResponse, error)

+ UnspecifiedContentTypeWithBodyWithResponse func(ctx context.Context, contentType string, body io.Reader, ...) (*UnspecifiedContentTypeResponse, error)

+ type Example struct

+ Value *string

+ type HeadersExampleJSONRequestBody = Example

+ type HeadersExampleParams struct

+ Header1 string

+ Header2 *int

+ type HeadersExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Example

+ func ParseHeadersExampleResponse(rsp *http.Response) (*HeadersExampleResponse, error)

+ func (r HeadersExampleResponse) Status() string

+ func (r HeadersExampleResponse) StatusCode() int

+ type HttpRequestDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type JSONExampleJSONRequestBody = Example

+ type JSONExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Example

+ func ParseJSONExampleResponse(rsp *http.Response) (*JSONExampleResponse, error)

+ func (r JSONExampleResponse) Status() string

+ func (r JSONExampleResponse) StatusCode() int

+ type MultipartExampleMultipartRequestBody = Example

+ type MultipartExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseMultipartExampleResponse(rsp *http.Response) (*MultipartExampleResponse, error)

+ func (r MultipartExampleResponse) Status() string

+ func (r MultipartExampleResponse) StatusCode() int

+ type MultipleRequestAndResponseTypesFormdataRequestBody = Example

+ type MultipleRequestAndResponseTypesJSONRequestBody = Example

+ type MultipleRequestAndResponseTypesMultipartRequestBody = Example

+ type MultipleRequestAndResponseTypesResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Example

+ func ParseMultipleRequestAndResponseTypesResponse(rsp *http.Response) (*MultipleRequestAndResponseTypesResponse, error)

+ func (r MultipleRequestAndResponseTypesResponse) Status() string

+ func (r MultipleRequestAndResponseTypesResponse) StatusCode() int

+ type MultipleRequestAndResponseTypesTextBody = string

+ type MultipleRequestAndResponseTypesTextRequestBody = MultipleRequestAndResponseTypesTextBody

+ type RequestEditorFn func(ctx context.Context, req *http.Request) error

+ type ReusableResponsesJSONRequestBody = Example

+ type ReusableResponsesResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Example

+ func ParseReusableResponsesResponse(rsp *http.Response) (*ReusableResponsesResponse, error)

+ func (r ReusableResponsesResponse) Status() string

+ func (r ReusableResponsesResponse) StatusCode() int

+ type Reusableresponse = Example

+ type TextExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseTextExampleResponse(rsp *http.Response) (*TextExampleResponse, error)

+ func (r TextExampleResponse) Status() string

+ func (r TextExampleResponse) StatusCode() int

+ type TextExampleTextBody = string

+ type TextExampleTextRequestBody = TextExampleTextBody

+ type URLEncodedExampleFormdataRequestBody = Example

+ type URLEncodedExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseURLEncodedExampleResponse(rsp *http.Response) (*URLEncodedExampleResponse, error)

+ func (r URLEncodedExampleResponse) Status() string

+ func (r URLEncodedExampleResponse) StatusCode() int

+ type UnknownExampleResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseUnknownExampleResponse(rsp *http.Response) (*UnknownExampleResponse, error)

+ func (r UnknownExampleResponse) Status() string

+ func (r UnknownExampleResponse) StatusCode() int

+ type UnspecifiedContentTypeResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ func ParseUnspecifiedContentTypeResponse(rsp *http.Response) (*UnspecifiedContentTypeResponse, error)

+ func (r UnspecifiedContentTypeResponse) Status() string

+ func (r UnspecifiedContentTypeResponse) StatusCode() int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL