api

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

Index

• type Client
  • func NewClient(serverURL string, opts ...Option) (*Client, error)
  • func (c *Client) ProbeLiveness(ctx context.Context) (res string, err error)
• type Error
  • func (s *Error) Decode(d *jx.Decoder) error
  • func (s Error) Encode(e *jx.Encoder)
  • func (s Error) MarshalJSON() ([]byte, error)
  • func (s *Error) SetFake()
  • func (s *Error) UnmarshalJSON(data []byte) error
• type ErrorHandler
• type ErrorStatusCode
  • func (s *ErrorStatusCode) Error() string
• type Handler
• type Option
  • func WithClient(client ht.Client) Option
  • func WithErrorHandler(h ErrorHandler) Option
  • func WithMeterProvider(provider metric.MeterProvider) Option
  • func WithNotFound(notFound http.HandlerFunc) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option
• type Route
  • func (r Route) Args() []string
  • func (r Route) OperationID() string
• type Server
  • func NewServer(h Handler, opts ...Option) (*Server, error)
  • func (s *Server) FindRoute(method, path string) (r Route, _ bool)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type UnimplementedHandler
  • func (UnimplementedHandler) NewError(ctx context.Context, err error) (r ErrorStatusCode)
  • func (UnimplementedHandler) ProbeLiveness(ctx context.Context) (r string, _ error)

Types

type Client

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

Client implements OAS client.

func NewClient

func NewClient(serverURL string, opts ...Option) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) ProbeLiveness

func (c *Client) ProbeLiveness(ctx context.Context) (res string, err error)

ProbeLiveness invokes probeLiveness operation.

Liveness probe for kubernetes.

GET /healthz

type Error

type Error struct {
	Code    int64  "json:\"code\""
	Message string "json:\"message\""
}

Represents error object. Ref: #/components/schemas/Error

func (*Error) Decode

func (s *Error) Decode(d *jx.Decoder) error

Decode decodes Error from json.

func (Error) Encode

func (s Error) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (Error) MarshalJSON

func (s Error) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetFake

func (s *Error) SetFake()

SetFake set fake values.

func (*Error) UnmarshalJSON

func (s *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorHandler

type ErrorHandler func(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)

ErrorHandler is error handler.

type ErrorStatusCode

type ErrorStatusCode struct {
	StatusCode int
	Response   Error
}

ErrorStatusCode wraps Error with StatusCode.

func (*ErrorStatusCode) Error

func (s *ErrorStatusCode) Error() string

type Handler

type Handler interface {
	// ProbeLiveness implements probeLiveness operation.
	//
	// Liveness probe for kubernetes.
	//
	// GET /healthz
	ProbeLiveness(ctx context.Context) (string, error)
	// NewError creates ErrorStatusCode from error returned by handler.
	//
	// Used for common default response.
	NewError(ctx context.Context, err error) ErrorStatusCode
}

Handler handles operations described by OpenAPI v3 specification.

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithClient

func WithClient(client ht.Client) Option

WithClient specifies http client to use.

func WithErrorHandler

func WithErrorHandler(h ErrorHandler) Option

WithErrorHandler specifies error handler to use.

func WithMeterProvider

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the metric.NewNoopMeterProvider is used.

func WithNotFound

func WithNotFound(notFound http.HandlerFunc) Option

WithNotFound specifies Not Found handler to use.

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type Route

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

Route is route object.

func (Route) Args

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) OperationID

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

type Server

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

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer

func NewServer(h Handler, opts ...Option) (*Server, error)

func (*Server) FindRoute

func (s *Server) FindRoute(method, path string) (r Route, _ bool)

FindRoute finds Route for given method and path.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type UnimplementedHandler

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) NewError

func (UnimplementedHandler) NewError(ctx context.Context, err error) (r ErrorStatusCode)

NewError creates ErrorStatusCode from error returned by handler.

Used for common default response.

func (UnimplementedHandler) ProbeLiveness

func (UnimplementedHandler) ProbeLiveness(ctx context.Context) (r string, _ error)

ProbeLiveness implements probeLiveness operation.

Liveness probe for kubernetes.

GET /healthz