api

package
v0.0.0-...-6511f77 Latest Latest
Warning

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

Go to latest
Published: May 18, 2024 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type Client

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

Client implements OAS client.

func NewClient

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

NewClient initializes new Client defined by OAS.

func (*Client) Health

func (c *Client) Health(ctx context.Context) (HealthRes, error)

Health invokes health operation.

Health Check.

GET /health

func (*Client) ListCluster

func (c *Client) ListCluster(ctx context.Context) (ListClusterRes, error)

ListCluster invokes listCluster operation.

List Clusters.

GET /clusters

type ClientOption

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

ClientOption is client config option.

func WithClient

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type Cluster

type Cluster struct {
	ID       string `json:"id"`
	RpcAddr  string `json:"rpcAddr"`
	IsLeader bool   `json:"isLeader"`
}

Ref: #/components/schemas/Cluster

func (*Cluster) Decode

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

Decode decodes Cluster from json.

func (*Cluster) Encode

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

Encode implements json.Marshaler.

func (*Cluster) GetID

func (s *Cluster) GetID() string

GetID returns the value of ID.

func (*Cluster) GetIsLeader

func (s *Cluster) GetIsLeader() bool

GetIsLeader returns the value of IsLeader.

func (*Cluster) GetRpcAddr

func (s *Cluster) GetRpcAddr() string

GetRpcAddr returns the value of RpcAddr.

func (*Cluster) MarshalJSON

func (s *Cluster) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Cluster) SetID

func (s *Cluster) SetID(val string)

SetID sets the value of ID.

func (*Cluster) SetIsLeader

func (s *Cluster) SetIsLeader(val bool)

SetIsLeader sets the value of IsLeader.

func (*Cluster) SetRpcAddr

func (s *Cluster) SetRpcAddr(val string)

SetRpcAddr sets the value of RpcAddr.

func (*Cluster) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Clusters

type Clusters []Cluster

func (*Clusters) Decode

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

Decode decodes Clusters from json.

func (Clusters) Encode

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

Encode encodes Clusters as json.

func (Clusters) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*Clusters) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorHandler

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler

type Handler interface {
	// Health implements health operation.
	//
	// Health Check.
	//
	// GET /health
	Health(ctx context.Context) (HealthRes, error)
	// ListCluster implements listCluster operation.
	//
	// List Clusters.
	//
	// GET /clusters
	ListCluster(ctx context.Context) (ListClusterRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type HealthInternalServerError

type HealthInternalServerError struct{}

HealthInternalServerError is response for Health operation.

type HealthOK

type HealthOK struct{}

HealthOK is response for Health operation.

type HealthRes

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

type Invoker

type Invoker interface {
	// Health invokes health operation.
	//
	// Health Check.
	//
	// GET /health
	Health(ctx context.Context) (HealthRes, error)
	// ListCluster invokes listCluster operation.
	//
	// List Clusters.
	//
	// GET /clusters
	ListCluster(ctx context.Context) (ListClusterRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler

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

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext

func LabelerFromContext(ctx context.Context) (*Labeler, bool)

LabelerFromContext retrieves the Labeler from the provided context, if present.

If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

func (*Labeler) Add

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet

func (l *Labeler) AttributeSet() attribute.Set

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type ListClusterBadRequest

type ListClusterBadRequest struct{}

ListClusterBadRequest is response for ListCluster operation.

type ListClusterInternalServerError

type ListClusterInternalServerError struct{}

ListClusterInternalServerError is response for ListCluster operation.

type ListClusterNotFound

type ListClusterNotFound struct{}

ListClusterNotFound is response for ListCluster operation.

type ListClusterRes

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

type ListClusterResponse

type ListClusterResponse struct {
	Clusters Clusters `json:"clusters"`
}

Ref: #/components/schemas/ListClusterResponse

func (*ListClusterResponse) Decode

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

Decode decodes ListClusterResponse from json.

func (*ListClusterResponse) Encode

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

Encode implements json.Marshaler.

func (*ListClusterResponse) GetClusters

func (s *ListClusterResponse) GetClusters() Clusters

GetClusters returns the value of Clusters.

func (*ListClusterResponse) MarshalJSON

func (s *ListClusterResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListClusterResponse) SetClusters

func (s *ListClusterResponse) SetClusters(val Clusters)

SetClusters sets the value of Clusters.

func (*ListClusterResponse) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Middleware

type Middleware = middleware.Middleware

Middleware is middleware type.

type Option

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithMeterProvider

func WithMeterProvider(provider metric.MeterProvider) Option

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

If none is specified, the otel.GetMeterProvider() is used.

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) Name

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary

func (r Route) Summary() string

Summary returns OpenAPI summary.

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 ...ServerOption) (*Server, error)

NewServer creates new Server.

func (*Server) FindPath

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute

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

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

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 ServerOption

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

ServerOption is server config option.

func WithErrorHandler

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type UnimplementedHandler

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) Health

func (UnimplementedHandler) Health(ctx context.Context) (r HealthRes, _ error)

Health implements health operation.

Health Check.

GET /health

func (UnimplementedHandler) ListCluster

func (UnimplementedHandler) ListCluster(ctx context.Context) (r ListClusterRes, _ error)

ListCluster implements listCluster operation.

List Clusters.

GET /clusters

Jump to

Keyboard shortcuts

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