Documentation
¶
Index ¶
- type Client
- type ClientService
- type GetDocumentationOK
- type GetDocumentationParams
- func NewGetDocumentationParams() *GetDocumentationParams
- func NewGetDocumentationParamsWithContext(ctx context.Context) *GetDocumentationParams
- func NewGetDocumentationParamsWithHTTPClient(client *http.Client) *GetDocumentationParams
- func NewGetDocumentationParamsWithTimeout(timeout time.Duration) *GetDocumentationParams
- func (o *GetDocumentationParams) SetContext(ctx context.Context)
- func (o *GetDocumentationParams) SetHTTPClient(client *http.Client)
- func (o *GetDocumentationParams) SetTimeout(timeout time.Duration)
- func (o *GetDocumentationParams) WithContext(ctx context.Context) *GetDocumentationParams
- func (o *GetDocumentationParams) WithHTTPClient(client *http.Client) *GetDocumentationParams
- func (o *GetDocumentationParams) WithTimeout(timeout time.Duration) *GetDocumentationParams
- func (o *GetDocumentationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetDocumentationReader
- type GetSwaggerNotFound
- type GetSwaggerOK
- type GetSwaggerParams
- func (o *GetSwaggerParams) SetContext(ctx context.Context)
- func (o *GetSwaggerParams) SetHTTPClient(client *http.Client)
- func (o *GetSwaggerParams) SetTimeout(timeout time.Duration)
- func (o *GetSwaggerParams) WithContext(ctx context.Context) *GetSwaggerParams
- func (o *GetSwaggerParams) WithHTTPClient(client *http.Client) *GetSwaggerParams
- func (o *GetSwaggerParams) WithTimeout(timeout time.Duration) *GetSwaggerParams
- func (o *GetSwaggerParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetSwaggerReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for utilities API
func (*Client) GetDocumentation ¶
func (a *Client) GetDocumentation(params *GetDocumentationParams) (*GetDocumentationOK, error)
GetDocumentation Returns a HTML and JS page with this documentation<br>
NOTE: This page was auto-generated by ReDoc (https://github.com/Redocly/redoc)
func (*Client) GetSwagger ¶
func (a *Client) GetSwagger(params *GetSwaggerParams) (*GetSwaggerOK, error)
GetSwagger Returns swagger.yaml configuration file needed for generating this documentation<br>
NOTE: This file should be located in resources directory
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface {
GetDocumentation(params *GetDocumentationParams) (*GetDocumentationOK, error)
GetSwagger(params *GetSwaggerParams) (*GetSwaggerOK, error)
SetTransport(transport runtime.ClientTransport)
}
ClientService is the interface for Client methods
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
New creates a new utilities API client.
type GetDocumentationOK ¶
type GetDocumentationOK struct {
}
GetDocumentationOK handles this case with default header values.
Response with a HTML documentation file in body
func NewGetDocumentationOK ¶
func NewGetDocumentationOK() *GetDocumentationOK
NewGetDocumentationOK creates a GetDocumentationOK with default headers values
func (*GetDocumentationOK) Error ¶
func (o *GetDocumentationOK) Error() string
type GetDocumentationParams ¶
type GetDocumentationParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetDocumentationParams contains all the parameters to send to the API endpoint for the get documentation operation typically these are written to a http.Request
func NewGetDocumentationParams ¶
func NewGetDocumentationParams() *GetDocumentationParams
NewGetDocumentationParams creates a new GetDocumentationParams object with the default values initialized.
func NewGetDocumentationParamsWithContext ¶
func NewGetDocumentationParamsWithContext(ctx context.Context) *GetDocumentationParams
NewGetDocumentationParamsWithContext creates a new GetDocumentationParams object with the default values initialized, and the ability to set a context for a request
func NewGetDocumentationParamsWithHTTPClient ¶
func NewGetDocumentationParamsWithHTTPClient(client *http.Client) *GetDocumentationParams
NewGetDocumentationParamsWithHTTPClient creates a new GetDocumentationParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetDocumentationParamsWithTimeout ¶
func NewGetDocumentationParamsWithTimeout(timeout time.Duration) *GetDocumentationParams
NewGetDocumentationParamsWithTimeout creates a new GetDocumentationParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetDocumentationParams) SetContext ¶
func (o *GetDocumentationParams) SetContext(ctx context.Context)
SetContext adds the context to the get documentation params
func (*GetDocumentationParams) SetHTTPClient ¶
func (o *GetDocumentationParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get documentation params
func (*GetDocumentationParams) SetTimeout ¶
func (o *GetDocumentationParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get documentation params
func (*GetDocumentationParams) WithContext ¶
func (o *GetDocumentationParams) WithContext(ctx context.Context) *GetDocumentationParams
WithContext adds the context to the get documentation params
func (*GetDocumentationParams) WithHTTPClient ¶
func (o *GetDocumentationParams) WithHTTPClient(client *http.Client) *GetDocumentationParams
WithHTTPClient adds the HTTPClient to the get documentation params
func (*GetDocumentationParams) WithTimeout ¶
func (o *GetDocumentationParams) WithTimeout(timeout time.Duration) *GetDocumentationParams
WithTimeout adds the timeout to the get documentation params
func (*GetDocumentationParams) WriteToRequest ¶
func (o *GetDocumentationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetDocumentationReader ¶
type GetDocumentationReader struct {
// contains filtered or unexported fields
}
GetDocumentationReader is a Reader for the GetDocumentation structure.
func (*GetDocumentationReader) ReadResponse ¶
func (o *GetDocumentationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetSwaggerNotFound ¶
type GetSwaggerNotFound struct {
}
GetSwaggerNotFound handles this case with default header values.
Error with no specific content returned when no swagger.yaml is found
func NewGetSwaggerNotFound ¶
func NewGetSwaggerNotFound() *GetSwaggerNotFound
NewGetSwaggerNotFound creates a GetSwaggerNotFound with default headers values
func (*GetSwaggerNotFound) Error ¶
func (o *GetSwaggerNotFound) Error() string
type GetSwaggerOK ¶
type GetSwaggerOK struct {
}
GetSwaggerOK handles this case with default header values.
Response with a YAML swagger configuration file in body
func NewGetSwaggerOK ¶
func NewGetSwaggerOK() *GetSwaggerOK
NewGetSwaggerOK creates a GetSwaggerOK with default headers values
func (*GetSwaggerOK) Error ¶
func (o *GetSwaggerOK) Error() string
type GetSwaggerParams ¶
type GetSwaggerParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetSwaggerParams contains all the parameters to send to the API endpoint for the get swagger operation typically these are written to a http.Request
func NewGetSwaggerParams ¶
func NewGetSwaggerParams() *GetSwaggerParams
NewGetSwaggerParams creates a new GetSwaggerParams object with the default values initialized.
func NewGetSwaggerParamsWithContext ¶
func NewGetSwaggerParamsWithContext(ctx context.Context) *GetSwaggerParams
NewGetSwaggerParamsWithContext creates a new GetSwaggerParams object with the default values initialized, and the ability to set a context for a request
func NewGetSwaggerParamsWithHTTPClient ¶
func NewGetSwaggerParamsWithHTTPClient(client *http.Client) *GetSwaggerParams
NewGetSwaggerParamsWithHTTPClient creates a new GetSwaggerParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetSwaggerParamsWithTimeout ¶
func NewGetSwaggerParamsWithTimeout(timeout time.Duration) *GetSwaggerParams
NewGetSwaggerParamsWithTimeout creates a new GetSwaggerParams object with the default values initialized, and the ability to set a timeout on a request
func (*GetSwaggerParams) SetContext ¶
func (o *GetSwaggerParams) SetContext(ctx context.Context)
SetContext adds the context to the get swagger params
func (*GetSwaggerParams) SetHTTPClient ¶
func (o *GetSwaggerParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get swagger params
func (*GetSwaggerParams) SetTimeout ¶
func (o *GetSwaggerParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get swagger params
func (*GetSwaggerParams) WithContext ¶
func (o *GetSwaggerParams) WithContext(ctx context.Context) *GetSwaggerParams
WithContext adds the context to the get swagger params
func (*GetSwaggerParams) WithHTTPClient ¶
func (o *GetSwaggerParams) WithHTTPClient(client *http.Client) *GetSwaggerParams
WithHTTPClient adds the HTTPClient to the get swagger params
func (*GetSwaggerParams) WithTimeout ¶
func (o *GetSwaggerParams) WithTimeout(timeout time.Duration) *GetSwaggerParams
WithTimeout adds the timeout to the get swagger params
func (*GetSwaggerParams) WriteToRequest ¶
func (o *GetSwaggerParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetSwaggerReader ¶
type GetSwaggerReader struct {
// contains filtered or unexported fields
}
GetSwaggerReader is a Reader for the GetSwagger structure.
func (*GetSwaggerReader) ReadResponse ¶
func (o *GetSwaggerReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files