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: 21 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) GetMixedData 

func (c *Client) GetMixedData(ctx context.Context) (GetMixedDataRes, error)

GetMixedData invokes getMixedData operation.

GET /mixed-data

func (*Client) GetNormalData 

func (c *Client) GetNormalData(ctx context.Context) (*GetNormalDataOK, error)

GetNormalData invokes getNormalData operation.

GET /normal-data

func (*Client) GetRawData 

func (c *Client) GetRawData(ctx context.Context) (GetRawDataRes, error)

GetRawData invokes getRawData operation.

GET /raw-data

func (*Client) GetRawDataInsideOperationGroup added in v1.19.0 

func (c *Client) GetRawDataInsideOperationGroup(ctx context.Context) (GetRawDataInsideOperationGroupRes, error)

GetRawDataInsideOperationGroup invokes getRawDataInsideOperationGroup operation.

GET /raw-data-inside-operation-group

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 GetMixedDataOKApplicationJSON 

type GetMixedDataOKApplicationJSON struct {
	Message OptString `json:"message"`
}

func (*GetMixedDataOKApplicationJSON) Decode 

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

Decode decodes GetMixedDataOKApplicationJSON from json.

func (*GetMixedDataOKApplicationJSON) Encode 

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

Encode implements json.Marshaler.

func (*GetMixedDataOKApplicationJSON) GetMessage 

func (s *GetMixedDataOKApplicationJSON) GetMessage() OptString

GetMessage returns the value of Message.

func (*GetMixedDataOKApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*GetMixedDataOKApplicationJSON) SetMessage 

func (s *GetMixedDataOKApplicationJSON) SetMessage(val OptString)

SetMessage sets the value of Message.

func (*GetMixedDataOKApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type GetMixedDataOKApplicationOctetStream 

type GetMixedDataOKApplicationOctetStream struct {
	Data io.Reader
}

func (GetMixedDataOKApplicationOctetStream) Read 

func (s GetMixedDataOKApplicationOctetStream) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetMixedDataOKRawApplicationOctetStream 

type GetMixedDataOKRawApplicationOctetStream struct {
	Response *http.Response `json:"-"`
}

GetMixedDataOKRawApplicationOctetStream represents raw HTTP response for GetMixedData application/octet-stream.

func (*GetMixedDataOKRawApplicationOctetStream) GetResponse 

func (s *GetMixedDataOKRawApplicationOctetStream) GetResponse() *http.Response

GetResponse returns the value of Response.

func (*GetMixedDataOKRawApplicationOctetStream) SetResponse 

func (s *GetMixedDataOKRawApplicationOctetStream) SetResponse(val *http.Response)

SetResponse sets the value of Response.

type GetMixedDataRes 

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

type GetNormalDataOK 

type GetNormalDataOK struct {
	Message OptString `json:"message"`
}

func (*GetNormalDataOK) Decode 

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

Decode decodes GetNormalDataOK from json.

func (*GetNormalDataOK) Encode 

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

Encode implements json.Marshaler.

func (*GetNormalDataOK) GetMessage 

func (s *GetNormalDataOK) GetMessage() OptString

GetMessage returns the value of Message.

func (*GetNormalDataOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*GetNormalDataOK) SetMessage 

func (s *GetNormalDataOK) SetMessage(val OptString)

SetMessage sets the value of Message.

func (*GetNormalDataOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type GetRawDataInsideOperationGroupOK added in v1.19.0 

type GetRawDataInsideOperationGroupOK struct {
	Message OptString `json:"message"`
}

func (*GetRawDataInsideOperationGroupOK) Decode added in v1.19.0 

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

Decode decodes GetRawDataInsideOperationGroupOK from json.

func (*GetRawDataInsideOperationGroupOK) Encode added in v1.19.0 

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

Encode implements json.Marshaler.

func (*GetRawDataInsideOperationGroupOK) GetMessage added in v1.19.0 

func (s *GetRawDataInsideOperationGroupOK) GetMessage() OptString

GetMessage returns the value of Message.

func (*GetRawDataInsideOperationGroupOK) MarshalJSON added in v1.19.0 

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

MarshalJSON implements stdjson.Marshaler.

func (*GetRawDataInsideOperationGroupOK) SetMessage added in v1.19.0 

func (s *GetRawDataInsideOperationGroupOK) SetMessage(val OptString)

SetMessage sets the value of Message.

func (*GetRawDataInsideOperationGroupOK) UnmarshalJSON added in v1.19.0 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type GetRawDataInsideOperationGroupOKRawApplicationJSON added in v1.19.0 

type GetRawDataInsideOperationGroupOKRawApplicationJSON struct {
	Response *http.Response `json:"-"`
}

GetRawDataInsideOperationGroupOKRawApplicationJSON represents raw HTTP response for GetRawDataInsideOperationGroup application/json.

func (*GetRawDataInsideOperationGroupOKRawApplicationJSON) GetResponse added in v1.19.0 

func (s *GetRawDataInsideOperationGroupOKRawApplicationJSON) GetResponse() *http.Response

GetResponse returns the value of Response.

func (*GetRawDataInsideOperationGroupOKRawApplicationJSON) SetResponse added in v1.19.0 

func (s *GetRawDataInsideOperationGroupOKRawApplicationJSON) SetResponse(val *http.Response)

SetResponse sets the value of Response.

type GetRawDataInsideOperationGroupRes added in v1.19.0 

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

type GetRawDataOK 

type GetRawDataOK struct {
	Message OptString `json:"message"`
}

func (*GetRawDataOK) Decode 

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

Decode decodes GetRawDataOK from json.

func (*GetRawDataOK) Encode 

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

Encode implements json.Marshaler.

func (*GetRawDataOK) GetMessage 

func (s *GetRawDataOK) GetMessage() OptString

GetMessage returns the value of Message.

func (*GetRawDataOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*GetRawDataOK) SetMessage 

func (s *GetRawDataOK) SetMessage(val OptString)

SetMessage sets the value of Message.

func (*GetRawDataOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type GetRawDataOKRawApplicationJSON 

type GetRawDataOKRawApplicationJSON struct {
	Response *http.Response `json:"-"`
}

GetRawDataOKRawApplicationJSON represents raw HTTP response for GetRawData application/json.

func (*GetRawDataOKRawApplicationJSON) GetResponse 

func (s *GetRawDataOKRawApplicationJSON) GetResponse() *http.Response

GetResponse returns the value of Response.

func (*GetRawDataOKRawApplicationJSON) SetResponse 

func (s *GetRawDataOKRawApplicationJSON) SetResponse(val *http.Response)

SetResponse sets the value of Response.

type GetRawDataRes 

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

type Handler 

type Handler interface {
	TestHandler
	// GetNormalData implements getNormalData operation.
	//
	// GET /normal-data
	GetNormalData(ctx context.Context) (*GetNormalDataOK, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	TestInvoker
	// GetMixedData invokes getMixedData operation.
	//
	// GET /mixed-data
	GetMixedData(ctx context.Context) (GetMixedDataRes, error)
	// GetNormalData invokes getNormalData operation.
	//
	// GET /normal-data
	GetNormalData(ctx context.Context) (*GetNormalDataOK, error)
	// GetRawData invokes getRawData operation.
	//
	// GET /raw-data
	GetRawData(ctx context.Context) (GetRawDataRes, 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 (
	GetMixedDataOperation                   OperationName = "GetMixedData"
	GetNormalDataOperation                  OperationName = "GetNormalData"
	GetRawDataOperation                     OperationName = "GetRawData"
	GetRawDataInsideOperationGroupOperation OperationName = "GetRawDataInsideOperationGroup"
)

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 RawHandler 

type RawHandler interface {
	// GetMixedData implements getMixedData operation.
	//
	// GET /mixed-data
	GetMixedData(ctx context.Context, w http.ResponseWriter) error
	// GetRawData implements getRawData operation.
	//
	// GET /raw-data
	GetRawData(ctx context.Context, w http.ResponseWriter) error
}

RawHandler handles raw response operations described by OpenAPI v3 specification.

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 added in v1.17.0 

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, rh RawHandler, 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 TestHandler added in v1.19.0 

type TestHandler interface {
	// GetRawDataInsideOperationGroup implements getRawDataInsideOperationGroup operation.
	//
	// GET /raw-data-inside-operation-group
	GetRawDataInsideOperationGroup(ctx context.Context, w http.ResponseWriter) error
}

TestHandler handles operations described by OpenAPI v3 specification.

x-ogen-operation-group: Test

type TestInvoker added in v1.19.0 

type TestInvoker interface {
	// GetRawDataInsideOperationGroup invokes getRawDataInsideOperationGroup operation.
	//
	// GET /raw-data-inside-operation-group
	GetRawDataInsideOperationGroup(ctx context.Context) (GetRawDataInsideOperationGroupRes, error)
}

TestInvoker invokes operations described by OpenAPI v3 specification.

x-gen-operation-group: Test

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) GetMixedData 

func (UnimplementedHandler) GetMixedData(ctx context.Context, w http.ResponseWriter) error

GetMixedData implements getMixedData operation.

GET /mixed-data

func (UnimplementedHandler) GetNormalData 

func (UnimplementedHandler) GetNormalData(ctx context.Context) (r *GetNormalDataOK, _ error)

GetNormalData implements getNormalData operation.

GET /normal-data

func (UnimplementedHandler) GetRawData 

func (UnimplementedHandler) GetRawData(ctx context.Context, w http.ResponseWriter) error

GetRawData implements getRawData operation.

GET /raw-data

func (UnimplementedHandler) GetRawDataInsideOperationGroup added in v1.19.0 

func (UnimplementedHandler) GetRawDataInsideOperationGroup(ctx context.Context, w http.ResponseWriter) error

GetRawDataInsideOperationGroup implements getRawDataInsideOperationGroup operation.

GET /raw-data-inside-operation-group

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.