Documentation
¶
Index ¶
- type GitHubReleaseNotificationAPI
- func (o *GitHubReleaseNotificationAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *GitHubReleaseNotificationAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *GitHubReleaseNotificationAPI) Authorizer() runtime.Authorizer
- func (o *GitHubReleaseNotificationAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *GitHubReleaseNotificationAPI) Context() *middleware.Context
- func (o *GitHubReleaseNotificationAPI) DefaultConsumes() string
- func (o *GitHubReleaseNotificationAPI) DefaultProduces() string
- func (o *GitHubReleaseNotificationAPI) Formats() strfmt.Registry
- func (o *GitHubReleaseNotificationAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *GitHubReleaseNotificationAPI) Init()
- func (o *GitHubReleaseNotificationAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *GitHubReleaseNotificationAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *GitHubReleaseNotificationAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *GitHubReleaseNotificationAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *GitHubReleaseNotificationAPI) Serve(builder middleware.Builder) http.Handler
- func (o *GitHubReleaseNotificationAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *GitHubReleaseNotificationAPI) SetDefaultConsumes(mediaType string)
- func (o *GitHubReleaseNotificationAPI) SetDefaultProduces(mediaType string)
- func (o *GitHubReleaseNotificationAPI) SetSpec(spec *loads.Document)
- func (o *GitHubReleaseNotificationAPI) UseRedoc()
- func (o *GitHubReleaseNotificationAPI) UseSwaggerUI()
- func (o *GitHubReleaseNotificationAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitHubReleaseNotificationAPI ¶
type GitHubReleaseNotificationAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
// JSONConsumer registers a consumer for the following mime types:
// - application/json
JSONConsumer runtime.Consumer
// UrlformConsumer registers a consumer for the following mime types:
// - application/x-www-form-urlencoded
UrlformConsumer runtime.Consumer
// JSONProducer registers a producer for the following mime types:
// - application/json
JSONProducer runtime.Producer
// SubscriptionConfirmSubscriptionHandler sets the operation handler for the confirm subscription operation
SubscriptionConfirmSubscriptionHandler subscription.ConfirmSubscriptionHandler
// SubscriptionGetSubscriptionsHandler sets the operation handler for the get subscriptions operation
SubscriptionGetSubscriptionsHandler subscription.GetSubscriptionsHandler
// SubscriptionSubscribeHandler sets the operation handler for the subscribe operation
SubscriptionSubscribeHandler subscription.SubscribeHandler
// SubscriptionUnsubscribeHandler sets the operation handler for the unsubscribe operation
SubscriptionUnsubscribeHandler subscription.UnsubscribeHandler
// ServeError is called when an error is received, there is a default handler
// but you can set your own with this
ServeError func(http.ResponseWriter, *http.Request, error)
// PreServerShutdown is called before the HTTP(S) server is shutdown
// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
PreServerShutdown func()
// ServerShutdown is called when the HTTP(S) server is shut down and done
// handling all active connections and does not accept connections any more
ServerShutdown func()
// Custom command line argument groups with their descriptions
CommandLineOptionsGroups []swag.CommandLineOptionsGroup
// User defined logger function.
Logger func(string, ...any)
// contains filtered or unexported fields
}
GitHubReleaseNotificationAPI GitHub Release Notification API that allows users to subscribe to email notifications about new releases of a chosen GitHub repository.
func NewGitHubReleaseNotificationAPI ¶
func NewGitHubReleaseNotificationAPI(spec *loads.Document) *GitHubReleaseNotificationAPI
NewGitHubReleaseNotificationAPI creates a new GitHubReleaseNotification instance
func (*GitHubReleaseNotificationAPI) AddMiddlewareFor ¶
func (o *GitHubReleaseNotificationAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*GitHubReleaseNotificationAPI) AuthenticatorsFor ¶
func (o *GitHubReleaseNotificationAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*GitHubReleaseNotificationAPI) Authorizer ¶
func (o *GitHubReleaseNotificationAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*GitHubReleaseNotificationAPI) ConsumersFor ¶
func (o *GitHubReleaseNotificationAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types.
MIME type parameters are ignored here.
func (*GitHubReleaseNotificationAPI) Context ¶
func (o *GitHubReleaseNotificationAPI) Context() *middleware.Context
Context returns the middleware context for the git hub release notification API
func (*GitHubReleaseNotificationAPI) DefaultConsumes ¶
func (o *GitHubReleaseNotificationAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*GitHubReleaseNotificationAPI) DefaultProduces ¶
func (o *GitHubReleaseNotificationAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*GitHubReleaseNotificationAPI) Formats ¶
func (o *GitHubReleaseNotificationAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*GitHubReleaseNotificationAPI) HandlerFor ¶
func (o *GitHubReleaseNotificationAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*GitHubReleaseNotificationAPI) Init ¶
func (o *GitHubReleaseNotificationAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*GitHubReleaseNotificationAPI) ProducersFor ¶
func (o *GitHubReleaseNotificationAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types.
MIME type parameters are ignored here.
func (*GitHubReleaseNotificationAPI) RegisterConsumer ¶
func (o *GitHubReleaseNotificationAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*GitHubReleaseNotificationAPI) RegisterFormat ¶
func (o *GitHubReleaseNotificationAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*GitHubReleaseNotificationAPI) RegisterProducer ¶
func (o *GitHubReleaseNotificationAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*GitHubReleaseNotificationAPI) Serve ¶
func (o *GitHubReleaseNotificationAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*GitHubReleaseNotificationAPI) ServeErrorFor ¶
func (o *GitHubReleaseNotificationAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*GitHubReleaseNotificationAPI) SetDefaultConsumes ¶
func (o *GitHubReleaseNotificationAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*GitHubReleaseNotificationAPI) SetDefaultProduces ¶
func (o *GitHubReleaseNotificationAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*GitHubReleaseNotificationAPI) SetSpec ¶
func (o *GitHubReleaseNotificationAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*GitHubReleaseNotificationAPI) UseRedoc ¶
func (o *GitHubReleaseNotificationAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*GitHubReleaseNotificationAPI) UseSwaggerUI ¶
func (o *GitHubReleaseNotificationAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*GitHubReleaseNotificationAPI) Validate ¶
func (o *GitHubReleaseNotificationAPI) Validate() error
Validate validates the registrations in the GitHubReleaseNotificationAPI
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.