oas

package
v0.0.0-...-b22dccf Latest Latest
Warning

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

 Go to latest Published: Dec 15, 2024 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

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

func (c *Client) GetTelegramBadge(ctx context.Context, params GetTelegramBadgeParams) (*SVGHeaders, error)

GetTelegramBadge invokes getTelegramBadge operation.

Get svg badge for telegram group.

GET /badge/telegram/{group_name}

func (*Client) GetTelegramOnlineBadge 

func (c *Client) GetTelegramOnlineBadge(ctx context.Context, params GetTelegramOnlineBadgeParams) (*SVGHeaders, error)

GetTelegramOnlineBadge invokes getTelegramOnlineBadge operation.

GET /badge/telegram/online

func (*Client) Status 

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

Status invokes status operation.

Get status.

GET /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 {
	Message string `json:"message"`
}

Error description. 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) SetFake 

func (s *Error) SetFake()

SetFake set fake values.

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 GetTelegramBadgeParams 

type GetTelegramBadgeParams struct {
	Title     OptString
	GroupName string
}

GetTelegramBadgeParams is parameters of getTelegramBadge operation.

type GetTelegramOnlineBadgeParams 

type GetTelegramOnlineBadgeParams struct {
	Groups []string
}

GetTelegramOnlineBadgeParams is parameters of getTelegramOnlineBadge operation.

type Handler 

type Handler interface {
	// GetTelegramBadge implements getTelegramBadge operation.
	//
	// Get svg badge for telegram group.
	//
	// GET /badge/telegram/{group_name}
	GetTelegramBadge(ctx context.Context, params GetTelegramBadgeParams) (*SVGHeaders, error)
	// GetTelegramOnlineBadge implements getTelegramOnlineBadge operation.
	//
	// GET /badge/telegram/online
	GetTelegramOnlineBadge(ctx context.Context, params GetTelegramOnlineBadgeParams) (*SVGHeaders, error)
	// Status implements status operation.
	//
	// Get status.
	//
	// GET /status
	Status(ctx context.Context) (*Status, 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 Invoker 

type Invoker interface {
	// GetTelegramBadge invokes getTelegramBadge operation.
	//
	// Get svg badge for telegram group.
	//
	// GET /badge/telegram/{group_name}
	GetTelegramBadge(ctx context.Context, params GetTelegramBadgeParams) (*SVGHeaders, error)
	// GetTelegramOnlineBadge invokes getTelegramOnlineBadge operation.
	//
	// GET /badge/telegram/online
	GetTelegramOnlineBadge(ctx context.Context, params GetTelegramOnlineBadgeParams) (*SVGHeaders, error)
	// Status invokes status operation.
	//
	// Get status.
	//
	// GET /status
	Status(ctx context.Context) (*Status, 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 (
	GetTelegramBadgeOperation       OperationName = "GetTelegramBadge"
	GetTelegramOnlineBadgeOperation OperationName = "GetTelegramOnlineBadge"
	StatusOperation                 OperationName = "Status"
)

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

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 SVG 

type SVG struct {
	Data io.Reader
}

func (SVG) Read 

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

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type SVGHeaders 

type SVGHeaders struct {
	CacheControl OptString
	ETag         OptString
	Response     SVG
}

SVGHeaders wraps SVG with response headers.

func (*SVGHeaders) GetCacheControl 

func (s *SVGHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*SVGHeaders) GetETag 

func (s *SVGHeaders) GetETag() OptString

GetETag returns the value of ETag.

func (*SVGHeaders) GetResponse 

func (s *SVGHeaders) GetResponse() SVG

GetResponse returns the value of Response.

func (*SVGHeaders) SetCacheControl 

func (s *SVGHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*SVGHeaders) SetETag 

func (s *SVGHeaders) SetETag(val OptString)

SetETag sets the value of ETag.

func (*SVGHeaders) SetResponse 

func (s *SVGHeaders) SetResponse(val SVG)

SetResponse sets the value of Response.

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 Statistics 

type Statistics struct {
	// Total commits.
	TotalCommits int `json:"total_commits"`
	// Top users.
	TopUsers []UserStat `json:"top_users"`
}

Statistics. Ref: #/components/schemas/Statistics

func (*Statistics) Decode 

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

Decode decodes Statistics from json.

func (*Statistics) Encode 

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

Encode implements json.Marshaler.

func (*Statistics) GetTopUsers 

func (s *Statistics) GetTopUsers() []UserStat

GetTopUsers returns the value of TopUsers.

func (*Statistics) GetTotalCommits 

func (s *Statistics) GetTotalCommits() int

GetTotalCommits returns the value of TotalCommits.

func (*Statistics) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Statistics) SetFake 

func (s *Statistics) SetFake()

SetFake set fake values.

func (*Statistics) SetTopUsers 

func (s *Statistics) SetTopUsers(val []UserStat)

SetTopUsers sets the value of TopUsers.

func (*Statistics) SetTotalCommits 

func (s *Statistics) SetTotalCommits(val int)

SetTotalCommits sets the value of TotalCommits.

func (*Statistics) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Statistics) Validate 

func (s *Statistics) Validate() error

type Status 

type Status struct {
	// Message.
	Message string     `json:"message"`
	Stat    Statistics `json:"stat"`
}

Status. Ref: #/components/schemas/Status

func (*Status) Decode 

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

Decode decodes Status from json.

func (*Status) Encode 

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

Encode implements json.Marshaler.

func (*Status) GetMessage 

func (s *Status) GetMessage() string

GetMessage returns the value of Message.

func (*Status) GetStat 

func (s *Status) GetStat() Statistics

GetStat returns the value of Stat.

func (*Status) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Status) SetFake 

func (s *Status) SetFake()

SetFake set fake values.

func (*Status) SetMessage 

func (s *Status) SetMessage(val string)

SetMessage sets the value of Message.

func (*Status) SetStat 

func (s *Status) SetStat(val Statistics)

SetStat sets the value of Stat.

func (*Status) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Status) Validate 

func (s *Status) Validate() error

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) GetTelegramBadge 

func (UnimplementedHandler) GetTelegramBadge(ctx context.Context, params GetTelegramBadgeParams) (r *SVGHeaders, _ error)

GetTelegramBadge implements getTelegramBadge operation.

Get svg badge for telegram group.

GET /badge/telegram/{group_name}

func (UnimplementedHandler) GetTelegramOnlineBadge 

func (UnimplementedHandler) GetTelegramOnlineBadge(ctx context.Context, params GetTelegramOnlineBadgeParams) (r *SVGHeaders, _ error)

GetTelegramOnlineBadge implements getTelegramOnlineBadge operation.

GET /badge/telegram/online

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

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

Status implements status operation.

Get status.

GET /status

type User 

type User struct {
	// User ID.
	ID int64 `json:"id"`
	// User name.
	Nickname string `json:"nickname"`
	// User full name.
	FullName string `json:"full_name"`
	// User avatar URL.
	AvatarURL url.URL `json:"avatar_url"`
	// User profile URL.
	HTMLURL url.URL `json:"html_url"`
}

Ref: #/components/schemas/User

func (*User) Decode 

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

Decode decodes User from json.

func (*User) Encode 

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

Encode implements json.Marshaler.

func (*User) GetAvatarURL 

func (s *User) GetAvatarURL() url.URL

GetAvatarURL returns the value of AvatarURL.

func (*User) GetFullName 

func (s *User) GetFullName() string

GetFullName returns the value of FullName.

func (*User) GetHTMLURL 

func (s *User) GetHTMLURL() url.URL

GetHTMLURL returns the value of HTMLURL.

func (*User) GetID 

func (s *User) GetID() int64

GetID returns the value of ID.

func (*User) GetNickname 

func (s *User) GetNickname() string

GetNickname returns the value of Nickname.

func (*User) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*User) SetAvatarURL 

func (s *User) SetAvatarURL(val url.URL)

SetAvatarURL sets the value of AvatarURL.

func (*User) SetFake 

func (s *User) SetFake()

SetFake set fake values.

func (*User) SetFullName 

func (s *User) SetFullName(val string)

SetFullName sets the value of FullName.

func (*User) SetHTMLURL 

func (s *User) SetHTMLURL(val url.URL)

SetHTMLURL sets the value of HTMLURL.

func (*User) SetID 

func (s *User) SetID(val int64)

SetID sets the value of ID.

func (*User) SetNickname 

func (s *User) SetNickname(val string)

SetNickname sets the value of Nickname.

func (*User) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type UserStat 

type UserStat struct {
	User User `json:"user"`
	// Total commits.
	TotalCommits int `json:"total_commits"`
}

User statistics. Ref: #/components/schemas/UserStat

func (*UserStat) Decode 

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

Decode decodes UserStat from json.

func (*UserStat) Encode 

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

Encode implements json.Marshaler.

func (*UserStat) GetTotalCommits 

func (s *UserStat) GetTotalCommits() int

GetTotalCommits returns the value of TotalCommits.

func (*UserStat) GetUser 

func (s *UserStat) GetUser() User

GetUser returns the value of User.

func (*UserStat) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*UserStat) SetFake 

func (s *UserStat) SetFake()

SetFake set fake values.

func (*UserStat) SetTotalCommits 

func (s *UserStat) SetTotalCommits(val int)

SetTotalCommits sets the value of TotalCommits.

func (*UserStat) SetUser 

func (s *UserStat) SetUser(val User)

SetUser sets the value of User.

func (*UserStat) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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.