Documentation
¶
Index ¶
- type Client
- type OverviewOK
- type OverviewParams
- func (o *OverviewParams) SetContext(ctx context.Context)
- func (o *OverviewParams) SetHTTPClient(client *http.Client)
- func (o *OverviewParams) SetTimeout(timeout time.Duration)
- func (o *OverviewParams) WithContext(ctx context.Context) *OverviewParams
- func (o *OverviewParams) WithHTTPClient(client *http.Client) *OverviewParams
- func (o *OverviewParams) WithTimeout(timeout time.Duration) *OverviewParams
- func (o *OverviewParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type OverviewReader
- type RouteOK
- type RouteParams
- func (o *RouteParams) SetContext(ctx context.Context)
- func (o *RouteParams) SetHTTPClient(client *http.Client)
- func (o *RouteParams) SetRoute(route string)
- func (o *RouteParams) SetTimeout(timeout time.Duration)
- func (o *RouteParams) WithContext(ctx context.Context) *RouteParams
- func (o *RouteParams) WithHTTPClient(client *http.Client) *RouteParams
- func (o *RouteParams) WithRoute(route string) *RouteParams
- func (o *RouteParams) WithTimeout(timeout time.Duration) *RouteParams
- func (o *RouteParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type RouteReader
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 api docs API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new api docs API client.
func (*Client) Overview ¶
func (a *Client) Overview(params *OverviewParams, authInfo runtime.ClientAuthInfoWriter) (*OverviewOK, error)
Overview gets API documentation
func (*Client) Route ¶
func (a *Client) Route(params *RouteParams, authInfo runtime.ClientAuthInfoWriter) (*RouteOK, error)
Route gets detailed API documentation of a single resource
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type OverviewOK ¶
type OverviewOK struct {
}
OverviewOK handles this case with default header values.
No response was specified
func NewOverviewOK ¶
func NewOverviewOK() *OverviewOK
NewOverviewOK creates a OverviewOK with default headers values
func (*OverviewOK) Error ¶
func (o *OverviewOK) Error() string
type OverviewParams ¶
type OverviewParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
OverviewParams contains all the parameters to send to the API endpoint for the overview operation typically these are written to a http.Request
func NewOverviewParams ¶
func NewOverviewParams() *OverviewParams
NewOverviewParams creates a new OverviewParams object with the default values initialized.
func NewOverviewParamsWithContext ¶
func NewOverviewParamsWithContext(ctx context.Context) *OverviewParams
NewOverviewParamsWithContext creates a new OverviewParams object with the default values initialized, and the ability to set a context for a request
func NewOverviewParamsWithHTTPClient ¶
func NewOverviewParamsWithHTTPClient(client *http.Client) *OverviewParams
NewOverviewParamsWithHTTPClient creates a new OverviewParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewOverviewParamsWithTimeout ¶
func NewOverviewParamsWithTimeout(timeout time.Duration) *OverviewParams
NewOverviewParamsWithTimeout creates a new OverviewParams object with the default values initialized, and the ability to set a timeout on a request
func (*OverviewParams) SetContext ¶
func (o *OverviewParams) SetContext(ctx context.Context)
SetContext adds the context to the overview params
func (*OverviewParams) SetHTTPClient ¶
func (o *OverviewParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the overview params
func (*OverviewParams) SetTimeout ¶
func (o *OverviewParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the overview params
func (*OverviewParams) WithContext ¶
func (o *OverviewParams) WithContext(ctx context.Context) *OverviewParams
WithContext adds the context to the overview params
func (*OverviewParams) WithHTTPClient ¶
func (o *OverviewParams) WithHTTPClient(client *http.Client) *OverviewParams
WithHTTPClient adds the HTTPClient to the overview params
func (*OverviewParams) WithTimeout ¶
func (o *OverviewParams) WithTimeout(timeout time.Duration) *OverviewParams
WithTimeout adds the timeout to the overview params
func (*OverviewParams) WriteToRequest ¶
func (o *OverviewParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type OverviewReader ¶
type OverviewReader struct {
// contains filtered or unexported fields
}
OverviewReader is a Reader for the Overview structure.
func (*OverviewReader) ReadResponse ¶
func (o *OverviewReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type RouteOK ¶
type RouteOK struct {
}
RouteOK handles this case with default header values.
No response was specified
func NewRouteOK ¶
func NewRouteOK() *RouteOK
NewRouteOK creates a RouteOK with default headers values
type RouteParams ¶
type RouteParams struct {
/*Route
Route to fetch. For example /system
*/
Route string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
RouteParams contains all the parameters to send to the API endpoint for the route operation typically these are written to a http.Request
func NewRouteParams ¶
func NewRouteParams() *RouteParams
NewRouteParams creates a new RouteParams object with the default values initialized.
func NewRouteParamsWithContext ¶
func NewRouteParamsWithContext(ctx context.Context) *RouteParams
NewRouteParamsWithContext creates a new RouteParams object with the default values initialized, and the ability to set a context for a request
func NewRouteParamsWithHTTPClient ¶
func NewRouteParamsWithHTTPClient(client *http.Client) *RouteParams
NewRouteParamsWithHTTPClient creates a new RouteParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewRouteParamsWithTimeout ¶
func NewRouteParamsWithTimeout(timeout time.Duration) *RouteParams
NewRouteParamsWithTimeout creates a new RouteParams object with the default values initialized, and the ability to set a timeout on a request
func (*RouteParams) SetContext ¶
func (o *RouteParams) SetContext(ctx context.Context)
SetContext adds the context to the route params
func (*RouteParams) SetHTTPClient ¶
func (o *RouteParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the route params
func (*RouteParams) SetRoute ¶
func (o *RouteParams) SetRoute(route string)
SetRoute adds the route to the route params
func (*RouteParams) SetTimeout ¶
func (o *RouteParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the route params
func (*RouteParams) WithContext ¶
func (o *RouteParams) WithContext(ctx context.Context) *RouteParams
WithContext adds the context to the route params
func (*RouteParams) WithHTTPClient ¶
func (o *RouteParams) WithHTTPClient(client *http.Client) *RouteParams
WithHTTPClient adds the HTTPClient to the route params
func (*RouteParams) WithRoute ¶
func (o *RouteParams) WithRoute(route string) *RouteParams
WithRoute adds the route to the route params
func (*RouteParams) WithTimeout ¶
func (o *RouteParams) WithTimeout(timeout time.Duration) *RouteParams
WithTimeout adds the timeout to the route params
func (*RouteParams) WriteToRequest ¶
func (o *RouteParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type RouteReader ¶
type RouteReader struct {
// contains filtered or unexported fields
}
RouteReader is a Reader for the Route structure.
func (*RouteReader) ReadResponse ¶
func (o *RouteReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files