api

package
v0.0.0-...-55964f1 Latest Latest
Warning

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

 Go to latest Published: Apr 9, 2024 License: MIT Imports: 24 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 ApiKeyAuth 

type ApiKeyAuth struct {
	APIKey string
}

func (*ApiKeyAuth) GetAPIKey 

func (s *ApiKeyAuth) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*ApiKeyAuth) SetAPIKey 

func (s *ApiKeyAuth) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

type ChannelsChannelIDVideosPostBadRequest 

type ChannelsChannelIDVideosPostBadRequest struct{}

ChannelsChannelIDVideosPostBadRequest is response for ChannelsChannelIDVideosPost operation.

type ChannelsChannelIDVideosPostForbidden 

type ChannelsChannelIDVideosPostForbidden struct{}

ChannelsChannelIDVideosPostForbidden is response for ChannelsChannelIDVideosPost operation.

type ChannelsChannelIDVideosPostInternalServerError 

type ChannelsChannelIDVideosPostInternalServerError struct{}

ChannelsChannelIDVideosPostInternalServerError is response for ChannelsChannelIDVideosPost operation.

type ChannelsChannelIDVideosPostNotFound 

type ChannelsChannelIDVideosPostNotFound struct{}

ChannelsChannelIDVideosPostNotFound is response for ChannelsChannelIDVideosPost operation.

type ChannelsChannelIDVideosPostOKApplicationJSON 

type ChannelsChannelIDVideosPostOKApplicationJSON string

func (*ChannelsChannelIDVideosPostOKApplicationJSON) Decode 

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

Decode decodes ChannelsChannelIDVideosPostOKApplicationJSON from json.

func (ChannelsChannelIDVideosPostOKApplicationJSON) Encode 

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

Encode encodes ChannelsChannelIDVideosPostOKApplicationJSON as json.

func (ChannelsChannelIDVideosPostOKApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsChannelIDVideosPostOKApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsChannelIDVideosPostParams 

type ChannelsChannelIDVideosPostParams struct {
	// Unique identifier of the channel.
	ChannelID string
}

ChannelsChannelIDVideosPostParams is parameters of POST /channels/{channel_id}/videos operation.

type ChannelsChannelIDVideosPostReq 

type ChannelsChannelIDVideosPostReq struct {
	// Array of YouTube channel IDs.
	Ids       []string  `json:"ids"`
	StartDate OptString `json:"start_date"`
	EndDate   OptString `json:"end_date"`
}

func (*ChannelsChannelIDVideosPostReq) Decode 

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

Decode decodes ChannelsChannelIDVideosPostReq from json.

func (*ChannelsChannelIDVideosPostReq) Encode 

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

Encode implements json.Marshaler.

func (*ChannelsChannelIDVideosPostReq) GetEndDate 

func (s *ChannelsChannelIDVideosPostReq) GetEndDate() OptString

GetEndDate returns the value of EndDate.

func (*ChannelsChannelIDVideosPostReq) GetIds 

func (s *ChannelsChannelIDVideosPostReq) GetIds() []string

GetIds returns the value of Ids.

func (*ChannelsChannelIDVideosPostReq) GetStartDate 

func (s *ChannelsChannelIDVideosPostReq) GetStartDate() OptString

GetStartDate returns the value of StartDate.

func (*ChannelsChannelIDVideosPostReq) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsChannelIDVideosPostReq) SetEndDate 

func (s *ChannelsChannelIDVideosPostReq) SetEndDate(val OptString)

SetEndDate sets the value of EndDate.

func (*ChannelsChannelIDVideosPostReq) SetIds 

func (s *ChannelsChannelIDVideosPostReq) SetIds(val []string)

SetIds sets the value of Ids.

func (*ChannelsChannelIDVideosPostReq) SetStartDate 

func (s *ChannelsChannelIDVideosPostReq) SetStartDate(val OptString)

SetStartDate sets the value of StartDate.

func (*ChannelsChannelIDVideosPostReq) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsChannelIDVideosPostRes 

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

type ChannelsChannelIDVideosPostUnauthorized 

type ChannelsChannelIDVideosPostUnauthorized struct{}

ChannelsChannelIDVideosPostUnauthorized is response for ChannelsChannelIDVideosPost operation.

type ChannelsChannelIDVideosPutBadRequest 

type ChannelsChannelIDVideosPutBadRequest struct{}

ChannelsChannelIDVideosPutBadRequest is response for ChannelsChannelIDVideosPut operation.

type ChannelsChannelIDVideosPutForbidden 

type ChannelsChannelIDVideosPutForbidden struct{}

ChannelsChannelIDVideosPutForbidden is response for ChannelsChannelIDVideosPut operation.

type ChannelsChannelIDVideosPutInternalServerError 

type ChannelsChannelIDVideosPutInternalServerError struct{}

ChannelsChannelIDVideosPutInternalServerError is response for ChannelsChannelIDVideosPut operation.

type ChannelsChannelIDVideosPutNotFound 

type ChannelsChannelIDVideosPutNotFound struct{}

ChannelsChannelIDVideosPutNotFound is response for ChannelsChannelIDVideosPut operation.

type ChannelsChannelIDVideosPutOKApplicationJSON 

type ChannelsChannelIDVideosPutOKApplicationJSON string

func (*ChannelsChannelIDVideosPutOKApplicationJSON) Decode 

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

Decode decodes ChannelsChannelIDVideosPutOKApplicationJSON from json.

func (ChannelsChannelIDVideosPutOKApplicationJSON) Encode 

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

Encode encodes ChannelsChannelIDVideosPutOKApplicationJSON as json.

func (ChannelsChannelIDVideosPutOKApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsChannelIDVideosPutOKApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsChannelIDVideosPutParams 

type ChannelsChannelIDVideosPutParams struct {
	// Unique identifier of the channel.
	ChannelID string
}

ChannelsChannelIDVideosPutParams is parameters of PUT /channels/{channel_id}/videos operation.

type ChannelsChannelIDVideosPutReq 

type ChannelsChannelIDVideosPutReq struct {
	// Array of YouTube channel IDs.
	Ids       []string  `json:"ids"`
	StartDate OptString `json:"start_date"`
	EndDate   OptString `json:"end_date"`
}

func (*ChannelsChannelIDVideosPutReq) Decode 

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

Decode decodes ChannelsChannelIDVideosPutReq from json.

func (*ChannelsChannelIDVideosPutReq) Encode 

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

Encode implements json.Marshaler.

func (*ChannelsChannelIDVideosPutReq) GetEndDate 

func (s *ChannelsChannelIDVideosPutReq) GetEndDate() OptString

GetEndDate returns the value of EndDate.

func (*ChannelsChannelIDVideosPutReq) GetIds 

func (s *ChannelsChannelIDVideosPutReq) GetIds() []string

GetIds returns the value of Ids.

func (*ChannelsChannelIDVideosPutReq) GetStartDate 

func (s *ChannelsChannelIDVideosPutReq) GetStartDate() OptString

GetStartDate returns the value of StartDate.

func (*ChannelsChannelIDVideosPutReq) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsChannelIDVideosPutReq) SetEndDate 

func (s *ChannelsChannelIDVideosPutReq) SetEndDate(val OptString)

SetEndDate sets the value of EndDate.

func (*ChannelsChannelIDVideosPutReq) SetIds 

func (s *ChannelsChannelIDVideosPutReq) SetIds(val []string)

SetIds sets the value of Ids.

func (*ChannelsChannelIDVideosPutReq) SetStartDate 

func (s *ChannelsChannelIDVideosPutReq) SetStartDate(val OptString)

SetStartDate sets the value of StartDate.

func (*ChannelsChannelIDVideosPutReq) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsChannelIDVideosPutRes 

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

type ChannelsChannelIDVideosPutUnauthorized 

type ChannelsChannelIDVideosPutUnauthorized struct{}

ChannelsChannelIDVideosPutUnauthorized is response for ChannelsChannelIDVideosPut operation.

type ChannelsPostBadRequest 

type ChannelsPostBadRequest struct{}

ChannelsPostBadRequest is response for ChannelsPost operation.

type ChannelsPostForbidden 

type ChannelsPostForbidden struct{}

ChannelsPostForbidden is response for ChannelsPost operation.

type ChannelsPostInternalServerError 

type ChannelsPostInternalServerError struct{}

ChannelsPostInternalServerError is response for ChannelsPost operation.

type ChannelsPostNotFound 

type ChannelsPostNotFound struct{}

ChannelsPostNotFound is response for ChannelsPost operation.

type ChannelsPostOKApplicationJSON 

type ChannelsPostOKApplicationJSON string

func (*ChannelsPostOKApplicationJSON) Decode 

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

Decode decodes ChannelsPostOKApplicationJSON from json.

func (ChannelsPostOKApplicationJSON) Encode 

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

Encode encodes ChannelsPostOKApplicationJSON as json.

func (ChannelsPostOKApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsPostOKApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsPostReq 

type ChannelsPostReq struct {
	// Array of YouTube channel IDs.
	Ids       []string  `json:"ids"`
	StartDate OptString `json:"start_date"`
	EndDate   OptString `json:"end_date"`
}

func (*ChannelsPostReq) Decode 

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

Decode decodes ChannelsPostReq from json.

func (*ChannelsPostReq) Encode 

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

Encode implements json.Marshaler.

func (*ChannelsPostReq) GetEndDate 

func (s *ChannelsPostReq) GetEndDate() OptString

GetEndDate returns the value of EndDate.

func (*ChannelsPostReq) GetIds 

func (s *ChannelsPostReq) GetIds() []string

GetIds returns the value of Ids.

func (*ChannelsPostReq) GetStartDate 

func (s *ChannelsPostReq) GetStartDate() OptString

GetStartDate returns the value of StartDate.

func (*ChannelsPostReq) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsPostReq) SetEndDate 

func (s *ChannelsPostReq) SetEndDate(val OptString)

SetEndDate sets the value of EndDate.

func (*ChannelsPostReq) SetIds 

func (s *ChannelsPostReq) SetIds(val []string)

SetIds sets the value of Ids.

func (*ChannelsPostReq) SetStartDate 

func (s *ChannelsPostReq) SetStartDate(val OptString)

SetStartDate sets the value of StartDate.

func (*ChannelsPostReq) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsPostRes 

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

type ChannelsPostUnauthorized 

type ChannelsPostUnauthorized struct{}

ChannelsPostUnauthorized is response for ChannelsPost operation.

type ChannelsPutBadRequest 

type ChannelsPutBadRequest struct{}

ChannelsPutBadRequest is response for ChannelsPut operation.

type ChannelsPutForbidden 

type ChannelsPutForbidden struct{}

ChannelsPutForbidden is response for ChannelsPut operation.

type ChannelsPutInternalServerError 

type ChannelsPutInternalServerError struct{}

ChannelsPutInternalServerError is response for ChannelsPut operation.

type ChannelsPutNotFound 

type ChannelsPutNotFound struct{}

ChannelsPutNotFound is response for ChannelsPut operation.

type ChannelsPutOKApplicationJSON 

type ChannelsPutOKApplicationJSON string

func (*ChannelsPutOKApplicationJSON) Decode 

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

Decode decodes ChannelsPutOKApplicationJSON from json.

func (ChannelsPutOKApplicationJSON) Encode 

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

Encode encodes ChannelsPutOKApplicationJSON as json.

func (ChannelsPutOKApplicationJSON) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsPutOKApplicationJSON) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsPutReq 

type ChannelsPutReq struct {
	// Array of YouTube channel IDs.
	Ids       []string  `json:"ids"`
	StartDate OptString `json:"start_date"`
	EndDate   OptString `json:"end_date"`
}

func (*ChannelsPutReq) Decode 

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

Decode decodes ChannelsPutReq from json.

func (*ChannelsPutReq) Encode 

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

Encode implements json.Marshaler.

func (*ChannelsPutReq) GetEndDate 

func (s *ChannelsPutReq) GetEndDate() OptString

GetEndDate returns the value of EndDate.

func (*ChannelsPutReq) GetIds 

func (s *ChannelsPutReq) GetIds() []string

GetIds returns the value of Ids.

func (*ChannelsPutReq) GetStartDate 

func (s *ChannelsPutReq) GetStartDate() OptString

GetStartDate returns the value of StartDate.

func (*ChannelsPutReq) MarshalJSON 

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

MarshalJSON implements stdjson.Marshaler.

func (*ChannelsPutReq) SetEndDate 

func (s *ChannelsPutReq) SetEndDate(val OptString)

SetEndDate sets the value of EndDate.

func (*ChannelsPutReq) SetIds 

func (s *ChannelsPutReq) SetIds(val []string)

SetIds sets the value of Ids.

func (*ChannelsPutReq) SetStartDate 

func (s *ChannelsPutReq) SetStartDate(val OptString)

SetStartDate sets the value of StartDate.

func (*ChannelsPutReq) UnmarshalJSON 

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ChannelsPutRes 

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

type ChannelsPutUnauthorized 

type ChannelsPutUnauthorized struct{}

ChannelsPutUnauthorized is response for ChannelsPut operation.

type Client 

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

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, sec SecuritySource, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) ChannelsChannelIDVideosPost 

func (c *Client) ChannelsChannelIDVideosPost(ctx context.Context, request *ChannelsChannelIDVideosPostReq, params ChannelsChannelIDVideosPostParams) (ChannelsChannelIDVideosPostRes, error)

ChannelsChannelIDVideosPost invokes POST /channels/{channel_id}/videos operation.

Update videos related to a specific channel based on provided cronType.

POST /channels/{channel_id}/videos

func (*Client) ChannelsChannelIDVideosPut 

func (c *Client) ChannelsChannelIDVideosPut(ctx context.Context, request *ChannelsChannelIDVideosPutReq, params ChannelsChannelIDVideosPutParams) (ChannelsChannelIDVideosPutRes, error)

ChannelsChannelIDVideosPut invokes PUT /channels/{channel_id}/videos operation.

Update videos related to a specific channel based on provided cronType.

PUT /channels/{channel_id}/videos

func (*Client) ChannelsPost 

func (c *Client) ChannelsPost(ctx context.Context, request *ChannelsPostReq) (ChannelsPostRes, error)

ChannelsPost invokes POST /channels operation.

Creates channels by fetching from Youtube using provided Channel IDs.

POST /channels

func (*Client) ChannelsPut 

func (c *Client) ChannelsPut(ctx context.Context, request *ChannelsPutReq) (ChannelsPutRes, error)

ChannelsPut invokes PUT /channels operation.

Updates channels by fetching from Youtube using provided Channel IDs.

PUT /channels

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 Handler 

type Handler interface {
	// ChannelsChannelIDVideosPost implements POST /channels/{channel_id}/videos operation.
	//
	// Update videos related to a specific channel based on provided cronType.
	//
	// POST /channels/{channel_id}/videos
	ChannelsChannelIDVideosPost(ctx context.Context, req *ChannelsChannelIDVideosPostReq, params ChannelsChannelIDVideosPostParams) (ChannelsChannelIDVideosPostRes, error)
	// ChannelsChannelIDVideosPut implements PUT /channels/{channel_id}/videos operation.
	//
	// Update videos related to a specific channel based on provided cronType.
	//
	// PUT /channels/{channel_id}/videos
	ChannelsChannelIDVideosPut(ctx context.Context, req *ChannelsChannelIDVideosPutReq, params ChannelsChannelIDVideosPutParams) (ChannelsChannelIDVideosPutRes, error)
	// ChannelsPost implements POST /channels operation.
	//
	// Creates channels by fetching from Youtube using provided Channel IDs.
	//
	// POST /channels
	ChannelsPost(ctx context.Context, req *ChannelsPostReq) (ChannelsPostRes, error)
	// ChannelsPut implements PUT /channels operation.
	//
	// Updates channels by fetching from Youtube using provided Channel IDs.
	//
	// PUT /channels
	ChannelsPut(ctx context.Context, req *ChannelsPutReq) (ChannelsPutRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// ChannelsChannelIDVideosPost invokes POST /channels/{channel_id}/videos operation.
	//
	// Update videos related to a specific channel based on provided cronType.
	//
	// POST /channels/{channel_id}/videos
	ChannelsChannelIDVideosPost(ctx context.Context, request *ChannelsChannelIDVideosPostReq, params ChannelsChannelIDVideosPostParams) (ChannelsChannelIDVideosPostRes, error)
	// ChannelsChannelIDVideosPut invokes PUT /channels/{channel_id}/videos operation.
	//
	// Update videos related to a specific channel based on provided cronType.
	//
	// PUT /channels/{channel_id}/videos
	ChannelsChannelIDVideosPut(ctx context.Context, request *ChannelsChannelIDVideosPutReq, params ChannelsChannelIDVideosPutParams) (ChannelsChannelIDVideosPutRes, error)
	// ChannelsPost invokes POST /channels operation.
	//
	// Creates channels by fetching from Youtube using provided Channel IDs.
	//
	// POST /channels
	ChannelsPost(ctx context.Context, request *ChannelsPostReq) (ChannelsPostRes, error)
	// ChannelsPut invokes PUT /channels operation.
	//
	// Updates channels by fetching from Youtube using provided Channel IDs.
	//
	// PUT /channels
	ChannelsPut(ctx context.Context, request *ChannelsPutReq) (ChannelsPutRes, 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 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 SecurityHandler 

type SecurityHandler interface {
	// HandleApiKeyAuth handles ApiKeyAuth security.
	HandleApiKeyAuth(ctx context.Context, operationName string, t ApiKeyAuth) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// ApiKeyAuth provides ApiKeyAuth security value.
	ApiKeyAuth(ctx context.Context, operationName string) (ApiKeyAuth, error)
}

SecuritySource is provider of security values (tokens, passwords, etc.).

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, sec SecurityHandler, 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) ChannelsChannelIDVideosPost 

func (UnimplementedHandler) ChannelsChannelIDVideosPost(ctx context.Context, req *ChannelsChannelIDVideosPostReq, params ChannelsChannelIDVideosPostParams) (r ChannelsChannelIDVideosPostRes, _ error)

ChannelsChannelIDVideosPost implements POST /channels/{channel_id}/videos operation.

Update videos related to a specific channel based on provided cronType.

POST /channels/{channel_id}/videos

func (UnimplementedHandler) ChannelsChannelIDVideosPut 

func (UnimplementedHandler) ChannelsChannelIDVideosPut(ctx context.Context, req *ChannelsChannelIDVideosPutReq, params ChannelsChannelIDVideosPutParams) (r ChannelsChannelIDVideosPutRes, _ error)

ChannelsChannelIDVideosPut implements PUT /channels/{channel_id}/videos operation.

Update videos related to a specific channel based on provided cronType.

PUT /channels/{channel_id}/videos

func (UnimplementedHandler) ChannelsPost 

func (UnimplementedHandler) ChannelsPost(ctx context.Context, req *ChannelsPostReq) (r ChannelsPostRes, _ error)

ChannelsPost implements POST /channels operation.

Creates channels by fetching from Youtube using provided Channel IDs.

POST /channels

func (UnimplementedHandler) ChannelsPut 

func (UnimplementedHandler) ChannelsPut(ctx context.Context, req *ChannelsPutReq) (r ChannelsPutRes, _ error)

ChannelsPut implements PUT /channels operation.

Updates channels by fetching from Youtube using provided Channel IDs.

PUT /channels

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.