api

package
v0.0.0-...-345d9e2 Latest Latest
Warning

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

 Go to latest Published: Sep 14, 2024 License: GPL-3.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 WithServerURL 

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

WithServerURL sets context key to override server URL.

Types

type AccountCredentials 

type AccountCredentials struct {
	Phone    string `json:"phone"`
	Password string `json:"password"`
}

Ref: #/components/schemas/AccountCredentials

func (*AccountCredentials) Decode 

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

Decode decodes AccountCredentials from json.

func (*AccountCredentials) Encode 

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

Encode implements json.Marshaler.

func (*AccountCredentials) GetPassword 

func (s *AccountCredentials) GetPassword() string

GetPassword returns the value of Password.

func (*AccountCredentials) GetPhone 

func (s *AccountCredentials) GetPhone() string

GetPhone returns the value of Phone.

func (*AccountCredentials) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AccountCredentials) SetPassword 

func (s *AccountCredentials) SetPassword(val string)

SetPassword sets the value of Password.

func (*AccountCredentials) SetPhone 

func (s *AccountCredentials) SetPhone(val string)

SetPhone sets the value of Phone.

func (*AccountCredentials) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AccountId 

type AccountId struct {
	ID string `json:"id"`
}

Ref: #/components/schemas/AccountId

func (*AccountId) Decode 

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

Decode decodes AccountId from json.

func (*AccountId) Encode 

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

Encode implements json.Marshaler.

func (*AccountId) GetID 

func (s *AccountId) GetID() string

GetID returns the value of ID.

func (*AccountId) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AccountId) SetID 

func (s *AccountId) SetID(val string)

SetID sets the value of ID.

func (*AccountId) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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

func (c *Client) ValidateCredentials(ctx context.Context, request *AccountCredentials) (ValidateCredentialsRes, error)

ValidateCredentials invokes ValidateCredentials operation.

GET /account/credentials

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 Handler 

type Handler interface {
	// ValidateCredentials implements ValidateCredentials operation.
	//
	// GET /account/credentials
	ValidateCredentials(ctx context.Context, req *AccountCredentials) (ValidateCredentialsRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// ValidateCredentials invokes ValidateCredentials operation.
	//
	// GET /account/credentials
	ValidateCredentials(ctx context.Context, request *AccountCredentials) (ValidateCredentialsRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

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 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 UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) ValidateCredentials 

func (UnimplementedHandler) ValidateCredentials(ctx context.Context, req *AccountCredentials) (r ValidateCredentialsRes, _ error)

ValidateCredentials implements ValidateCredentials operation.

GET /account/credentials

type ValidateCredentialsBadRequest 

type ValidateCredentialsBadRequest Error

func (*ValidateCredentialsBadRequest) Decode 

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

Decode decodes ValidateCredentialsBadRequest from json.

func (*ValidateCredentialsBadRequest) Encode 

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

Encode encodes ValidateCredentialsBadRequest as json.

func (*ValidateCredentialsBadRequest) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ValidateCredentialsBadRequest) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ValidateCredentialsInternalServerError 

type ValidateCredentialsInternalServerError Error

func (*ValidateCredentialsInternalServerError) Decode 

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

Decode decodes ValidateCredentialsInternalServerError from json.

func (*ValidateCredentialsInternalServerError) Encode 

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

Encode encodes ValidateCredentialsInternalServerError as json.

func (*ValidateCredentialsInternalServerError) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ValidateCredentialsInternalServerError) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ValidateCredentialsRes 

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

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.