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: 23 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 GetRolesForBearerToken 

func GetRolesForBearerToken(operation string) []string

GetRolesForBearerToken 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 := GetRolesForBearerToken(AddPetOperation)

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

func GetRolesForHeaderKey 

func GetRolesForHeaderKey(operation string) []string

GetRolesForHeaderKey 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 := GetRolesForHeaderKey(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 BearerToken 

type BearerToken struct {
	Token string
	Roles []string
}

func (*BearerToken) GetRoles 

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

GetRoles returns the value of Roles.

func (*BearerToken) GetToken 

func (s *BearerToken) GetToken() string

GetToken returns the value of Token.

func (*BearerToken) SetRoles 

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

SetRoles sets the value of Roles.

func (*BearerToken) SetToken 

func (s *BearerToken) SetToken(val string)

SetToken sets the value of Token.

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

func (c *Client) FooGet(ctx context.Context, params FooGetParams) error

FooGet invokes GET /foo operation.

GET /foo

func (*Client) FooPatch 

func (c *Client) FooPatch(ctx context.Context, request FooPatchReq) error

FooPatch invokes PATCH /foo operation.

PATCH /foo

func (*Client) FooPost 

func (c *Client) FooPost(ctx context.Context, request FooPostReq) (*FooPostOK, error)

FooPost invokes POST /foo operation.

POST /foo

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 FooGetOK 

type FooGetOK struct{}

FooGetOK is response for FooGet operation.

type FooGetParams 

type FooGetParams struct {
	ContentLength int64
}

FooGetParams is parameters of GET /foo operation.

type FooPatchOK 

type FooPatchOK struct{}

FooPatchOK is response for FooPatch operation.

type FooPatchReq 

type FooPatchReq struct {
	Data io.Reader
}

func (FooPatchReq) Read 

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

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type FooPostOK 

type FooPostOK struct {
	Location string
}

FooPostOK is response for FooPost operation.

func (*FooPostOK) GetLocation 

func (s *FooPostOK) GetLocation() string

GetLocation returns the value of Location.

func (*FooPostOK) SetLocation 

func (s *FooPostOK) SetLocation(val string)

SetLocation sets the value of Location.

type FooPostReq 

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

type FooPostReqApplicationJSON 

type FooPostReqApplicationJSON string

func (*FooPostReqApplicationJSON) Decode 

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

Decode decodes FooPostReqApplicationJSON from json.

func (FooPostReqApplicationJSON) Encode 

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

Encode encodes FooPostReqApplicationJSON as json.

func (FooPostReqApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*FooPostReqApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type FooPostReqTextPlain 

type FooPostReqTextPlain struct {
	Data io.Reader
}

func (FooPostReqTextPlain) Read 

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

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type Handler 

type Handler interface {
	// FooGet implements GET /foo operation.
	//
	// GET /foo
	FooGet(ctx context.Context, params FooGetParams) error
	// FooPatch implements PATCH /foo operation.
	//
	// PATCH /foo
	FooPatch(ctx context.Context, req FooPatchReq) error
	// FooPost implements POST /foo operation.
	//
	// POST /foo
	FooPost(ctx context.Context, req FooPostReq) (*FooPostOK, error)
}

Handler handles operations described by OpenAPI v3 specification.

type HeaderKey 

type HeaderKey struct {
	APIKey string
	Roles  []string
}

func (*HeaderKey) GetAPIKey 

func (s *HeaderKey) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*HeaderKey) GetRoles 

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

GetRoles returns the value of Roles.

func (*HeaderKey) SetAPIKey 

func (s *HeaderKey) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

func (*HeaderKey) SetRoles 

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

SetRoles sets the value of Roles.

type Invoker 

type Invoker interface {
	// FooGet invokes GET /foo operation.
	//
	// GET /foo
	FooGet(ctx context.Context, params FooGetParams) error
	// FooPatch invokes PATCH /foo operation.
	//
	// PATCH /foo
	FooPatch(ctx context.Context, request FooPatchReq) error
	// FooPost invokes POST /foo operation.
	//
	// POST /foo
	FooPost(ctx context.Context, request FooPostReq) (*FooPostOK, 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 (
	FooGetOperation   OperationName = "FooGet"
	FooPatchOperation OperationName = "FooPatch"
	FooPostOperation  OperationName = "FooPost"
)

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 {
	// HandleBearerToken handles bearerToken security.
	HandleBearerToken(ctx context.Context, operationName OperationName, t BearerToken) (context.Context, error)
	// HandleHeaderKey handles headerKey security.
	HandleHeaderKey(ctx context.Context, operationName OperationName, t HeaderKey) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// BearerToken provides bearerToken security value.
	BearerToken(ctx context.Context, operationName OperationName) (BearerToken, error)
	// HeaderKey provides headerKey security value.
	HeaderKey(ctx context.Context, operationName OperationName) (HeaderKey, 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 UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) FooGet 

func (UnimplementedHandler) FooGet(ctx context.Context, params FooGetParams) error

FooGet implements GET /foo operation.

GET /foo

func (UnimplementedHandler) FooPatch 

func (UnimplementedHandler) FooPatch(ctx context.Context, req FooPatchReq) error

FooPatch implements PATCH /foo operation.

PATCH /foo

func (UnimplementedHandler) FooPost 

func (UnimplementedHandler) FooPost(ctx context.Context, req FooPostReq) (r *FooPostOK, _ error)

FooPost implements POST /foo operation.

POST /foo

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.