api

package
v1.25.0 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

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

func (c *Client) FirstGet(ctx context.Context) (*TooManyRequestsHeaders, error)

FirstGet invokes GET /first operation.

GET /first

func (*Client) SecondGet 

func (c *Client) SecondGet(ctx context.Context) (*TooManyRequestsHeaders, error)

SecondGet invokes GET /second operation.

GET /second

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 ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type FirstGetTooManyRequestsRetryAfter 

type FirstGetTooManyRequestsRetryAfter struct {
	// Type selects the active sum variant, switch on this field.
	Type   FirstGetTooManyRequestsRetryAfterType
	Int    int
	String string
}

FirstGetTooManyRequestsRetryAfter represents sum type.

func NewIntFirstGetTooManyRequestsRetryAfter 

func NewIntFirstGetTooManyRequestsRetryAfter(v int) FirstGetTooManyRequestsRetryAfter

NewIntFirstGetTooManyRequestsRetryAfter returns new FirstGetTooManyRequestsRetryAfter from int.

func NewStringFirstGetTooManyRequestsRetryAfter 

func NewStringFirstGetTooManyRequestsRetryAfter(v string) FirstGetTooManyRequestsRetryAfter

NewStringFirstGetTooManyRequestsRetryAfter returns new FirstGetTooManyRequestsRetryAfter from string.

func (FirstGetTooManyRequestsRetryAfter) GetInt 

func (s FirstGetTooManyRequestsRetryAfter) GetInt() (v int, ok bool)

GetInt returns int and true boolean if FirstGetTooManyRequestsRetryAfter is int.

func (FirstGetTooManyRequestsRetryAfter) GetString 

func (s FirstGetTooManyRequestsRetryAfter) GetString() (v string, ok bool)

GetString returns string and true boolean if FirstGetTooManyRequestsRetryAfter is string.

func (FirstGetTooManyRequestsRetryAfter) IsInt 

func (s FirstGetTooManyRequestsRetryAfter) IsInt() bool

IsInt reports whether FirstGetTooManyRequestsRetryAfter is int.

func (FirstGetTooManyRequestsRetryAfter) IsString 

func (s FirstGetTooManyRequestsRetryAfter) IsString() bool

IsString reports whether FirstGetTooManyRequestsRetryAfter is string.

func (*FirstGetTooManyRequestsRetryAfter) SetInt 

func (s *FirstGetTooManyRequestsRetryAfter) SetInt(v int)

SetInt sets FirstGetTooManyRequestsRetryAfter to int.

func (*FirstGetTooManyRequestsRetryAfter) SetString 

func (s *FirstGetTooManyRequestsRetryAfter) SetString(v string)

SetString sets FirstGetTooManyRequestsRetryAfter to string.

type FirstGetTooManyRequestsRetryAfterType 

type FirstGetTooManyRequestsRetryAfterType string

FirstGetTooManyRequestsRetryAfterType is oneOf type of FirstGetTooManyRequestsRetryAfter. 

const (
	IntFirstGetTooManyRequestsRetryAfter    FirstGetTooManyRequestsRetryAfterType = "int"
	StringFirstGetTooManyRequestsRetryAfter FirstGetTooManyRequestsRetryAfterType = "string"
)

Possible values for FirstGetTooManyRequestsRetryAfterType.

type Handler 

type Handler interface {
	// FirstGet implements GET /first operation.
	//
	// GET /first
	FirstGet(ctx context.Context) (*TooManyRequestsHeaders, error)
	// SecondGet implements GET /second operation.
	//
	// GET /second
	SecondGet(ctx context.Context) (*TooManyRequestsHeaders, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// FirstGet invokes GET /first operation.
	//
	// GET /first
	FirstGet(ctx context.Context) (*TooManyRequestsHeaders, error)
	// SecondGet invokes GET /second operation.
	//
	// GET /second
	SecondGet(ctx context.Context) (*TooManyRequestsHeaders, 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 Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	FirstGetOperation  OperationName = "FirstGet"
	SecondGetOperation OperationName = "SecondGet"
)

type OptFirstGetTooManyRequestsRetryAfter 

type OptFirstGetTooManyRequestsRetryAfter struct {
	Value FirstGetTooManyRequestsRetryAfter
	Set   bool
}

OptFirstGetTooManyRequestsRetryAfter is optional FirstGetTooManyRequestsRetryAfter.

func NewOptFirstGetTooManyRequestsRetryAfter 

func NewOptFirstGetTooManyRequestsRetryAfter(v FirstGetTooManyRequestsRetryAfter) OptFirstGetTooManyRequestsRetryAfter

NewOptFirstGetTooManyRequestsRetryAfter returns new OptFirstGetTooManyRequestsRetryAfter with value set to v.

func (OptFirstGetTooManyRequestsRetryAfter) Get 

func (o OptFirstGetTooManyRequestsRetryAfter) Get() (v FirstGetTooManyRequestsRetryAfter, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptFirstGetTooManyRequestsRetryAfter) IsSet 

func (o OptFirstGetTooManyRequestsRetryAfter) IsSet() bool

IsSet returns true if OptFirstGetTooManyRequestsRetryAfter was set.

func (OptFirstGetTooManyRequestsRetryAfter) Or 

func (o OptFirstGetTooManyRequestsRetryAfter) Or(d FirstGetTooManyRequestsRetryAfter) FirstGetTooManyRequestsRetryAfter

Or returns value if set, or given parameter if does not.

func (*OptFirstGetTooManyRequestsRetryAfter) Reset 

func (o *OptFirstGetTooManyRequestsRetryAfter) Reset()

Reset unsets value.

func (*OptFirstGetTooManyRequestsRetryAfter) SetTo 

func (o *OptFirstGetTooManyRequestsRetryAfter) SetTo(v FirstGetTooManyRequestsRetryAfter)

SetTo sets value to v.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithAttributes 

func WithAttributes(attributes ...attribute.KeyValue) Option

WithAttributes specifies default otel attributes.

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

func (r Route) OperationGroup() string

OperationGroup returns the x-ogen-operation-group value.

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 TooManyRequests 

type TooManyRequests struct{}

Ref: #/components/schemas/TooManyRequests

func (*TooManyRequests) Decode 

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

Decode decodes TooManyRequests from json.

func (*TooManyRequests) Encode 

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

Encode implements json.Marshaler.

func (*TooManyRequests) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TooManyRequests) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type TooManyRequestsHeaders 

type TooManyRequestsHeaders struct {
	RetryAfter OptFirstGetTooManyRequestsRetryAfter
	Response   TooManyRequests
}

TooManyRequestsHeaders wraps TooManyRequests with response headers.

func (*TooManyRequestsHeaders) GetResponse 

func (s *TooManyRequestsHeaders) GetResponse() TooManyRequests

GetResponse returns the value of Response.

func (*TooManyRequestsHeaders) GetRetryAfter 

func (s *TooManyRequestsHeaders) GetRetryAfter() OptFirstGetTooManyRequestsRetryAfter

GetRetryAfter returns the value of RetryAfter.

func (*TooManyRequestsHeaders) SetResponse 

func (s *TooManyRequestsHeaders) SetResponse(val TooManyRequests)

SetResponse sets the value of Response.

func (*TooManyRequestsHeaders) SetRetryAfter 

func (s *TooManyRequestsHeaders) SetRetryAfter(val OptFirstGetTooManyRequestsRetryAfter)

SetRetryAfter sets the value of RetryAfter.

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) FirstGet 

func (UnimplementedHandler) FirstGet(ctx context.Context) (r *TooManyRequestsHeaders, _ error)

FirstGet implements GET /first operation.

GET /first

func (UnimplementedHandler) SecondGet 

func (UnimplementedHandler) SecondGet(ctx context.Context) (r *TooManyRequestsHeaders, _ error)

SecondGet implements GET /second operation.

GET /second

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.