informational

package
v0.16.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

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 informational API

func (*Client) DetailSpec 

func (a *Client) DetailSpec(params *DetailSpecParams) (*DetailSpecOK, error)

DetailSpec returns a single spec resource

Returns single spec resource embedded within the controller for consumption/documentation/code geneartion

func (*Client) DetailSpecBody 

func (a *Client) DetailSpecBody(params *DetailSpecBodyParams) (*DetailSpecBodyOK, error)

DetailSpecBody returns the spec s file

Return the body of the specification (i.e. Swagger, OpenAPI 2.0, 3.0, etc).

func (*Client) ListRoot 

func (a *Client) ListRoot(params *ListRootParams) (*ListRootOK, error)

ListRoot returns version information

func (*Client) ListSpecs 

func (a *Client) ListSpecs(params *ListSpecsParams) (*ListSpecsOK, error)

ListSpecs returns a list of API specs

Returns a list of spec files embedded within the controller for consumption/documentation/code geneartion

func (*Client) ListSummary 

func (a *Client) ListSummary(params *ListSummaryParams, authInfo runtime.ClientAuthInfoWriter) (*ListSummaryOK, error)

ListSummary returns a list of accessible resource counts

This endpoint is usefull for UIs that wish to display UI elements with counts.

func (*Client) ListVersion 

func (a *Client) ListVersion(params *ListVersionParams) (*ListVersionOK, error)

ListVersion returns version information

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService 

type ClientService interface {
	DetailSpec(params *DetailSpecParams) (*DetailSpecOK, error)

	DetailSpecBody(params *DetailSpecBodyParams) (*DetailSpecBodyOK, error)

	ListRoot(params *ListRootParams) (*ListRootOK, error)

	ListSpecs(params *ListSpecsParams) (*ListSpecsOK, error)

	ListSummary(params *ListSummaryParams, authInfo runtime.ClientAuthInfoWriter) (*ListSummaryOK, error)

	ListVersion(params *ListVersionParams) (*ListVersionOK, 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 informational API client.

type DetailSpecBodyOK 

type DetailSpecBodyOK struct {
	Payload *rest_model.DetailSpecBodyEnvelope
}

DetailSpecBodyOK handles this case with default header values.

Returns the document that represents the specification

func NewDetailSpecBodyOK 

func NewDetailSpecBodyOK() *DetailSpecBodyOK

NewDetailSpecBodyOK creates a DetailSpecBodyOK with default headers values

func (*DetailSpecBodyOK) Error 

func (o *DetailSpecBodyOK) Error() string

func (*DetailSpecBodyOK) GetPayload 

func (o *DetailSpecBodyOK) GetPayload() *rest_model.DetailSpecBodyEnvelope

type DetailSpecBodyParams 

type DetailSpecBodyParams struct {

	/*ID
	  The id of the requested resource

	*/
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DetailSpecBodyParams contains all the parameters to send to the API endpoint for the detail spec body operation typically these are written to a http.Request

func NewDetailSpecBodyParams 

func NewDetailSpecBodyParams() *DetailSpecBodyParams

NewDetailSpecBodyParams creates a new DetailSpecBodyParams object with the default values initialized.

func NewDetailSpecBodyParamsWithContext 

func NewDetailSpecBodyParamsWithContext(ctx context.Context) *DetailSpecBodyParams

NewDetailSpecBodyParamsWithContext creates a new DetailSpecBodyParams object with the default values initialized, and the ability to set a context for a request

func NewDetailSpecBodyParamsWithHTTPClient 

func NewDetailSpecBodyParamsWithHTTPClient(client *http.Client) *DetailSpecBodyParams

NewDetailSpecBodyParamsWithHTTPClient creates a new DetailSpecBodyParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewDetailSpecBodyParamsWithTimeout 

func NewDetailSpecBodyParamsWithTimeout(timeout time.Duration) *DetailSpecBodyParams

NewDetailSpecBodyParamsWithTimeout creates a new DetailSpecBodyParams object with the default values initialized, and the ability to set a timeout on a request

func (*DetailSpecBodyParams) SetContext 

func (o *DetailSpecBodyParams) SetContext(ctx context.Context)

SetContext adds the context to the detail spec body params

func (*DetailSpecBodyParams) SetHTTPClient 

func (o *DetailSpecBodyParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the detail spec body params

func (*DetailSpecBodyParams) SetID 

func (o *DetailSpecBodyParams) SetID(id string)

SetID adds the id to the detail spec body params

func (*DetailSpecBodyParams) SetTimeout 

func (o *DetailSpecBodyParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the detail spec body params

func (*DetailSpecBodyParams) WithContext 

func (o *DetailSpecBodyParams) WithContext(ctx context.Context) *DetailSpecBodyParams

WithContext adds the context to the detail spec body params

func (*DetailSpecBodyParams) WithHTTPClient 

func (o *DetailSpecBodyParams) WithHTTPClient(client *http.Client) *DetailSpecBodyParams

WithHTTPClient adds the HTTPClient to the detail spec body params

func (*DetailSpecBodyParams) WithID 

func (o *DetailSpecBodyParams) WithID(id string) *DetailSpecBodyParams

WithID adds the id to the detail spec body params

func (*DetailSpecBodyParams) WithTimeout 

func (o *DetailSpecBodyParams) WithTimeout(timeout time.Duration) *DetailSpecBodyParams

WithTimeout adds the timeout to the detail spec body params

func (*DetailSpecBodyParams) WriteToRequest 

func (o *DetailSpecBodyParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DetailSpecBodyReader 

type DetailSpecBodyReader struct {
	// contains filtered or unexported fields
}

DetailSpecBodyReader is a Reader for the DetailSpecBody structure.

func (*DetailSpecBodyReader) ReadResponse 

func (o *DetailSpecBodyReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DetailSpecOK 

type DetailSpecOK struct {
	Payload *rest_model.DetailSpecEnvelope
}

DetailSpecOK handles this case with default header values.

A single specification

func NewDetailSpecOK 

func NewDetailSpecOK() *DetailSpecOK

NewDetailSpecOK creates a DetailSpecOK with default headers values

func (*DetailSpecOK) Error 

func (o *DetailSpecOK) Error() string

func (*DetailSpecOK) GetPayload 

func (o *DetailSpecOK) GetPayload() *rest_model.DetailSpecEnvelope

type DetailSpecParams 

type DetailSpecParams struct {

	/*ID
	  The id of the requested resource

	*/
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DetailSpecParams contains all the parameters to send to the API endpoint for the detail spec operation typically these are written to a http.Request

func NewDetailSpecParams 

func NewDetailSpecParams() *DetailSpecParams

NewDetailSpecParams creates a new DetailSpecParams object with the default values initialized.

func NewDetailSpecParamsWithContext 

func NewDetailSpecParamsWithContext(ctx context.Context) *DetailSpecParams

NewDetailSpecParamsWithContext creates a new DetailSpecParams object with the default values initialized, and the ability to set a context for a request

func NewDetailSpecParamsWithHTTPClient 

func NewDetailSpecParamsWithHTTPClient(client *http.Client) *DetailSpecParams

NewDetailSpecParamsWithHTTPClient creates a new DetailSpecParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewDetailSpecParamsWithTimeout 

func NewDetailSpecParamsWithTimeout(timeout time.Duration) *DetailSpecParams

NewDetailSpecParamsWithTimeout creates a new DetailSpecParams object with the default values initialized, and the ability to set a timeout on a request

func (*DetailSpecParams) SetContext 

func (o *DetailSpecParams) SetContext(ctx context.Context)

SetContext adds the context to the detail spec params

func (*DetailSpecParams) SetHTTPClient 

func (o *DetailSpecParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the detail spec params

func (*DetailSpecParams) SetID 

func (o *DetailSpecParams) SetID(id string)

SetID adds the id to the detail spec params

func (*DetailSpecParams) SetTimeout 

func (o *DetailSpecParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the detail spec params

func (*DetailSpecParams) WithContext 

func (o *DetailSpecParams) WithContext(ctx context.Context) *DetailSpecParams

WithContext adds the context to the detail spec params

func (*DetailSpecParams) WithHTTPClient 

func (o *DetailSpecParams) WithHTTPClient(client *http.Client) *DetailSpecParams

WithHTTPClient adds the HTTPClient to the detail spec params

func (*DetailSpecParams) WithID 

func (o *DetailSpecParams) WithID(id string) *DetailSpecParams

WithID adds the id to the detail spec params

func (*DetailSpecParams) WithTimeout 

func (o *DetailSpecParams) WithTimeout(timeout time.Duration) *DetailSpecParams

WithTimeout adds the timeout to the detail spec params

func (*DetailSpecParams) WriteToRequest 

func (o *DetailSpecParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DetailSpecReader 

type DetailSpecReader struct {
	// contains filtered or unexported fields
}

DetailSpecReader is a Reader for the DetailSpec structure.

func (*DetailSpecReader) ReadResponse 

func (o *DetailSpecReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListRootOK 

type ListRootOK struct {
	Payload *rest_model.ListVersionEnvelope
}

ListRootOK handles this case with default header values.

Version information for the controller

func NewListRootOK 

func NewListRootOK() *ListRootOK

NewListRootOK creates a ListRootOK with default headers values

func (*ListRootOK) Error 

func (o *ListRootOK) Error() string

func (*ListRootOK) GetPayload 

func (o *ListRootOK) GetPayload() *rest_model.ListVersionEnvelope

type ListRootParams 

type ListRootParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListRootParams contains all the parameters to send to the API endpoint for the list root operation typically these are written to a http.Request

func NewListRootParams 

func NewListRootParams() *ListRootParams

NewListRootParams creates a new ListRootParams object with the default values initialized.

func NewListRootParamsWithContext 

func NewListRootParamsWithContext(ctx context.Context) *ListRootParams

NewListRootParamsWithContext creates a new ListRootParams object with the default values initialized, and the ability to set a context for a request

func NewListRootParamsWithHTTPClient 

func NewListRootParamsWithHTTPClient(client *http.Client) *ListRootParams

NewListRootParamsWithHTTPClient creates a new ListRootParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListRootParamsWithTimeout 

func NewListRootParamsWithTimeout(timeout time.Duration) *ListRootParams

NewListRootParamsWithTimeout creates a new ListRootParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListRootParams) SetContext 

func (o *ListRootParams) SetContext(ctx context.Context)

SetContext adds the context to the list root params

func (*ListRootParams) SetHTTPClient 

func (o *ListRootParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list root params

func (*ListRootParams) SetTimeout 

func (o *ListRootParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list root params

func (*ListRootParams) WithContext 

func (o *ListRootParams) WithContext(ctx context.Context) *ListRootParams

WithContext adds the context to the list root params

func (*ListRootParams) WithHTTPClient 

func (o *ListRootParams) WithHTTPClient(client *http.Client) *ListRootParams

WithHTTPClient adds the HTTPClient to the list root params

func (*ListRootParams) WithTimeout 

func (o *ListRootParams) WithTimeout(timeout time.Duration) *ListRootParams

WithTimeout adds the timeout to the list root params

func (*ListRootParams) WriteToRequest 

func (o *ListRootParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListRootReader 

type ListRootReader struct {
	// contains filtered or unexported fields
}

ListRootReader is a Reader for the ListRoot structure.

func (*ListRootReader) ReadResponse 

func (o *ListRootReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListSpecsOK 

type ListSpecsOK struct {
	Payload *rest_model.ListSpecsEnvelope
}

ListSpecsOK handles this case with default header values.

A list of specifications

func NewListSpecsOK 

func NewListSpecsOK() *ListSpecsOK

NewListSpecsOK creates a ListSpecsOK with default headers values

func (*ListSpecsOK) Error 

func (o *ListSpecsOK) Error() string

func (*ListSpecsOK) GetPayload 

func (o *ListSpecsOK) GetPayload() *rest_model.ListSpecsEnvelope

type ListSpecsParams 

type ListSpecsParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListSpecsParams contains all the parameters to send to the API endpoint for the list specs operation typically these are written to a http.Request

func NewListSpecsParams 

func NewListSpecsParams() *ListSpecsParams

NewListSpecsParams creates a new ListSpecsParams object with the default values initialized.

func NewListSpecsParamsWithContext 

func NewListSpecsParamsWithContext(ctx context.Context) *ListSpecsParams

NewListSpecsParamsWithContext creates a new ListSpecsParams object with the default values initialized, and the ability to set a context for a request

func NewListSpecsParamsWithHTTPClient 

func NewListSpecsParamsWithHTTPClient(client *http.Client) *ListSpecsParams

NewListSpecsParamsWithHTTPClient creates a new ListSpecsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListSpecsParamsWithTimeout 

func NewListSpecsParamsWithTimeout(timeout time.Duration) *ListSpecsParams

NewListSpecsParamsWithTimeout creates a new ListSpecsParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListSpecsParams) SetContext 

func (o *ListSpecsParams) SetContext(ctx context.Context)

SetContext adds the context to the list specs params

func (*ListSpecsParams) SetHTTPClient 

func (o *ListSpecsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list specs params

func (*ListSpecsParams) SetTimeout 

func (o *ListSpecsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list specs params

func (*ListSpecsParams) WithContext 

func (o *ListSpecsParams) WithContext(ctx context.Context) *ListSpecsParams

WithContext adds the context to the list specs params

func (*ListSpecsParams) WithHTTPClient 

func (o *ListSpecsParams) WithHTTPClient(client *http.Client) *ListSpecsParams

WithHTTPClient adds the HTTPClient to the list specs params

func (*ListSpecsParams) WithTimeout 

func (o *ListSpecsParams) WithTimeout(timeout time.Duration) *ListSpecsParams

WithTimeout adds the timeout to the list specs params

func (*ListSpecsParams) WriteToRequest 

func (o *ListSpecsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListSpecsReader 

type ListSpecsReader struct {
	// contains filtered or unexported fields
}

ListSpecsReader is a Reader for the ListSpecs structure.

func (*ListSpecsReader) ReadResponse 

func (o *ListSpecsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListSummaryOK 

type ListSummaryOK struct {
	Payload *rest_model.ListSummaryCountsEnvelope
}

ListSummaryOK handles this case with default header values.

Entity counts scopped to the current identitie's access

func NewListSummaryOK 

func NewListSummaryOK() *ListSummaryOK

NewListSummaryOK creates a ListSummaryOK with default headers values

func (*ListSummaryOK) Error 

func (o *ListSummaryOK) Error() string

func (*ListSummaryOK) GetPayload 

func (o *ListSummaryOK) GetPayload() *rest_model.ListSummaryCountsEnvelope

type ListSummaryParams 

type ListSummaryParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListSummaryParams contains all the parameters to send to the API endpoint for the list summary operation typically these are written to a http.Request

func NewListSummaryParams 

func NewListSummaryParams() *ListSummaryParams

NewListSummaryParams creates a new ListSummaryParams object with the default values initialized.

func NewListSummaryParamsWithContext 

func NewListSummaryParamsWithContext(ctx context.Context) *ListSummaryParams

NewListSummaryParamsWithContext creates a new ListSummaryParams object with the default values initialized, and the ability to set a context for a request

func NewListSummaryParamsWithHTTPClient 

func NewListSummaryParamsWithHTTPClient(client *http.Client) *ListSummaryParams

NewListSummaryParamsWithHTTPClient creates a new ListSummaryParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListSummaryParamsWithTimeout 

func NewListSummaryParamsWithTimeout(timeout time.Duration) *ListSummaryParams

NewListSummaryParamsWithTimeout creates a new ListSummaryParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListSummaryParams) SetContext 

func (o *ListSummaryParams) SetContext(ctx context.Context)

SetContext adds the context to the list summary params

func (*ListSummaryParams) SetHTTPClient 

func (o *ListSummaryParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list summary params

func (*ListSummaryParams) SetTimeout 

func (o *ListSummaryParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list summary params

func (*ListSummaryParams) WithContext 

func (o *ListSummaryParams) WithContext(ctx context.Context) *ListSummaryParams

WithContext adds the context to the list summary params

func (*ListSummaryParams) WithHTTPClient 

func (o *ListSummaryParams) WithHTTPClient(client *http.Client) *ListSummaryParams

WithHTTPClient adds the HTTPClient to the list summary params

func (*ListSummaryParams) WithTimeout 

func (o *ListSummaryParams) WithTimeout(timeout time.Duration) *ListSummaryParams

WithTimeout adds the timeout to the list summary params

func (*ListSummaryParams) WriteToRequest 

func (o *ListSummaryParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListSummaryReader 

type ListSummaryReader struct {
	// contains filtered or unexported fields
}

ListSummaryReader is a Reader for the ListSummary structure.

func (*ListSummaryReader) ReadResponse 

func (o *ListSummaryReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListSummaryUnauthorized 

type ListSummaryUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}

ListSummaryUnauthorized handles this case with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewListSummaryUnauthorized 

func NewListSummaryUnauthorized() *ListSummaryUnauthorized

NewListSummaryUnauthorized creates a ListSummaryUnauthorized with default headers values

func (*ListSummaryUnauthorized) Error 

func (o *ListSummaryUnauthorized) Error() string

func (*ListSummaryUnauthorized) GetPayload 

func (o *ListSummaryUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

type ListVersionOK 

type ListVersionOK struct {
	Payload *rest_model.ListVersionEnvelope
}

ListVersionOK handles this case with default header values.

Version information for the controller

func NewListVersionOK 

func NewListVersionOK() *ListVersionOK

NewListVersionOK creates a ListVersionOK with default headers values

func (*ListVersionOK) Error 

func (o *ListVersionOK) Error() string

func (*ListVersionOK) GetPayload 

func (o *ListVersionOK) GetPayload() *rest_model.ListVersionEnvelope

type ListVersionParams 

type ListVersionParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListVersionParams contains all the parameters to send to the API endpoint for the list version operation typically these are written to a http.Request

func NewListVersionParams 

func NewListVersionParams() *ListVersionParams

NewListVersionParams creates a new ListVersionParams object with the default values initialized.

func NewListVersionParamsWithContext 

func NewListVersionParamsWithContext(ctx context.Context) *ListVersionParams

NewListVersionParamsWithContext creates a new ListVersionParams object with the default values initialized, and the ability to set a context for a request

func NewListVersionParamsWithHTTPClient 

func NewListVersionParamsWithHTTPClient(client *http.Client) *ListVersionParams

NewListVersionParamsWithHTTPClient creates a new ListVersionParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListVersionParamsWithTimeout 

func NewListVersionParamsWithTimeout(timeout time.Duration) *ListVersionParams

NewListVersionParamsWithTimeout creates a new ListVersionParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListVersionParams) SetContext 

func (o *ListVersionParams) SetContext(ctx context.Context)

SetContext adds the context to the list version params

func (*ListVersionParams) SetHTTPClient 

func (o *ListVersionParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list version params

func (*ListVersionParams) SetTimeout 

func (o *ListVersionParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list version params

func (*ListVersionParams) WithContext 

func (o *ListVersionParams) WithContext(ctx context.Context) *ListVersionParams

WithContext adds the context to the list version params

func (*ListVersionParams) WithHTTPClient 

func (o *ListVersionParams) WithHTTPClient(client *http.Client) *ListVersionParams

WithHTTPClient adds the HTTPClient to the list version params

func (*ListVersionParams) WithTimeout 

func (o *ListVersionParams) WithTimeout(timeout time.Duration) *ListVersionParams

WithTimeout adds the timeout to the list version params

func (*ListVersionParams) WriteToRequest 

func (o *ListVersionParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListVersionReader 

type ListVersionReader struct {
	// contains filtered or unexported fields
}

ListVersionReader is a Reader for the ListVersion structure.

func (*ListVersionReader) ReadResponse 

func (o *ListVersionReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.