oas

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 27, 2025 License: Apache-2.0 Imports: 26 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) GetHealth 

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

GetHealth invokes getHealth operation.

Get health.

GET /health

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 Error 

type Error struct {
	// Human-readable error message.
	ErrorMessage string     `json:"errorMessage"`
	TraceID      OptTraceID `json:"traceID"`
	SpanID       OptSpanID  `json:"spanID"`
}

Error occurred while processing request. 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) GetErrorMessage 

func (s *Error) GetErrorMessage() string

GetErrorMessage returns the value of ErrorMessage.

func (*Error) GetSpanID 

func (s *Error) GetSpanID() OptSpanID

GetSpanID returns the value of SpanID.

func (*Error) GetTraceID 

func (s *Error) GetTraceID() OptTraceID

GetTraceID returns the value of TraceID.

func (*Error) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetErrorMessage 

func (s *Error) SetErrorMessage(val string)

SetErrorMessage sets the value of ErrorMessage.

func (*Error) SetFake 

func (s *Error) SetFake()

SetFake set fake values.

func (*Error) SetSpanID 

func (s *Error) SetSpanID(val OptSpanID)

SetSpanID sets the value of SpanID.

func (*Error) SetTraceID 

func (s *Error) SetTraceID(val OptTraceID)

SetTraceID sets the value of TraceID.

func (*Error) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Error) Validate 

func (s *Error) Validate() error

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

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

func (*ErrorStatusCode) GetResponse 

func (s *ErrorStatusCode) GetResponse() Error

GetResponse returns the value of Response.

func (*ErrorStatusCode) GetStatusCode 

func (s *ErrorStatusCode) GetStatusCode() int

GetStatusCode returns the value of StatusCode.

func (*ErrorStatusCode) SetResponse 

func (s *ErrorStatusCode) SetResponse(val Error)

SetResponse sets the value of Response.

func (*ErrorStatusCode) SetStatusCode 

func (s *ErrorStatusCode) SetStatusCode(val int)

SetStatusCode sets the value of StatusCode.

func (*ErrorStatusCode) Validate 

func (s *ErrorStatusCode) Validate() error

type Handler 

type Handler interface {
	// GetHealth implements getHealth operation.
	//
	// Get health.
	//
	// GET /health
	GetHealth(ctx context.Context) (*Health, 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 Health 

type Health struct {
	// Health status string.
	Status string `json:"status"`
	// Service version.
	Version string `json:"version"`
	// Service commit.
	Commit string `json:"commit"`
	// Service build date.
	BuildDate time.Time `json:"buildDate"`
}

Health status. Ref: #/components/schemas/Health

func (*Health) Decode 

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

Decode decodes Health from json.

func (*Health) Encode 

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

Encode implements json.Marshaler.

func (*Health) GetBuildDate 

func (s *Health) GetBuildDate() time.Time

GetBuildDate returns the value of BuildDate.

func (*Health) GetCommit 

func (s *Health) GetCommit() string

GetCommit returns the value of Commit.

func (*Health) GetStatus 

func (s *Health) GetStatus() string

GetStatus returns the value of Status.

func (*Health) GetVersion 

func (s *Health) GetVersion() string

GetVersion returns the value of Version.

func (*Health) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Health) SetBuildDate 

func (s *Health) SetBuildDate(val time.Time)

SetBuildDate sets the value of BuildDate.

func (*Health) SetCommit 

func (s *Health) SetCommit(val string)

SetCommit sets the value of Commit.

func (*Health) SetFake 

func (s *Health) SetFake()

SetFake set fake values.

func (*Health) SetStatus 

func (s *Health) SetStatus(val string)

SetStatus sets the value of Status.

func (*Health) SetVersion 

func (s *Health) SetVersion(val string)

SetVersion sets the value of Version.

func (*Health) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Invoker 

type Invoker interface {
	// GetHealth invokes getHealth operation.
	//
	// Get health.
	//
	// GET /health
	GetHealth(ctx context.Context) (*Health, 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 (
	GetHealthOperation OperationName = "GetHealth"
)

type OptSpanID 

type OptSpanID struct {
	Value SpanID
	Set   bool
}

OptSpanID is optional SpanID.

func NewOptSpanID 

func NewOptSpanID(v SpanID) OptSpanID

NewOptSpanID returns new OptSpanID with value set to v.

func (*OptSpanID) Decode 

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

Decode decodes SpanID from json.

func (OptSpanID) Encode 

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

Encode encodes SpanID as json.

func (OptSpanID) Get 

func (o OptSpanID) Get() (v SpanID, ok bool)

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

func (OptSpanID) IsSet 

func (o OptSpanID) IsSet() bool

IsSet returns true if OptSpanID was set.

func (OptSpanID) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (OptSpanID) Or 

func (o OptSpanID) Or(d SpanID) SpanID

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

func (*OptSpanID) Reset 

func (o *OptSpanID) Reset()

Reset unsets value.

func (*OptSpanID) SetFake 

func (s *OptSpanID) SetFake()

SetFake set fake values.

func (*OptSpanID) SetTo 

func (o *OptSpanID) SetTo(v SpanID)

SetTo sets value to v.

func (*OptSpanID) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type OptTraceID 

type OptTraceID struct {
	Value TraceID
	Set   bool
}

OptTraceID is optional TraceID.

func NewOptTraceID 

func NewOptTraceID(v TraceID) OptTraceID

NewOptTraceID returns new OptTraceID with value set to v.

func (*OptTraceID) Decode 

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

Decode decodes TraceID from json.

func (OptTraceID) Encode 

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

Encode encodes TraceID as json.

func (OptTraceID) Get 

func (o OptTraceID) Get() (v TraceID, ok bool)

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

func (OptTraceID) IsSet 

func (o OptTraceID) IsSet() bool

IsSet returns true if OptTraceID was set.

func (OptTraceID) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (OptTraceID) Or 

func (o OptTraceID) Or(d TraceID) TraceID

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

func (*OptTraceID) Reset 

func (o *OptTraceID) Reset()

Reset unsets value.

func (*OptTraceID) SetFake 

func (s *OptTraceID) SetFake()

SetFake set fake values.

func (*OptTraceID) SetTo 

func (o *OptTraceID) SetTo(v TraceID)

SetTo sets value to v.

func (*OptTraceID) UnmarshalJSON 

func (s *OptTraceID) 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) 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 SpanID 

type SpanID string

func (*SpanID) Decode 

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

Decode decodes SpanID from json.

func (SpanID) Encode 

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

Encode encodes SpanID as json.

func (SpanID) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*SpanID) SetFake 

func (s *SpanID) SetFake()

SetFake set fake values.

func (*SpanID) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (SpanID) Validate 

func (s SpanID) Validate() error

type TraceID 

type TraceID string

func (*TraceID) Decode 

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

Decode decodes TraceID from json.

func (TraceID) Encode 

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

Encode encodes TraceID as json.

func (TraceID) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TraceID) SetFake 

func (s *TraceID) SetFake()

SetFake set fake values.

func (*TraceID) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (TraceID) Validate 

func (s TraceID) Validate() error

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) GetHealth 

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

GetHealth implements getHealth operation.

Get health.

GET /health

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.

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.