api

package
v0.57.0 Latest Latest
Warning

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

Go to latest
Published: Jan 23, 2023 License: Apache-2.0 Imports: 28 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) TestFormURLEncoded

func (c *Client) TestFormURLEncoded(ctx context.Context, request *TestForm) error

TestFormURLEncoded invokes testFormURLEncoded operation.

POST /testFormURLEncoded

func (*Client) TestMultipart

func (c *Client) TestMultipart(ctx context.Context, request *TestForm) error

TestMultipart invokes testMultipart operation.

POST /testMultipart

func (*Client) TestMultipartUpload

func (c *Client) TestMultipartUpload(ctx context.Context, request *TestMultipartUploadReqForm) (*TestMultipartUploadOK, error)

TestMultipartUpload invokes testMultipartUpload operation.

POST /testMultipartUpload

func (*Client) TestShareFormSchema

func (c *Client) TestShareFormSchema(ctx context.Context, request TestShareFormSchemaReq) error

TestShareFormSchema invokes testShareFormSchema operation.

POST /testShareFormSchema

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 ErrorHandler

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler

type Handler interface {
	// TestFormURLEncoded implements testFormURLEncoded operation.
	//
	// POST /testFormURLEncoded
	TestFormURLEncoded(ctx context.Context, req *TestForm) error
	// TestMultipart implements testMultipart operation.
	//
	// POST /testMultipart
	TestMultipart(ctx context.Context, req *TestForm) error
	// TestMultipartUpload implements testMultipartUpload operation.
	//
	// POST /testMultipartUpload
	TestMultipartUpload(ctx context.Context, req *TestMultipartUploadReqForm) (*TestMultipartUploadOK, error)
	// TestShareFormSchema implements testShareFormSchema operation.
	//
	// POST /testShareFormSchema
	TestShareFormSchema(ctx context.Context, req TestShareFormSchemaReq) error
}

Handler handles operations described by OpenAPI v3 specification.

type Middleware

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

type OptMultipartFile

type OptMultipartFile struct {
	Value ht.MultipartFile
	Set   bool
}

OptMultipartFile is optional ht.MultipartFile.

func NewOptMultipartFile

func NewOptMultipartFile(v ht.MultipartFile) OptMultipartFile

NewOptMultipartFile returns new OptMultipartFile with value set to v.

func (OptMultipartFile) Get

func (o OptMultipartFile) Get() (v ht.MultipartFile, ok bool)

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

func (OptMultipartFile) IsSet

func (o OptMultipartFile) IsSet() bool

IsSet returns true if OptMultipartFile was set.

func (OptMultipartFile) Or

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

func (*OptMultipartFile) Reset

func (o *OptMultipartFile) Reset()

Reset unsets value.

func (*OptMultipartFile) SetTo

func (o *OptMultipartFile) SetTo(v ht.MultipartFile)

SetTo sets value to v.

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 OptTestFormDeepObject

type OptTestFormDeepObject struct {
	Value TestFormDeepObject
	Set   bool
}

OptTestFormDeepObject is optional TestFormDeepObject.

func NewOptTestFormDeepObject

func NewOptTestFormDeepObject(v TestFormDeepObject) OptTestFormDeepObject

NewOptTestFormDeepObject returns new OptTestFormDeepObject with value set to v.

func (OptTestFormDeepObject) Get

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

func (OptTestFormDeepObject) IsSet

func (o OptTestFormDeepObject) IsSet() bool

IsSet returns true if OptTestFormDeepObject was set.

func (OptTestFormDeepObject) Or

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

func (*OptTestFormDeepObject) Reset

func (o *OptTestFormDeepObject) Reset()

Reset unsets value.

func (*OptTestFormDeepObject) SetTo

SetTo sets value to v.

type OptTestFormObject

type OptTestFormObject struct {
	Value TestFormObject
	Set   bool
}

OptTestFormObject is optional TestFormObject.

func NewOptTestFormObject

func NewOptTestFormObject(v TestFormObject) OptTestFormObject

NewOptTestFormObject returns new OptTestFormObject with value set to v.

func (OptTestFormObject) Get

func (o OptTestFormObject) Get() (v TestFormObject, ok bool)

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

func (OptTestFormObject) IsSet

func (o OptTestFormObject) IsSet() bool

IsSet returns true if OptTestFormObject was set.

func (OptTestFormObject) Or

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

func (*OptTestFormObject) Reset

func (o *OptTestFormObject) Reset()

Reset unsets value.

func (*OptTestFormObject) SetTo

func (o *OptTestFormObject) SetTo(v TestFormObject)

SetTo sets value to v.

type OptUUID

type OptUUID struct {
	Value uuid.UUID
	Set   bool
}

OptUUID is optional uuid.UUID.

func NewOptUUID

func NewOptUUID(v uuid.UUID) OptUUID

NewOptUUID returns new OptUUID with value set to v.

func (OptUUID) Get

func (o OptUUID) Get() (v uuid.UUID, ok bool)

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

func (OptUUID) IsSet

func (o OptUUID) IsSet() bool

IsSet returns true if OptUUID was set.

func (OptUUID) Or

func (o OptUUID) Or(d uuid.UUID) uuid.UUID

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

func (*OptUUID) Reset

func (o *OptUUID) Reset()

Reset unsets value.

func (*OptUUID) SetTo

func (o *OptUUID) SetTo(v uuid.UUID)

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 metric.NewNoopMeterProvider 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.

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 SharedRequest

type SharedRequest struct {
	Filename OptString `json:"filename"`
	File     OptString `json:"file"`
}

Ref: #/components/schemas/SharedRequest

func (*SharedRequest) Decode

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

Decode decodes SharedRequest from json.

func (*SharedRequest) Encode

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

Encode implements json.Marshaler.

func (*SharedRequest) GetFile

func (s *SharedRequest) GetFile() OptString

GetFile returns the value of File.

func (*SharedRequest) GetFilename

func (s *SharedRequest) GetFilename() OptString

GetFilename returns the value of Filename.

func (*SharedRequest) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*SharedRequest) SetFile

func (s *SharedRequest) SetFile(val OptString)

SetFile sets the value of File.

func (*SharedRequest) SetFilename

func (s *SharedRequest) SetFilename(val OptString)

SetFilename sets the value of Filename.

func (*SharedRequest) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type SharedRequestForm

type SharedRequestForm struct {
	Filename OptString        `json:"filename"`
	File     OptMultipartFile `json:"file"`
}

Ref: #/components/schemas/SharedRequest

func (*SharedRequestForm) GetFile

func (s *SharedRequestForm) GetFile() OptMultipartFile

GetFile returns the value of File.

func (*SharedRequestForm) GetFilename

func (s *SharedRequestForm) GetFilename() OptString

GetFilename returns the value of Filename.

func (*SharedRequestForm) SetFile

func (s *SharedRequestForm) SetFile(val OptMultipartFile)

SetFile sets the value of File.

func (*SharedRequestForm) SetFilename

func (s *SharedRequestForm) SetFilename(val OptString)

SetFilename sets the value of Filename.

type TestForm

type TestForm struct {
	ID          OptInt                `json:"id"`
	UUID        OptUUID               `json:"uuid"`
	Description string                `json:"description"`
	Array       []string              `json:"array"`
	Object      OptTestFormObject     `json:"object"`
	DeepObject  OptTestFormDeepObject `json:"deepObject"`
}

Ref: #/components/schemas/TestForm

func (*TestForm) GetArray

func (s *TestForm) GetArray() []string

GetArray returns the value of Array.

func (*TestForm) GetDeepObject

func (s *TestForm) GetDeepObject() OptTestFormDeepObject

GetDeepObject returns the value of DeepObject.

func (*TestForm) GetDescription

func (s *TestForm) GetDescription() string

GetDescription returns the value of Description.

func (*TestForm) GetID

func (s *TestForm) GetID() OptInt

GetID returns the value of ID.

func (*TestForm) GetObject

func (s *TestForm) GetObject() OptTestFormObject

GetObject returns the value of Object.

func (*TestForm) GetUUID

func (s *TestForm) GetUUID() OptUUID

GetUUID returns the value of UUID.

func (*TestForm) SetArray

func (s *TestForm) SetArray(val []string)

SetArray sets the value of Array.

func (*TestForm) SetDeepObject

func (s *TestForm) SetDeepObject(val OptTestFormDeepObject)

SetDeepObject sets the value of DeepObject.

func (*TestForm) SetDescription

func (s *TestForm) SetDescription(val string)

SetDescription sets the value of Description.

func (*TestForm) SetID

func (s *TestForm) SetID(val OptInt)

SetID sets the value of ID.

func (*TestForm) SetObject

func (s *TestForm) SetObject(val OptTestFormObject)

SetObject sets the value of Object.

func (*TestForm) SetUUID

func (s *TestForm) SetUUID(val OptUUID)

SetUUID sets the value of UUID.

type TestFormDeepObject

type TestFormDeepObject struct {
	Min OptInt `json:"min"`
	Max int    `json:"max"`
}

func (*TestFormDeepObject) DecodeURI

func (s *TestFormDeepObject) DecodeURI(d uri.Decoder) error

DecodeURI decodes TestFormDeepObject from URI form.

func (*TestFormDeepObject) EncodeURI

func (s *TestFormDeepObject) EncodeURI(e uri.Encoder) error

EncodeURI encodes TestFormDeepObject as URI form.

func (*TestFormDeepObject) GetMax

func (s *TestFormDeepObject) GetMax() int

GetMax returns the value of Max.

func (*TestFormDeepObject) GetMin

func (s *TestFormDeepObject) GetMin() OptInt

GetMin returns the value of Min.

func (*TestFormDeepObject) SetMax

func (s *TestFormDeepObject) SetMax(val int)

SetMax sets the value of Max.

func (*TestFormDeepObject) SetMin

func (s *TestFormDeepObject) SetMin(val OptInt)

SetMin sets the value of Min.

type TestFormObject

type TestFormObject struct {
	Min OptInt `json:"min"`
	Max int    `json:"max"`
}

func (*TestFormObject) DecodeURI

func (s *TestFormObject) DecodeURI(d uri.Decoder) error

DecodeURI decodes TestFormObject from URI form.

func (*TestFormObject) EncodeURI

func (s *TestFormObject) EncodeURI(e uri.Encoder) error

EncodeURI encodes TestFormObject as URI form.

func (*TestFormObject) GetMax

func (s *TestFormObject) GetMax() int

GetMax returns the value of Max.

func (*TestFormObject) GetMin

func (s *TestFormObject) GetMin() OptInt

GetMin returns the value of Min.

func (*TestFormObject) SetMax

func (s *TestFormObject) SetMax(val int)

SetMax sets the value of Max.

func (*TestFormObject) SetMin

func (s *TestFormObject) SetMin(val OptInt)

SetMin sets the value of Min.

type TestFormURLEncodedOK

type TestFormURLEncodedOK struct{}

TestFormURLEncodedOK is response for TestFormURLEncoded operation.

type TestMultipartOK

type TestMultipartOK struct{}

TestMultipartOK is response for TestMultipart operation.

type TestMultipartUploadOK

type TestMultipartUploadOK struct {
	File         string    `json:"file"`
	OptionalFile OptString `json:"optional_file"`
	Files        []string  `json:"files"`
}

func (*TestMultipartUploadOK) Decode

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

Decode decodes TestMultipartUploadOK from json.

func (*TestMultipartUploadOK) Encode

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

Encode implements json.Marshaler.

func (*TestMultipartUploadOK) GetFile

func (s *TestMultipartUploadOK) GetFile() string

GetFile returns the value of File.

func (*TestMultipartUploadOK) GetFiles

func (s *TestMultipartUploadOK) GetFiles() []string

GetFiles returns the value of Files.

func (*TestMultipartUploadOK) GetOptionalFile

func (s *TestMultipartUploadOK) GetOptionalFile() OptString

GetOptionalFile returns the value of OptionalFile.

func (*TestMultipartUploadOK) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*TestMultipartUploadOK) SetFile

func (s *TestMultipartUploadOK) SetFile(val string)

SetFile sets the value of File.

func (*TestMultipartUploadOK) SetFiles

func (s *TestMultipartUploadOK) SetFiles(val []string)

SetFiles sets the value of Files.

func (*TestMultipartUploadOK) SetOptionalFile

func (s *TestMultipartUploadOK) SetOptionalFile(val OptString)

SetOptionalFile sets the value of OptionalFile.

func (*TestMultipartUploadOK) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestMultipartUploadOK) Validate

func (s *TestMultipartUploadOK) Validate() error

type TestMultipartUploadReq

type TestMultipartUploadReq struct {
	OrderId      OptInt    `json:"orderId"`
	UserId       OptInt    `json:"userId"`
	File         string    `json:"file"`
	OptionalFile OptString `json:"optional_file"`
	Files        []string  `json:"files"`
}

func (*TestMultipartUploadReq) GetFile

func (s *TestMultipartUploadReq) GetFile() string

GetFile returns the value of File.

func (*TestMultipartUploadReq) GetFiles

func (s *TestMultipartUploadReq) GetFiles() []string

GetFiles returns the value of Files.

func (*TestMultipartUploadReq) GetOptionalFile

func (s *TestMultipartUploadReq) GetOptionalFile() OptString

GetOptionalFile returns the value of OptionalFile.

func (*TestMultipartUploadReq) GetOrderId

func (s *TestMultipartUploadReq) GetOrderId() OptInt

GetOrderId returns the value of OrderId.

func (*TestMultipartUploadReq) GetUserId

func (s *TestMultipartUploadReq) GetUserId() OptInt

GetUserId returns the value of UserId.

func (*TestMultipartUploadReq) SetFile

func (s *TestMultipartUploadReq) SetFile(val string)

SetFile sets the value of File.

func (*TestMultipartUploadReq) SetFiles

func (s *TestMultipartUploadReq) SetFiles(val []string)

SetFiles sets the value of Files.

func (*TestMultipartUploadReq) SetOptionalFile

func (s *TestMultipartUploadReq) SetOptionalFile(val OptString)

SetOptionalFile sets the value of OptionalFile.

func (*TestMultipartUploadReq) SetOrderId

func (s *TestMultipartUploadReq) SetOrderId(val OptInt)

SetOrderId sets the value of OrderId.

func (*TestMultipartUploadReq) SetUserId

func (s *TestMultipartUploadReq) SetUserId(val OptInt)

SetUserId sets the value of UserId.

func (*TestMultipartUploadReq) Validate

func (s *TestMultipartUploadReq) Validate() error

type TestMultipartUploadReqForm

type TestMultipartUploadReqForm struct {
	OrderId      OptInt             `json:"orderId"`
	UserId       OptInt             `json:"userId"`
	File         ht.MultipartFile   `json:"file"`
	OptionalFile OptMultipartFile   `json:"optional_file"`
	Files        []ht.MultipartFile `json:"files"`
}

func (*TestMultipartUploadReqForm) GetFile

GetFile returns the value of File.

func (*TestMultipartUploadReqForm) GetFiles

GetFiles returns the value of Files.

func (*TestMultipartUploadReqForm) GetOptionalFile

func (s *TestMultipartUploadReqForm) GetOptionalFile() OptMultipartFile

GetOptionalFile returns the value of OptionalFile.

func (*TestMultipartUploadReqForm) GetOrderId

func (s *TestMultipartUploadReqForm) GetOrderId() OptInt

GetOrderId returns the value of OrderId.

func (*TestMultipartUploadReqForm) GetUserId

func (s *TestMultipartUploadReqForm) GetUserId() OptInt

GetUserId returns the value of UserId.

func (*TestMultipartUploadReqForm) SetFile

SetFile sets the value of File.

func (*TestMultipartUploadReqForm) SetFiles

func (s *TestMultipartUploadReqForm) SetFiles(val []ht.MultipartFile)

SetFiles sets the value of Files.

func (*TestMultipartUploadReqForm) SetOptionalFile

func (s *TestMultipartUploadReqForm) SetOptionalFile(val OptMultipartFile)

SetOptionalFile sets the value of OptionalFile.

func (*TestMultipartUploadReqForm) SetOrderId

func (s *TestMultipartUploadReqForm) SetOrderId(val OptInt)

SetOrderId sets the value of OrderId.

func (*TestMultipartUploadReqForm) SetUserId

func (s *TestMultipartUploadReqForm) SetUserId(val OptInt)

SetUserId sets the value of UserId.

func (*TestMultipartUploadReqForm) Validate

func (s *TestMultipartUploadReqForm) Validate() error

type TestShareFormSchemaOK

type TestShareFormSchemaOK struct{}

TestShareFormSchemaOK is response for TestShareFormSchema operation.

type TestShareFormSchemaReq

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

type UnimplementedHandler

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) TestFormURLEncoded

func (UnimplementedHandler) TestFormURLEncoded(ctx context.Context, req *TestForm) error

TestFormURLEncoded implements testFormURLEncoded operation.

POST /testFormURLEncoded

func (UnimplementedHandler) TestMultipart

func (UnimplementedHandler) TestMultipart(ctx context.Context, req *TestForm) error

TestMultipart implements testMultipart operation.

POST /testMultipart

func (UnimplementedHandler) TestMultipartUpload

TestMultipartUpload implements testMultipartUpload operation.

POST /testMultipartUpload

func (UnimplementedHandler) TestShareFormSchema

func (UnimplementedHandler) TestShareFormSchema(ctx context.Context, req TestShareFormSchemaReq) error

TestShareFormSchema implements testShareFormSchema operation.

POST /testShareFormSchema

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL