api

package
v1.22.0 Latest Latest
Warning

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

 Go to latest Published: Jun 16, 2026 License: Apache-2.0 Imports: 25 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 GetRolesForAPIKey 

func GetRolesForAPIKey(operation string) []string

GetRolesForAPIKey returns the required roles for the given operation.

This is useful for authorization scenarios where you need to know which roles are required for an operation.

Example: 

requiredRoles := GetRolesForAPIKey(AddPetOperation)

Returns nil if the operation has no role requirements or if the operation is unknown.

func WithServerURL 

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

WithServerURL sets context key to override server URL.

Types

type APIKey 

type APIKey struct {
	APIKey string
	Roles  []string
}

func (*APIKey) GetAPIKey 

func (s *APIKey) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*APIKey) GetRoles 

func (s *APIKey) GetRoles() []string

GetRoles returns the value of Roles.

func (*APIKey) SetAPIKey 

func (s *APIKey) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

func (*APIKey) SetRoles 

func (s *APIKey) SetRoles(val []string)

SetRoles sets the value of Roles.

type Client 

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

Client implements OAS client.

func NewClient 

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

NewClient initializes new Client defined by OAS.

func (*Client) SpanStatusBody 

func (c *Client) SpanStatusBody(ctx context.Context) (SpanStatusBodyRes, error)

SpanStatusBody invokes spanStatusBody operation.

GET /span-status

func (*Client) SpanStatusNoBody 

func (c *Client) SpanStatusNoBody(ctx context.Context) (*SpanStatusNoBodyDef, error)

SpanStatusNoBody invokes spanStatusNoBody operation.

PUT /span-status

func (*Client) SpanStatusRequestChecks 

func (c *Client) SpanStatusRequestChecks(ctx context.Context, request *SpanStatusRequestChecksReq, params SpanStatusRequestChecksParams) error

SpanStatusRequestChecks invokes spanStatusRequestChecks operation.

POST /span-status

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 {
	Code    int64  `json:"code"`
	Message string `json:"message"`
}

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

func (s *Error) GetCode() int64

GetCode returns the value of Code.

func (*Error) GetMessage 

func (s *Error) GetMessage() string

GetMessage returns the value of Message.

func (*Error) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetCode 

func (s *Error) SetCode(val int64)

SetCode sets the value of Code.

func (*Error) SetMessage 

func (s *Error) SetMessage(val string)

SetMessage sets the value of Message.

func (*Error) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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

type Handler 

type Handler interface {
	// SpanStatusBody implements spanStatusBody operation.
	//
	// GET /span-status
	SpanStatusBody(ctx context.Context) (SpanStatusBodyRes, error)
	// SpanStatusNoBody implements spanStatusNoBody operation.
	//
	// PUT /span-status
	SpanStatusNoBody(ctx context.Context) (*SpanStatusNoBodyDef, error)
	// SpanStatusRequestChecks implements spanStatusRequestChecks operation.
	//
	// POST /span-status
	SpanStatusRequestChecks(ctx context.Context, req *SpanStatusRequestChecksReq, params SpanStatusRequestChecksParams) error
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// SpanStatusBody invokes spanStatusBody operation.
	//
	// GET /span-status
	SpanStatusBody(ctx context.Context) (SpanStatusBodyRes, error)
	// SpanStatusNoBody invokes spanStatusNoBody operation.
	//
	// PUT /span-status
	SpanStatusNoBody(ctx context.Context) (*SpanStatusNoBodyDef, error)
	// SpanStatusRequestChecks invokes spanStatusRequestChecks operation.
	//
	// POST /span-status
	SpanStatusRequestChecks(ctx context.Context, request *SpanStatusRequestChecksReq, params SpanStatusRequestChecksParams) 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 (
	SpanStatusBodyOperation          OperationName = "SpanStatusBody"
	SpanStatusNoBodyOperation        OperationName = "SpanStatusNoBody"
	SpanStatusRequestChecksOperation OperationName = "SpanStatusRequestChecks"
)

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 SecurityHandler 

type SecurityHandler interface {
	// HandleAPIKey handles api_key security.
	HandleAPIKey(ctx context.Context, operationName OperationName, t APIKey) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// APIKey provides api_key security value.
	APIKey(ctx context.Context, operationName OperationName) (APIKey, error)
}

SecuritySource is provider of security values (tokens, passwords, etc.).

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, sec SecurityHandler, 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 SpanStatusBodyInternalServerError 

type SpanStatusBodyInternalServerError struct{}

SpanStatusBodyInternalServerError is response for SpanStatusBody operation.

type SpanStatusBodyNotFound 

type SpanStatusBodyNotFound struct{}

SpanStatusBodyNotFound is response for SpanStatusBody operation.

type SpanStatusBodyOK 

type SpanStatusBodyOK struct {
	Message string `json:"message"`
}

func (*SpanStatusBodyOK) Decode 

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

Decode decodes SpanStatusBodyOK from json.

func (*SpanStatusBodyOK) Encode 

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

Encode implements json.Marshaler.

func (*SpanStatusBodyOK) GetMessage 

func (s *SpanStatusBodyOK) GetMessage() string

GetMessage returns the value of Message.

func (*SpanStatusBodyOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*SpanStatusBodyOK) SetMessage 

func (s *SpanStatusBodyOK) SetMessage(val string)

SetMessage sets the value of Message.

func (*SpanStatusBodyOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SpanStatusBodyOK) Validate 

func (s *SpanStatusBodyOK) Validate() error

type SpanStatusBodyRes 

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

type SpanStatusNoBodyDef 

type SpanStatusNoBodyDef struct {
	StatusCode int
}

SpanStatusNoBodyDef is default response for SpanStatusNoBody operation.

func (*SpanStatusNoBodyDef) GetStatusCode 

func (s *SpanStatusNoBodyDef) GetStatusCode() int

GetStatusCode returns the value of StatusCode.

func (*SpanStatusNoBodyDef) SetStatusCode 

func (s *SpanStatusNoBodyDef) SetStatusCode(val int)

SetStatusCode sets the value of StatusCode.

type SpanStatusRequestChecksOK 

type SpanStatusRequestChecksOK struct{}

SpanStatusRequestChecksOK is response for SpanStatusRequestChecks operation.

type SpanStatusRequestChecksParams 

type SpanStatusRequestChecksParams struct {
	ID int
}

SpanStatusRequestChecksParams is parameters of spanStatusRequestChecks operation.

type SpanStatusRequestChecksReq 

type SpanStatusRequestChecksReq struct {
	Message string `json:"message"`
}

func (*SpanStatusRequestChecksReq) Decode 

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

Decode decodes SpanStatusRequestChecksReq from json.

func (*SpanStatusRequestChecksReq) Encode 

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

Encode implements json.Marshaler.

func (*SpanStatusRequestChecksReq) GetMessage 

func (s *SpanStatusRequestChecksReq) GetMessage() string

GetMessage returns the value of Message.

func (*SpanStatusRequestChecksReq) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*SpanStatusRequestChecksReq) SetMessage 

func (s *SpanStatusRequestChecksReq) SetMessage(val string)

SetMessage sets the value of Message.

func (*SpanStatusRequestChecksReq) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) SpanStatusBody 

func (UnimplementedHandler) SpanStatusBody(ctx context.Context) (r SpanStatusBodyRes, _ error)

SpanStatusBody implements spanStatusBody operation.

GET /span-status

func (UnimplementedHandler) SpanStatusNoBody 

func (UnimplementedHandler) SpanStatusNoBody(ctx context.Context) (r *SpanStatusNoBodyDef, _ error)

SpanStatusNoBody implements spanStatusNoBody operation.

PUT /span-status

func (UnimplementedHandler) SpanStatusRequestChecks 

func (UnimplementedHandler) SpanStatusRequestChecks(ctx context.Context, req *SpanStatusRequestChecksReq, params SpanStatusRequestChecksParams) error

SpanStatusRequestChecks implements spanStatusRequestChecks operation.

POST /span-status

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.