api

package
v1.19.0 Latest Latest
Warning

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

 Go to latest Published: Feb 11, 2026 License: Apache-2.0 Imports: 25 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) LogEvent 

func (c *Client) LogEvent(ctx context.Context, request Event) error

LogEvent invokes logEvent operation.

POST /events

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 Event 

type Event struct {
	Type        EventType // switch on this field
	UserEvent   UserEvent
	SystemEvent SystemEvent
	MetricEvent MetricEvent
}

Ref: #/components/schemas/Event Event represents sum type.

func NewMetricEventEvent 

func NewMetricEventEvent(v MetricEvent) Event

NewMetricEventEvent returns new Event from MetricEvent.

func NewSystemEventEvent 

func NewSystemEventEvent(v SystemEvent) Event

NewSystemEventEvent returns new Event from SystemEvent.

func NewUserEventEvent 

func NewUserEventEvent(v UserEvent) Event

NewUserEventEvent returns new Event from UserEvent.

func (*Event) Decode 

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

Decode decodes Event from json.

func (Event) Encode 

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

Encode encodes Event as json.

func (Event) GetMetricEvent 

func (s Event) GetMetricEvent() (v MetricEvent, ok bool)

GetMetricEvent returns MetricEvent and true boolean if Event is MetricEvent.

func (Event) GetSystemEvent 

func (s Event) GetSystemEvent() (v SystemEvent, ok bool)

GetSystemEvent returns SystemEvent and true boolean if Event is SystemEvent.

func (Event) GetUserEvent 

func (s Event) GetUserEvent() (v UserEvent, ok bool)

GetUserEvent returns UserEvent and true boolean if Event is UserEvent.

func (Event) IsMetricEvent 

func (s Event) IsMetricEvent() bool

IsMetricEvent reports whether Event is MetricEvent.

func (Event) IsSystemEvent 

func (s Event) IsSystemEvent() bool

IsSystemEvent reports whether Event is SystemEvent.

func (Event) IsUserEvent 

func (s Event) IsUserEvent() bool

IsUserEvent reports whether Event is UserEvent.

func (Event) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Event) SetMetricEvent 

func (s *Event) SetMetricEvent(v MetricEvent)

SetMetricEvent sets Event to MetricEvent.

func (*Event) SetSystemEvent 

func (s *Event) SetSystemEvent(v SystemEvent)

SetSystemEvent sets Event to SystemEvent.

func (*Event) SetUserEvent 

func (s *Event) SetUserEvent(v UserEvent)

SetUserEvent sets Event to UserEvent.

func (*Event) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type EventType 

type EventType string

EventType is oneOf type of Event. 

const (
	UserEventEvent   EventType = "UserEvent"
	SystemEventEvent EventType = "SystemEvent"
	MetricEventEvent EventType = "MetricEvent"
)

Possible values for EventType.

type Handler 

type Handler interface {
	// LogEvent implements logEvent operation.
	//
	// POST /events
	LogEvent(ctx context.Context, req Event) error
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// LogEvent invokes logEvent operation.
	//
	// POST /events
	LogEvent(ctx context.Context, request Event) 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 LogEventOK 

type LogEventOK struct{}

LogEventOK is response for LogEvent operation.

type MetricEvent 

type MetricEvent struct {
	Timestamp time.Time `json:"timestamp"`
	// Integer severity level - same name as SystemEvent but different type.
	Severity int       `json:"severity"`
	Action   OptString `json:"action"`
}

Ref: #/components/schemas/MetricEvent

func (*MetricEvent) Decode 

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

Decode decodes MetricEvent from json.

func (*MetricEvent) Encode 

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

Encode implements json.Marshaler.

func (*MetricEvent) GetAction 

func (s *MetricEvent) GetAction() OptString

GetAction returns the value of Action.

func (*MetricEvent) GetSeverity 

func (s *MetricEvent) GetSeverity() int

GetSeverity returns the value of Severity.

func (*MetricEvent) GetTimestamp 

func (s *MetricEvent) GetTimestamp() time.Time

GetTimestamp returns the value of Timestamp.

func (*MetricEvent) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*MetricEvent) SetAction 

func (s *MetricEvent) SetAction(val OptString)

SetAction sets the value of Action.

func (*MetricEvent) SetSeverity 

func (s *MetricEvent) SetSeverity(val int)

SetSeverity sets the value of Severity.

func (*MetricEvent) SetTimestamp 

func (s *MetricEvent) SetTimestamp(val time.Time)

SetTimestamp sets the value of Timestamp.

func (*MetricEvent) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	LogEventOperation OperationName = "LogEvent"
)

type OptString 

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString 

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (*OptString) Decode 

func (o *OptString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptString) Encode 

func (o OptString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (OptString) Get 

func (o OptString) Get() (v string, ok bool)

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

func (OptString) IsSet 

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (OptString) Or 

func (o OptString) Or(d string) string

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

func (*OptString) Reset 

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo 

func (o *OptString) SetTo(v string)

SetTo sets value to v.

func (*OptString) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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 SystemEvent 

type SystemEvent struct {
	Timestamp time.Time `json:"timestamp"`
	// String severity - same name as MetricEvent but different type.
	Severity string    `json:"severity"`
	Action   OptString `json:"action"`
}

Ref: #/components/schemas/SystemEvent

func (*SystemEvent) Decode 

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

Decode decodes SystemEvent from json.

func (*SystemEvent) Encode 

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

Encode implements json.Marshaler.

func (*SystemEvent) GetAction 

func (s *SystemEvent) GetAction() OptString

GetAction returns the value of Action.

func (*SystemEvent) GetSeverity 

func (s *SystemEvent) GetSeverity() string

GetSeverity returns the value of Severity.

func (*SystemEvent) GetTimestamp 

func (s *SystemEvent) GetTimestamp() time.Time

GetTimestamp returns the value of Timestamp.

func (*SystemEvent) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*SystemEvent) SetAction 

func (s *SystemEvent) SetAction(val OptString)

SetAction sets the value of Action.

func (*SystemEvent) SetSeverity 

func (s *SystemEvent) SetSeverity(val string)

SetSeverity sets the value of Severity.

func (*SystemEvent) SetTimestamp 

func (s *SystemEvent) SetTimestamp(val time.Time)

SetTimestamp sets the value of Timestamp.

func (*SystemEvent) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) LogEvent 

func (UnimplementedHandler) LogEvent(ctx context.Context, req Event) error

LogEvent implements logEvent operation.

POST /events

type UserEvent 

type UserEvent struct {
	Timestamp time.Time `json:"timestamp"`
	// Unique field name - discriminates UserEvent.
	UserId string    `json:"userId"`
	Action OptString `json:"action"`
}

Ref: #/components/schemas/UserEvent

func (*UserEvent) Decode 

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

Decode decodes UserEvent from json.

func (*UserEvent) Encode 

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

Encode implements json.Marshaler.

func (*UserEvent) GetAction 

func (s *UserEvent) GetAction() OptString

GetAction returns the value of Action.

func (*UserEvent) GetTimestamp 

func (s *UserEvent) GetTimestamp() time.Time

GetTimestamp returns the value of Timestamp.

func (*UserEvent) GetUserId 

func (s *UserEvent) GetUserId() string

GetUserId returns the value of UserId.

func (*UserEvent) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*UserEvent) SetAction 

func (s *UserEvent) SetAction(val OptString)

SetAction sets the value of Action.

func (*UserEvent) SetTimestamp 

func (s *UserEvent) SetTimestamp(val time.Time)

SetTimestamp sets the value of Timestamp.

func (*UserEvent) SetUserId 

func (s *UserEvent) SetUserId(val string)

SetUserId sets the value of UserId.

func (*UserEvent) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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.