api

package
v0.0.0-...-a1976e4 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2025 License: Apache-2.0 Imports: 27 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 BearerAuth 

type BearerAuth struct {
	Token string
}

func (*BearerAuth) GetToken 

func (s *BearerAuth) GetToken() string

GetToken returns the value of Token.

func (*BearerAuth) SetToken 

func (s *BearerAuth) 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) GetHealth 

func (c *Client) GetHealth(ctx context.Context, params GetHealthParams) (*HealthResponseSchema, error)

GetHealth invokes getHealth operation.

Health.

GET /health

func (*Client) PostHealth 

func (c *Client) PostHealth(ctx context.Context, request *HealthRequestSchema) (*HealthResponseSchema, error)

PostHealth invokes postHealth operation.

Health.

POST /health

func (*Client) Test 

func (c *Client) Test(ctx context.Context, request *TestReq) (TestRes, error)

Test invokes test operation.

Test.

POST /test

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

type GetHealthParams 

type GetHealthParams struct {
	// Message.
	Message string
}

GetHealthParams is parameters of getHealth operation.

type Handler 

type Handler interface {
	// GetHealth implements getHealth operation.
	//
	// Health.
	//
	// GET /health
	GetHealth(ctx context.Context, params GetHealthParams) (*HealthResponseSchema, error)
	// PostHealth implements postHealth operation.
	//
	// Health.
	//
	// POST /health
	PostHealth(ctx context.Context, req *HealthRequestSchema) (*HealthResponseSchema, error)
	// Test implements test operation.
	//
	// Test.
	//
	// POST /test
	Test(ctx context.Context, req *TestReq) (TestRes, 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 HealthRequestSchema 

type HealthRequestSchema struct {
	// Message.
	Message string `json:"message"`
}

Ref: #/components/schemas/HealthRequestSchema

func (*HealthRequestSchema) Decode 

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

Decode decodes HealthRequestSchema from json.

func (*HealthRequestSchema) Encode 

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

Encode implements json.Marshaler.

func (*HealthRequestSchema) GetMessage 

func (s *HealthRequestSchema) GetMessage() string

GetMessage returns the value of Message.

func (*HealthRequestSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*HealthRequestSchema) SetMessage 

func (s *HealthRequestSchema) SetMessage(val string)

SetMessage sets the value of Message.

func (*HealthRequestSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type HealthResponseSchema 

type HealthResponseSchema struct {
	// Message.
	Message string `json:"message"`
}

Ref: #/components/schemas/HealthResponseSchema

func (*HealthResponseSchema) Decode 

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

Decode decodes HealthResponseSchema from json.

func (*HealthResponseSchema) Encode 

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

Encode implements json.Marshaler.

func (*HealthResponseSchema) GetMessage 

func (s *HealthResponseSchema) GetMessage() string

GetMessage returns the value of Message.

func (*HealthResponseSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*HealthResponseSchema) SetMessage 

func (s *HealthResponseSchema) SetMessage(val string)

SetMessage sets the value of Message.

func (*HealthResponseSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Invoker 

type Invoker interface {
	// GetHealth invokes getHealth operation.
	//
	// Health.
	//
	// GET /health
	GetHealth(ctx context.Context, params GetHealthParams) (*HealthResponseSchema, error)
	// PostHealth invokes postHealth operation.
	//
	// Health.
	//
	// POST /health
	PostHealth(ctx context.Context, request *HealthRequestSchema) (*HealthResponseSchema, error)
	// Test invokes test operation.
	//
	// Test.
	//
	// POST /test
	Test(ctx context.Context, request *TestReq) (TestRes, 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 OKResponseSchema 

type OKResponseSchema struct {
	// Message.
	Message string `json:"message"`
}

Ref: #/components/schemas/OKResponseSchema

func (*OKResponseSchema) Decode 

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

Decode decodes OKResponseSchema from json.

func (*OKResponseSchema) Encode 

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

Encode implements json.Marshaler.

func (*OKResponseSchema) GetMessage 

func (s *OKResponseSchema) GetMessage() string

GetMessage returns the value of Message.

func (*OKResponseSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*OKResponseSchema) SetMessage 

func (s *OKResponseSchema) SetMessage(val string)

SetMessage sets the value of Message.

func (*OKResponseSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

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 SecurityHandler 

type SecurityHandler interface {
	// HandleBearerAuth handles bearerAuth security.
	HandleBearerAuth(ctx context.Context, operationName string, t BearerAuth) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// BearerAuth provides bearerAuth security value.
	BearerAuth(ctx context.Context, operationName string) (BearerAuth, 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 TestBadRequest 

type TestBadRequest Error

func (*TestBadRequest) Decode 

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

Decode decodes TestBadRequest from json.

func (*TestBadRequest) Encode 

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

Encode encodes TestBadRequest as json.

func (*TestBadRequest) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TestBadRequest) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type TestForbidden 

type TestForbidden Error

func (*TestForbidden) Decode 

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

Decode decodes TestForbidden from json.

func (*TestForbidden) Encode 

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

Encode encodes TestForbidden as json.

func (*TestForbidden) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TestForbidden) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type TestNotFound 

type TestNotFound Error

func (*TestNotFound) Decode 

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

Decode decodes TestNotFound from json.

func (*TestNotFound) Encode 

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

Encode encodes TestNotFound as json.

func (*TestNotFound) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TestNotFound) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type TestReq 

type TestReq struct {
	// Status.
	Status int `json:"status"`
}

func (*TestReq) Decode 

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

Decode decodes TestReq from json.

func (*TestReq) Encode 

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

Encode implements json.Marshaler.

func (*TestReq) GetStatus 

func (s *TestReq) GetStatus() int

GetStatus returns the value of Status.

func (*TestReq) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TestReq) SetStatus 

func (s *TestReq) SetStatus(val int)

SetStatus sets the value of Status.

func (*TestReq) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type TestRes 

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

type TestUnauthorized 

type TestUnauthorized Error

func (*TestUnauthorized) Decode 

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

Decode decodes TestUnauthorized from json.

func (*TestUnauthorized) Encode 

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

Encode encodes TestUnauthorized as json.

func (*TestUnauthorized) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*TestUnauthorized) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) GetHealth 

func (UnimplementedHandler) GetHealth(ctx context.Context, params GetHealthParams) (r *HealthResponseSchema, _ error)

GetHealth implements getHealth operation.

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.

func (UnimplementedHandler) PostHealth 

func (UnimplementedHandler) PostHealth(ctx context.Context, req *HealthRequestSchema) (r *HealthResponseSchema, _ error)

PostHealth implements postHealth operation.

Health.

POST /health

func (UnimplementedHandler) Test 

func (UnimplementedHandler) Test(ctx context.Context, req *TestReq) (r TestRes, _ error)

Test implements test operation.

Test.

POST /test

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.