api

package
v0.49.0 Latest Latest
Warning

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

 Go to latest Published: Sep 22, 2022 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AllRequestBodiesApplicationJSON 

type AllRequestBodiesApplicationJSON SimpleObject

func (*AllRequestBodiesApplicationJSON) Decode 

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

Decode decodes AllRequestBodiesApplicationJSON from json.

func (AllRequestBodiesApplicationJSON) Encode 

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

Encode encodes AllRequestBodiesApplicationJSON as json.

func (AllRequestBodiesApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AllRequestBodiesApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AllRequestBodiesApplicationXWwwFormUrlencoded 

type AllRequestBodiesApplicationXWwwFormUrlencoded SimpleObject

func (*AllRequestBodiesApplicationXWwwFormUrlencoded) Decode 

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

Decode decodes AllRequestBodiesApplicationXWwwFormUrlencoded from json.

func (AllRequestBodiesApplicationXWwwFormUrlencoded) Encode 

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

Encode encodes AllRequestBodiesApplicationXWwwFormUrlencoded as json.

func (AllRequestBodiesApplicationXWwwFormUrlencoded) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AllRequestBodiesApplicationXWwwFormUrlencoded) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AllRequestBodiesMultipartFormData 

type AllRequestBodiesMultipartFormData SimpleObject

func (*AllRequestBodiesMultipartFormData) Decode 

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

Decode decodes AllRequestBodiesMultipartFormData from json.

func (AllRequestBodiesMultipartFormData) Encode 

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

Encode encodes AllRequestBodiesMultipartFormData as json.

func (AllRequestBodiesMultipartFormData) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AllRequestBodiesMultipartFormData) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AllRequestBodiesOK 

type AllRequestBodiesOK struct {
	Data io.Reader
}

func (AllRequestBodiesOK) Read 

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

type AllRequestBodiesOptionalApplicationJSON 

type AllRequestBodiesOptionalApplicationJSON SimpleObject

func (*AllRequestBodiesOptionalApplicationJSON) Decode 

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

Decode decodes AllRequestBodiesOptionalApplicationJSON from json.

func (AllRequestBodiesOptionalApplicationJSON) Encode 

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

Encode encodes AllRequestBodiesOptionalApplicationJSON as json.

func (AllRequestBodiesOptionalApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AllRequestBodiesOptionalApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AllRequestBodiesOptionalApplicationXWwwFormUrlencoded 

type AllRequestBodiesOptionalApplicationXWwwFormUrlencoded SimpleObject

func (*AllRequestBodiesOptionalApplicationXWwwFormUrlencoded) Decode 

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

Decode decodes AllRequestBodiesOptionalApplicationXWwwFormUrlencoded from json.

func (AllRequestBodiesOptionalApplicationXWwwFormUrlencoded) Encode 

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

Encode encodes AllRequestBodiesOptionalApplicationXWwwFormUrlencoded as json.

func (AllRequestBodiesOptionalApplicationXWwwFormUrlencoded) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AllRequestBodiesOptionalApplicationXWwwFormUrlencoded) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AllRequestBodiesOptionalMultipartFormData 

type AllRequestBodiesOptionalMultipartFormData SimpleObject

func (*AllRequestBodiesOptionalMultipartFormData) Decode 

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

Decode decodes AllRequestBodiesOptionalMultipartFormData from json.

func (AllRequestBodiesOptionalMultipartFormData) Encode 

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

Encode encodes AllRequestBodiesOptionalMultipartFormData as json.

func (AllRequestBodiesOptionalMultipartFormData) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*AllRequestBodiesOptionalMultipartFormData) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type AllRequestBodiesOptionalOK 

type AllRequestBodiesOptionalOK struct {
	Data io.Reader
}

func (AllRequestBodiesOptionalOK) Read 

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

type AllRequestBodiesOptionalReq 

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

type AllRequestBodiesOptionalReqApplicationOctetStream 

type AllRequestBodiesOptionalReqApplicationOctetStream struct {
	Data io.Reader
}

func (AllRequestBodiesOptionalReqApplicationOctetStream) Read 

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

type AllRequestBodiesOptionalReqEmptyBody added in v0.49.0 

type AllRequestBodiesOptionalReqEmptyBody struct{}

type AllRequestBodiesOptionalReqTextPlain 

type AllRequestBodiesOptionalReqTextPlain struct {
	Data io.Reader
}

func (AllRequestBodiesOptionalReqTextPlain) Read 

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

type AllRequestBodiesReq 

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

type AllRequestBodiesReqApplicationOctetStream 

type AllRequestBodiesReqApplicationOctetStream struct {
	Data io.Reader
}

func (AllRequestBodiesReqApplicationOctetStream) Read 

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

type AllRequestBodiesReqTextPlain 

type AllRequestBodiesReqTextPlain struct {
	Data io.Reader
}

func (AllRequestBodiesReqTextPlain) Read 

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

type Client 

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

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, opts ...Option) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) AllRequestBodies 

func (c *Client) AllRequestBodies(ctx context.Context, request AllRequestBodiesReq) (res AllRequestBodiesOK, err error)

AllRequestBodies invokes allRequestBodies operation.

POST /allRequestBodies

func (*Client) AllRequestBodiesOptional 

func (c *Client) AllRequestBodiesOptional(ctx context.Context, request AllRequestBodiesOptionalReq) (res AllRequestBodiesOptionalOK, err error)

AllRequestBodiesOptional invokes allRequestBodiesOptional operation.

POST /allRequestBodiesOptional

func (*Client) MaskContentType added in v0.48.0 

func (c *Client) MaskContentType(ctx context.Context, request MaskContentTypeReqWithContentType) (res MaskResponse, err error)

MaskContentType invokes maskContentType operation.

POST /maskContentType

func (*Client) MaskContentTypeOptional added in v0.48.0 

func (c *Client) MaskContentTypeOptional(ctx context.Context, request MaskContentTypeOptionalReqWithContentType) (res MaskResponse, err error)

MaskContentTypeOptional invokes maskContentTypeOptional operation.

POST /maskContentTypeOptional

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler 

type Handler interface {
	// AllRequestBodies implements allRequestBodies operation.
	//
	// POST /allRequestBodies
	AllRequestBodies(ctx context.Context, req AllRequestBodiesReq) (AllRequestBodiesOK, error)
	// AllRequestBodiesOptional implements allRequestBodiesOptional operation.
	//
	// POST /allRequestBodiesOptional
	AllRequestBodiesOptional(ctx context.Context, req AllRequestBodiesOptionalReq) (AllRequestBodiesOptionalOK, error)
	// MaskContentType implements maskContentType operation.
	//
	// POST /maskContentType
	MaskContentType(ctx context.Context, req MaskContentTypeReqWithContentType) (MaskResponse, error)
	// MaskContentTypeOptional implements maskContentTypeOptional operation.
	//
	// POST /maskContentTypeOptional
	MaskContentTypeOptional(ctx context.Context, req MaskContentTypeOptionalReqWithContentType) (MaskResponse, error)
}

Handler handles operations described by OpenAPI v3 specification.

type MaskContentTypeOptionalReq added in v0.48.0 

type MaskContentTypeOptionalReq struct {
	Data io.Reader
}

func (MaskContentTypeOptionalReq) Read added in v0.48.0 

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

type MaskContentTypeOptionalReqWithContentType added in v0.48.0 

type MaskContentTypeOptionalReqWithContentType struct {
	ContentType string
	Content     MaskContentTypeOptionalReq
}

MaskContentTypeOptionalReqWithContentType wraps MaskContentTypeOptionalReq with Content-Type.

type MaskContentTypeReq added in v0.48.0 

type MaskContentTypeReq struct {
	Data io.Reader
}

func (MaskContentTypeReq) Read added in v0.48.0 

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

type MaskContentTypeReqWithContentType added in v0.48.0 

type MaskContentTypeReqWithContentType struct {
	ContentType string
	Content     MaskContentTypeReq
}

MaskContentTypeReqWithContentType wraps MaskContentTypeReq with Content-Type.

type MaskResponse added in v0.48.0 

type MaskResponse struct {
	ContentType string "json:\"contentType\""
	Content     string "json:\"content\""
}

Ref: #/components/schemas/MaskResponse

func (*MaskResponse) Decode added in v0.48.0 

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

Decode decodes MaskResponse from json.

func (MaskResponse) Encode added in v0.48.0 

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

Encode implements json.Marshaler.

func (MaskResponse) MarshalJSON added in v0.48.0 

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

MarshalJSON implements stdjson.Marshaler.

func (*MaskResponse) UnmarshalJSON added in v0.48.0 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Middleware added in v0.49.0 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OptInt 

type OptInt struct {
	Value int
	Set   bool
}

OptInt is optional int.

func NewOptInt 

func NewOptInt(v int) OptInt

NewOptInt returns new OptInt with value set to v.

func (*OptInt) Decode 

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

Decode decodes int from json.

func (OptInt) Encode 

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

Encode encodes int as json.

func (OptInt) Get 

func (o OptInt) Get() (v int, ok bool)

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

func (OptInt) IsSet 

func (o OptInt) IsSet() bool

IsSet returns true if OptInt was set.

func (OptInt) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (OptInt) Or 

func (o OptInt) Or(d int) int

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

func (*OptInt) Reset 

func (o *OptInt) Reset()

Reset unsets value.

func (*OptInt) SetTo 

func (o *OptInt) SetTo(v int)

SetTo sets value to v.

func (*OptInt) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

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

func WithClient 

func WithClient(client ht.Client) Option

WithClient specifies http client to use.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) Option

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) Option

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 WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the metric.NewNoopMeterProvider is used.

func WithMethodNotAllowed added in v0.46.0 

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) Option

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware added in v0.49.0 

func WithMiddleware(m ...Middleware) Option

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) Option

WithNotFound specifies Not Found handler to use.

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

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.

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 ...Option) (*Server, error)

NewServer creates new Server.

func (*Server) FindRoute 

func (s *Server) FindRoute(method, path string) (r Route, _ bool)

FindRoute finds Route for given method and path.

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 SimpleObject 

type SimpleObject struct {
	Name string "json:\"name\""
	Age  OptInt "json:\"age\""
}

Ref: #/components/schemas/SimpleObject

func (*SimpleObject) Decode 

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

Decode decodes SimpleObject from json.

func (SimpleObject) Encode 

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

Encode implements json.Marshaler.

func (SimpleObject) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*SimpleObject) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type UnimplementedHandler 

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) AllRequestBodies 

func (UnimplementedHandler) AllRequestBodies(ctx context.Context, req AllRequestBodiesReq) (r AllRequestBodiesOK, _ error)

AllRequestBodies implements allRequestBodies operation.

POST /allRequestBodies

func (UnimplementedHandler) AllRequestBodiesOptional 

func (UnimplementedHandler) AllRequestBodiesOptional(ctx context.Context, req AllRequestBodiesOptionalReq) (r AllRequestBodiesOptionalOK, _ error)

AllRequestBodiesOptional implements allRequestBodiesOptional operation.

POST /allRequestBodiesOptional

func (UnimplementedHandler) MaskContentType added in v0.48.0 

func (UnimplementedHandler) MaskContentType(ctx context.Context, req MaskContentTypeReqWithContentType) (r MaskResponse, _ error)

MaskContentType implements maskContentType operation.

POST /maskContentType

func (UnimplementedHandler) MaskContentTypeOptional added in v0.48.0 

func (UnimplementedHandler) MaskContentTypeOptional(ctx context.Context, req MaskContentTypeOptionalReqWithContentType) (r MaskResponse, _ error)

MaskContentTypeOptional implements maskContentTypeOptional operation.

POST /maskContentTypeOptional

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.