api

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Oct 16, 2024 License: Apache-2.0 Imports: 29 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 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) PublishEvent 

func (c *Client) PublishEvent(ctx context.Context, request OptEvent) (*Event, error)

PublishEvent invokes publishEvent operation.

POST /event

type ClientOption added in v0.55.0 

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 {
	Error string `json:"error"`
}

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

func (s *Error) GetError() string

GetError returns the value of Error.

func (*Error) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Error) SetError 

func (s *Error) SetError(val string)

SetError sets the value of Error.

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 Event 

type Event struct {
	ID      uuid.UUID `json:"id"`
	Message string    `json:"message"`
}

Ref: #/components/schemas/Event

func (*Event) Decode 

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

Decode decodes Event from json.

func (*Event) Encode 

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

Encode implements json.Marshaler.

func (*Event) GetID 

func (s *Event) GetID() uuid.UUID

GetID returns the value of ID.

func (*Event) GetMessage 

func (s *Event) GetMessage() string

GetMessage returns the value of Message.

func (*Event) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*Event) SetID 

func (s *Event) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*Event) SetMessage 

func (s *Event) SetMessage(val string)

SetMessage sets the value of Message.

func (*Event) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Handler 

type Handler interface {
	// PublishEvent implements publishEvent operation.
	//
	// POST /event
	PublishEvent(ctx context.Context, req OptEvent) (*Event, 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 added in v0.75.0 

type Invoker interface {
	// PublishEvent invokes publishEvent operation.
	//
	// POST /event
	PublishEvent(ctx context.Context, request OptEvent) (*Event, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler added in v1.1.0 

type Labeler struct {
	// contains filtered or unexported fields
}

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext added in v1.1.0 

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 added in v1.1.0 

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet added in v1.1.0 

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 OptEvent 

type OptEvent struct {
	Value Event
	Set   bool
}

OptEvent is optional Event.

func NewOptEvent 

func NewOptEvent(v Event) OptEvent

NewOptEvent returns new OptEvent with value set to v.

func (*OptEvent) Decode 

func (o *OptEvent) Decode(d *jx.Decoder) error

Decode decodes Event from json.

func (OptEvent) Encode 

func (o OptEvent) Encode(e *jx.Encoder)

Encode encodes Event as json.

func (OptEvent) Get 

func (o OptEvent) Get() (v Event, ok bool)

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

func (OptEvent) IsSet 

func (o OptEvent) IsSet() bool

IsSet returns true if OptEvent was set.

func (OptEvent) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (OptEvent) Or 

func (o OptEvent) Or(d Event) Event

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

func (*OptEvent) Reset 

func (o *OptEvent) Reset()

Reset unsets value.

func (*OptEvent) SetTo 

func (o *OptEvent) SetTo(v Event)

SetTo sets value to v.

func (*OptEvent) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

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

func (o *OptString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptString) Encode 

func (o OptString) Encode(e *jx.Encoder)

Encode encodes string as json.

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

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

MarshalJSON implements stdjson.Marshaler.

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.

func (*OptString) UnmarshalJSON 

func (s *OptString) 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 added in v0.58.0 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary added in v0.76.0 

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 added in v0.56.0 

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 added in v0.55.0 

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 StatusWebhookOK 

type StatusWebhookOK struct {
	Status OptString `json:"status"`
}

func (*StatusWebhookOK) Decode 

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

Decode decodes StatusWebhookOK from json.

func (*StatusWebhookOK) Encode 

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

Encode implements json.Marshaler.

func (*StatusWebhookOK) GetStatus 

func (s *StatusWebhookOK) GetStatus() OptString

GetStatus returns the value of Status.

func (*StatusWebhookOK) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*StatusWebhookOK) SetStatus 

func (s *StatusWebhookOK) SetStatus(val OptString)

SetStatus sets the value of Status.

func (*StatusWebhookOK) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

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

func (UnimplementedHandler) PublishEvent(ctx context.Context, req OptEvent) (r *Event, _ error)

PublishEvent implements publishEvent operation.

POST /event

func (UnimplementedHandler) StatusWebhook 

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

StatusWebhook implements statusWebhook operation.

func (UnimplementedHandler) UpdateDelete 

func (UnimplementedHandler) UpdateDelete(ctx context.Context) (r UpdateDeleteRes, _ error)

UpdateDelete implements DELETE update operation.

func (UnimplementedHandler) UpdateWebhook 

func (UnimplementedHandler) UpdateWebhook(ctx context.Context, req OptEvent, params UpdateWebhookParams) (r UpdateWebhookRes, _ error)

UpdateWebhook implements updateWebhook operation.

type UpdateDeleteOK 

type UpdateDeleteOK struct{}

UpdateDeleteOK is response for UpdateDelete operation.

type UpdateDeleteRes 

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

type UpdateWebhookParams 

type UpdateWebhookParams struct {
	EventType     string
	XWebhookToken OptString
}

UpdateWebhookParams is parameters of updateWebhook operation.

type UpdateWebhookRes 

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

type WebhookClient 

type WebhookClient struct {
	// contains filtered or unexported fields
}

WebhookClient implements webhook client.

func NewWebhookClient 

func NewWebhookClient(opts ...ClientOption) (*WebhookClient, error)

NewWebhookClient initializes new WebhookClient.

func (*WebhookClient) StatusWebhook 

func (c *WebhookClient) StatusWebhook(ctx context.Context, targetURL string) (*StatusWebhookOK, error)

StatusWebhook invokes statusWebhook operation.

func (*WebhookClient) UpdateDelete 

func (c *WebhookClient) UpdateDelete(ctx context.Context, targetURL string) (UpdateDeleteRes, error)

UpdateDelete invokes DELETE update operation.

func (*WebhookClient) UpdateWebhook 

func (c *WebhookClient) UpdateWebhook(ctx context.Context, targetURL string, request OptEvent, params UpdateWebhookParams) (UpdateWebhookRes, error)

UpdateWebhook invokes updateWebhook operation.

type WebhookHandler 

type WebhookHandler interface {
	// StatusWebhook implements statusWebhook operation.
	//
	StatusWebhook(ctx context.Context) (*StatusWebhookOK, error)
	// UpdateDelete implements DELETE update operation.
	//
	UpdateDelete(ctx context.Context) (UpdateDeleteRes, error)
	// UpdateWebhook implements updateWebhook operation.
	//
	UpdateWebhook(ctx context.Context, req OptEvent, params UpdateWebhookParams) (UpdateWebhookRes, error)
}

WebhookHandler handles webhooks described by OpenAPI v3 specification.

type WebhookResponse 

type WebhookResponse struct {
	ID        uuid.UUID `json:"id"`
	EventType OptString `json:"event_type"`
}

Ref: #/components/schemas/WebhookResponse

func (*WebhookResponse) Decode 

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

Decode decodes WebhookResponse from json.

func (*WebhookResponse) Encode 

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

Encode implements json.Marshaler.

func (*WebhookResponse) GetEventType 

func (s *WebhookResponse) GetEventType() OptString

GetEventType returns the value of EventType.

func (*WebhookResponse) GetID 

func (s *WebhookResponse) GetID() uuid.UUID

GetID returns the value of ID.

func (*WebhookResponse) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*WebhookResponse) SetEventType 

func (s *WebhookResponse) SetEventType(val OptString)

SetEventType sets the value of EventType.

func (*WebhookResponse) SetID 

func (s *WebhookResponse) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*WebhookResponse) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type WebhookServer 

type WebhookServer struct {
	// contains filtered or unexported fields
}

WebhookServer implements http server based on OpenAPI v3 specification and calls WebhookHandler to handle requests.

func NewWebhookServer 

func NewWebhookServer(h WebhookHandler, opts ...ServerOption) (*WebhookServer, error)

NewWebhookServer creates new WebhookServer.

func (*WebhookServer) Handle 

func (s *WebhookServer) Handle(webhookName string, w http.ResponseWriter, r *http.Request) bool

Handle handles webhook request.

Returns true if there is a webhook handler for given name and requested method.

func (*WebhookServer) Handler 

func (s *WebhookServer) Handler(webhookName string) http.Handler

Handler returns http.Handler for webhook.

Returns NotFound handler if spec doesn't contain webhook with given name.

Returned handler calls MethodNotAllowed handler if webhook doesn't define requested method.

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.