api

package
v1.23.0 Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2026 License: Apache-2.0 Imports: 22 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) ListDesktops 

func (c *Client) ListDesktops(ctx context.Context, params ListDesktopsParams) (DesktopImageType, error)

ListDesktops invokes listDesktops operation.

GET /desktops

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 DesktopImageType 

type DesktopImageType string

Ref: #/components/schemas/DesktopImageType 

const (
	DesktopImageTypeStock DesktopImageType = "stock"
	DesktopImageTypeUser  DesktopImageType = "user"
)

func (DesktopImageType) AllValues 

func (DesktopImageType) AllValues() []DesktopImageType

AllValues returns all DesktopImageType values.

func (*DesktopImageType) Decode 

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

Decode decodes DesktopImageType from json.

func (DesktopImageType) Encode 

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

Encode encodes DesktopImageType as json.

func (DesktopImageType) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (DesktopImageType) MarshalText 

func (s DesktopImageType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DesktopImageType) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DesktopImageType) UnmarshalText 

func (s *DesktopImageType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DesktopImageType) Validate 

func (s DesktopImageType) Validate() error

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler 

type Handler interface {
	// ListDesktops implements listDesktops operation.
	//
	// GET /desktops
	ListDesktops(ctx context.Context, params ListDesktopsParams) (DesktopImageType, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// ListDesktops invokes listDesktops operation.
	//
	// GET /desktops
	ListDesktops(ctx context.Context, params ListDesktopsParams) (DesktopImageType, 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 ListDesktopsParams 

type ListDesktopsParams struct {
	// Image type filter: 'stock', 'user', or omit for both.
	ImageType OptNilDesktopImageType `json:",omitempty,omitzero"`
	DesktopID OptNilString           `json:",omitempty,omitzero"`
	XTraceID  OptNilString           `json:",omitempty,omitzero"`
}

ListDesktopsParams is parameters of listDesktops operation.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	ListDesktopsOperation OperationName = "ListDesktops"
)

type OptNilDesktopImageType 

type OptNilDesktopImageType struct {
	Value DesktopImageType
	Set   bool
	Null  bool
}

OptNilDesktopImageType is optional nullable DesktopImageType.

func NewOptNilDesktopImageType 

func NewOptNilDesktopImageType(v DesktopImageType) OptNilDesktopImageType

NewOptNilDesktopImageType returns new OptNilDesktopImageType with value set to v.

func (OptNilDesktopImageType) Get 

func (o OptNilDesktopImageType) Get() (v DesktopImageType, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilDesktopImageType) IsEmpty 

func (o OptNilDesktopImageType) IsEmpty() bool

IsEmpty returns true if the field was omitted from the payload (not Set and not Null).

func (OptNilDesktopImageType) IsNull 

func (o OptNilDesktopImageType) IsNull() bool

IsNull returns true if value is Null.

func (OptNilDesktopImageType) IsSet 

func (o OptNilDesktopImageType) IsSet() bool

IsSet returns true if OptNilDesktopImageType was set.

func (OptNilDesktopImageType) Or 

func (o OptNilDesktopImageType) Or(d DesktopImageType) DesktopImageType

Or returns value if set, or given parameter if does not.

func (*OptNilDesktopImageType) Reset 

func (o *OptNilDesktopImageType) Reset()

Reset unsets value.

func (*OptNilDesktopImageType) SetTo 

func (o *OptNilDesktopImageType) SetTo(v DesktopImageType)

SetTo sets value to v.

func (*OptNilDesktopImageType) SetToNull 

func (o *OptNilDesktopImageType) SetToNull()

SetToNull sets value to null.

type OptNilString 

type OptNilString struct {
	Value string
	Set   bool
	Null  bool
}

OptNilString is optional nullable string.

func NewOptNilString 

func NewOptNilString(v string) OptNilString

NewOptNilString returns new OptNilString with value set to v.

func (OptNilString) Get 

func (o OptNilString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilString) IsEmpty 

func (o OptNilString) IsEmpty() bool

IsEmpty returns true if the field was omitted from the payload (not Set and not Null).

func (OptNilString) IsNull 

func (o OptNilString) IsNull() bool

IsNull returns true if value is Null.

func (OptNilString) IsSet 

func (o OptNilString) IsSet() bool

IsSet returns true if OptNilString was set.

func (OptNilString) Or 

func (o OptNilString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptNilString) Reset 

func (o *OptNilString) Reset()

Reset unsets value.

func (*OptNilString) SetTo 

func (o *OptNilString) SetTo(v string)

SetTo sets value to v.

func (*OptNilString) SetToNull 

func (o *OptNilString) SetToNull()

SetToNull sets value to null.

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

func (UnimplementedHandler) ListDesktops(ctx context.Context, params ListDesktopsParams) (r DesktopImageType, _ error)

ListDesktops implements listDesktops operation.

GET /desktops

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.