meta

package
v0.3.8 Latest Latest
Warning

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

Go to latest
Published: Jul 29, 2026 License: Apache-2.0 Imports: 12 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 meta API

func (*Client) MetaOpenapi

func (a *Client) MetaOpenapi(params *MetaOpenapiParams, opts ...ClientOption) (*MetaOpenapiOK, error)

MetaOpenapi documenteds open API spec

Returns the customer-facing OpenAPI (Swagger 2.0) document for

func (*Client) MetaPlans

func (a *Client) MetaPlans(params *MetaPlansParams, opts ...ClientOption) (*MetaPlansOK, error)

MetaPlans plans authoring schema

Returns the JSON Schema for plans.PlanSpec, with descriptions

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService

type ClientService interface {
	MetaOpenapi(params *MetaOpenapiParams, opts ...ClientOption) (*MetaOpenapiOK, error)

	MetaPlans(params *MetaPlansParams, opts ...ClientOption) (*MetaPlansOK, 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 meta API client.

func NewClientWithBasicAuth

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new meta API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new meta API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type MetaOpenapiOK

type MetaOpenapiOK struct {
	Payload any
}

MetaOpenapiOK describes a response with status code 200, with default header values.

OpenAPI document

func NewMetaOpenapiOK

func NewMetaOpenapiOK() *MetaOpenapiOK

NewMetaOpenapiOK creates a MetaOpenapiOK with default headers values

func (*MetaOpenapiOK) Code

func (o *MetaOpenapiOK) Code() int

Code gets the status code for the meta openapi o k response

func (*MetaOpenapiOK) Error

func (o *MetaOpenapiOK) Error() string

func (*MetaOpenapiOK) GetPayload

func (o *MetaOpenapiOK) GetPayload() any

func (*MetaOpenapiOK) IsClientError

func (o *MetaOpenapiOK) IsClientError() bool

IsClientError returns true when this meta openapi o k response has a 4xx status code

func (*MetaOpenapiOK) IsCode

func (o *MetaOpenapiOK) IsCode(code int) bool

IsCode returns true when this meta openapi o k response a status code equal to that given

func (*MetaOpenapiOK) IsRedirect

func (o *MetaOpenapiOK) IsRedirect() bool

IsRedirect returns true when this meta openapi o k response has a 3xx status code

func (*MetaOpenapiOK) IsServerError

func (o *MetaOpenapiOK) IsServerError() bool

IsServerError returns true when this meta openapi o k response has a 5xx status code

func (*MetaOpenapiOK) IsSuccess

func (o *MetaOpenapiOK) IsSuccess() bool

IsSuccess returns true when this meta openapi o k response has a 2xx status code

func (*MetaOpenapiOK) String

func (o *MetaOpenapiOK) String() string

type MetaOpenapiParams

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

MetaOpenapiParams contains all the parameters to send to the API endpoint

for the meta openapi operation.

Typically these are written to a http.Request.

func NewMetaOpenapiParams

func NewMetaOpenapiParams() *MetaOpenapiParams

NewMetaOpenapiParams creates a new MetaOpenapiParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewMetaOpenapiParamsWithContext

func NewMetaOpenapiParamsWithContext(ctx context.Context) *MetaOpenapiParams

NewMetaOpenapiParamsWithContext creates a new MetaOpenapiParams object with the ability to set a context for a request.

func NewMetaOpenapiParamsWithHTTPClient

func NewMetaOpenapiParamsWithHTTPClient(client *http.Client) *MetaOpenapiParams

NewMetaOpenapiParamsWithHTTPClient creates a new MetaOpenapiParams object with the ability to set a custom HTTPClient for a request.

func NewMetaOpenapiParamsWithTimeout

func NewMetaOpenapiParamsWithTimeout(timeout time.Duration) *MetaOpenapiParams

NewMetaOpenapiParamsWithTimeout creates a new MetaOpenapiParams object with the ability to set a timeout on a request.

func (*MetaOpenapiParams) SetContext

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

SetContext adds the context to the meta openapi params

func (*MetaOpenapiParams) SetDefaults

func (o *MetaOpenapiParams) SetDefaults()

SetDefaults hydrates default values in the meta openapi params (not the query body).

All values with no default are reset to their zero value.

func (*MetaOpenapiParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the meta openapi params

func (*MetaOpenapiParams) SetTimeout

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

SetTimeout adds the timeout to the meta openapi params

func (*MetaOpenapiParams) WithContext

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

WithContext adds the context to the meta openapi params

func (*MetaOpenapiParams) WithDefaults

func (o *MetaOpenapiParams) WithDefaults() *MetaOpenapiParams

WithDefaults hydrates default values in the meta openapi params (not the query body).

All values with no default are reset to their zero value.

func (*MetaOpenapiParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the meta openapi params

func (*MetaOpenapiParams) WithTimeout

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

WithTimeout adds the timeout to the meta openapi params

func (*MetaOpenapiParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type MetaOpenapiReader

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

MetaOpenapiReader is a Reader for the MetaOpenapi structure.

func (*MetaOpenapiReader) ReadResponse

func (o *MetaOpenapiReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type MetaPlansInternalServerError

type MetaPlansInternalServerError struct {
	Payload *models.ErrorResponse
}

MetaPlansInternalServerError describes a response with status code 500, with default header values.

Internal Server Error

func NewMetaPlansInternalServerError

func NewMetaPlansInternalServerError() *MetaPlansInternalServerError

NewMetaPlansInternalServerError creates a MetaPlansInternalServerError with default headers values

func (*MetaPlansInternalServerError) Code

Code gets the status code for the meta plans internal server error response

func (*MetaPlansInternalServerError) Error

func (*MetaPlansInternalServerError) GetPayload

func (*MetaPlansInternalServerError) IsClientError

func (o *MetaPlansInternalServerError) IsClientError() bool

IsClientError returns true when this meta plans internal server error response has a 4xx status code

func (*MetaPlansInternalServerError) IsCode

func (o *MetaPlansInternalServerError) IsCode(code int) bool

IsCode returns true when this meta plans internal server error response a status code equal to that given

func (*MetaPlansInternalServerError) IsRedirect

func (o *MetaPlansInternalServerError) IsRedirect() bool

IsRedirect returns true when this meta plans internal server error response has a 3xx status code

func (*MetaPlansInternalServerError) IsServerError

func (o *MetaPlansInternalServerError) IsServerError() bool

IsServerError returns true when this meta plans internal server error response has a 5xx status code

func (*MetaPlansInternalServerError) IsSuccess

func (o *MetaPlansInternalServerError) IsSuccess() bool

IsSuccess returns true when this meta plans internal server error response has a 2xx status code

func (*MetaPlansInternalServerError) String

type MetaPlansOK

type MetaPlansOK struct {
	Payload any
}

MetaPlansOK describes a response with status code 200, with default header values.

JSON Schema for PlanSpec

func NewMetaPlansOK

func NewMetaPlansOK() *MetaPlansOK

NewMetaPlansOK creates a MetaPlansOK with default headers values

func (*MetaPlansOK) Code

func (o *MetaPlansOK) Code() int

Code gets the status code for the meta plans o k response

func (*MetaPlansOK) Error

func (o *MetaPlansOK) Error() string

func (*MetaPlansOK) GetPayload

func (o *MetaPlansOK) GetPayload() any

func (*MetaPlansOK) IsClientError

func (o *MetaPlansOK) IsClientError() bool

IsClientError returns true when this meta plans o k response has a 4xx status code

func (*MetaPlansOK) IsCode

func (o *MetaPlansOK) IsCode(code int) bool

IsCode returns true when this meta plans o k response a status code equal to that given

func (*MetaPlansOK) IsRedirect

func (o *MetaPlansOK) IsRedirect() bool

IsRedirect returns true when this meta plans o k response has a 3xx status code

func (*MetaPlansOK) IsServerError

func (o *MetaPlansOK) IsServerError() bool

IsServerError returns true when this meta plans o k response has a 5xx status code

func (*MetaPlansOK) IsSuccess

func (o *MetaPlansOK) IsSuccess() bool

IsSuccess returns true when this meta plans o k response has a 2xx status code

func (*MetaPlansOK) String

func (o *MetaPlansOK) String() string

type MetaPlansParams

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

MetaPlansParams contains all the parameters to send to the API endpoint

for the meta plans operation.

Typically these are written to a http.Request.

func NewMetaPlansParams

func NewMetaPlansParams() *MetaPlansParams

NewMetaPlansParams creates a new MetaPlansParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewMetaPlansParamsWithContext

func NewMetaPlansParamsWithContext(ctx context.Context) *MetaPlansParams

NewMetaPlansParamsWithContext creates a new MetaPlansParams object with the ability to set a context for a request.

func NewMetaPlansParamsWithHTTPClient

func NewMetaPlansParamsWithHTTPClient(client *http.Client) *MetaPlansParams

NewMetaPlansParamsWithHTTPClient creates a new MetaPlansParams object with the ability to set a custom HTTPClient for a request.

func NewMetaPlansParamsWithTimeout

func NewMetaPlansParamsWithTimeout(timeout time.Duration) *MetaPlansParams

NewMetaPlansParamsWithTimeout creates a new MetaPlansParams object with the ability to set a timeout on a request.

func (*MetaPlansParams) SetContext

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

SetContext adds the context to the meta plans params

func (*MetaPlansParams) SetDefaults

func (o *MetaPlansParams) SetDefaults()

SetDefaults hydrates default values in the meta plans params (not the query body).

All values with no default are reset to their zero value.

func (*MetaPlansParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the meta plans params

func (*MetaPlansParams) SetTimeout

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

SetTimeout adds the timeout to the meta plans params

func (*MetaPlansParams) WithContext

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

WithContext adds the context to the meta plans params

func (*MetaPlansParams) WithDefaults

func (o *MetaPlansParams) WithDefaults() *MetaPlansParams

WithDefaults hydrates default values in the meta plans params (not the query body).

All values with no default are reset to their zero value.

func (*MetaPlansParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the meta plans params

func (*MetaPlansParams) WithTimeout

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

WithTimeout adds the timeout to the meta plans params

func (*MetaPlansParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type MetaPlansReader

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

MetaPlansReader is a Reader for the MetaPlans structure.

func (*MetaPlansReader) ReadResponse

func (o *MetaPlansReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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