api

package
v0.0.0-...-7b7f83b Latest Latest
Warning

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

 Go to latest Published: Jan 12, 2024 License: Apache-2.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 AuthFound 

type AuthFound struct {
	Location  OptURI
	SetCookie string
}

AuthFound is response for Auth operation.

func (*AuthFound) GetLocation 

func (s *AuthFound) GetLocation() OptURI

GetLocation returns the value of Location.

func (*AuthFound) GetSetCookie 

func (s *AuthFound) GetSetCookie() string

GetSetCookie returns the value of SetCookie.

func (*AuthFound) SetLocation 

func (s *AuthFound) SetLocation(val OptURI)

SetLocation sets the value of Location.

func (*AuthFound) SetSetCookie 

func (s *AuthFound) SetSetCookie(val string)

SetSetCookie sets the value of SetCookie.

type AuthRes 

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

type CallbackParams 

type CallbackParams struct {
	// Code.
	Code string
	// State.
	QueryState  string
	CookieState string
}

CallbackParams is parameters of callback operation.

type CallbackRes 

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

type CallbackResponseSchema 

type CallbackResponseSchema struct {
	// Id_token.
	IDToken string `json:"id_token"`
	// Email.
	Email OptString `json:"email"`
	// Password.
	Password OptString `json:"password"`
}

Ref: #/components/schemas/CallbackResponseSchema

func (*CallbackResponseSchema) Decode 

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

Decode decodes CallbackResponseSchema from json.

func (*CallbackResponseSchema) Encode 

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

Encode implements json.Marshaler.

func (*CallbackResponseSchema) GetEmail 

func (s *CallbackResponseSchema) GetEmail() OptString

GetEmail returns the value of Email.

func (*CallbackResponseSchema) GetIDToken 

func (s *CallbackResponseSchema) GetIDToken() string

GetIDToken returns the value of IDToken.

func (*CallbackResponseSchema) GetPassword 

func (s *CallbackResponseSchema) GetPassword() OptString

GetPassword returns the value of Password.

func (*CallbackResponseSchema) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*CallbackResponseSchema) SetEmail 

func (s *CallbackResponseSchema) SetEmail(val OptString)

SetEmail sets the value of Email.

func (*CallbackResponseSchema) SetIDToken 

func (s *CallbackResponseSchema) SetIDToken(val string)

SetIDToken sets the value of IDToken.

func (*CallbackResponseSchema) SetPassword 

func (s *CallbackResponseSchema) SetPassword(val OptString)

SetPassword sets the value of Password.

func (*CallbackResponseSchema) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CallbackResponseSchema) Validate 

func (s *CallbackResponseSchema) Validate() error

type CallbackResponseSchemaHeaders 

type CallbackResponseSchemaHeaders struct {
	SetCookie string
	Response  CallbackResponseSchema
}

CallbackResponseSchemaHeaders wraps CallbackResponseSchema with response headers.

func (*CallbackResponseSchemaHeaders) GetResponse 

func (s *CallbackResponseSchemaHeaders) GetResponse() CallbackResponseSchema

GetResponse returns the value of Response.

func (*CallbackResponseSchemaHeaders) GetSetCookie 

func (s *CallbackResponseSchemaHeaders) GetSetCookie() string

GetSetCookie returns the value of SetCookie.

func (*CallbackResponseSchemaHeaders) SetResponse 

func (s *CallbackResponseSchemaHeaders) SetResponse(val CallbackResponseSchema)

SetResponse sets the value of Response.

func (*CallbackResponseSchemaHeaders) SetSetCookie 

func (s *CallbackResponseSchemaHeaders) SetSetCookie(val string)

SetSetCookie sets the value of SetCookie.

func (*CallbackResponseSchemaHeaders) Validate 

func (s *CallbackResponseSchemaHeaders) Validate() error

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

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

Auth invokes auth operation.

OIDC Authorization.

GET /auth

func (*Client) Callback 

func (c *Client) Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)

Callback invokes callback operation.

OIDC Callback.

GET /callback

func (*Client) Get 

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

Get invokes GET / operation.

Login.

GET /

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 ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ErrorResponse 

type ErrorResponse struct {
	Message string `json:"message"`
}

Ref: #/components/schemas/ErrorResponse

func (*ErrorResponse) Decode 

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

Decode decodes ErrorResponse from json.

func (*ErrorResponse) Encode 

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

Encode implements json.Marshaler.

func (*ErrorResponse) GetMessage 

func (s *ErrorResponse) GetMessage() string

GetMessage returns the value of Message.

func (*ErrorResponse) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponse) SetMessage 

func (s *ErrorResponse) SetMessage(val string)

SetMessage sets the value of Message.

func (*ErrorResponse) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorResponseHeaders 

type ErrorResponseHeaders struct {
	SetCookie string
	Response  ErrorResponse
}

ErrorResponseHeaders wraps ErrorResponse with response headers.

func (*ErrorResponseHeaders) GetResponse 

func (s *ErrorResponseHeaders) GetResponse() ErrorResponse

GetResponse returns the value of Response.

func (*ErrorResponseHeaders) GetSetCookie 

func (s *ErrorResponseHeaders) GetSetCookie() string

GetSetCookie returns the value of SetCookie.

func (*ErrorResponseHeaders) SetResponse 

func (s *ErrorResponseHeaders) SetResponse(val ErrorResponse)

SetResponse sets the value of Response.

func (*ErrorResponseHeaders) SetSetCookie 

func (s *ErrorResponseHeaders) SetSetCookie(val string)

SetSetCookie sets the value of SetCookie.

type GetOK 

type GetOK struct {
	Data io.Reader
}

func (GetOK) Read 

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

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type Handler 

type Handler interface {
	// Auth implements auth operation.
	//
	// OIDC Authorization.
	//
	// GET /auth
	Auth(ctx context.Context) (AuthRes, error)
	// Callback implements callback operation.
	//
	// OIDC Callback.
	//
	// GET /callback
	Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)
	// Get implements GET / operation.
	//
	// Login.
	//
	// GET /
	Get(ctx context.Context) (GetOK, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// Auth invokes auth operation.
	//
	// OIDC Authorization.
	//
	// GET /auth
	Auth(ctx context.Context) (AuthRes, error)
	// Callback invokes callback operation.
	//
	// OIDC Callback.
	//
	// GET /callback
	Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)
	// Get invokes GET / operation.
	//
	// Login.
	//
	// GET /
	Get(ctx context.Context) (GetOK, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

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 OptURI 

type OptURI struct {
	Value url.URL
	Set   bool
}

OptURI is optional url.URL.

func NewOptURI 

func NewOptURI(v url.URL) OptURI

NewOptURI returns new OptURI with value set to v.

func (OptURI) Get 

func (o OptURI) Get() (v url.URL, ok bool)

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

func (OptURI) IsSet 

func (o OptURI) IsSet() bool

IsSet returns true if OptURI was set.

func (OptURI) Or 

func (o OptURI) Or(d url.URL) url.URL

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

func (*OptURI) Reset 

func (o *OptURI) Reset()

Reset unsets value.

func (*OptURI) SetTo 

func (o *OptURI) SetTo(v url.URL)

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

func (UnimplementedHandler) Auth(ctx context.Context) (r AuthRes, _ error)

Auth implements auth operation.

OIDC Authorization.

GET /auth

func (UnimplementedHandler) Callback 

func (UnimplementedHandler) Callback(ctx context.Context, params CallbackParams) (r CallbackRes, _ error)

Callback implements callback operation.

OIDC Callback.

GET /callback

func (UnimplementedHandler) Get 

func (UnimplementedHandler) Get(ctx context.Context) (r GetOK, _ error)

Get implements GET / operation.

Login.

GET /

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.