Documentation
¶
Index ¶
- type T2jAPI
- func (o *T2jAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *T2jAPI) Authorizer() runtime.Authorizer
- func (o *T2jAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *T2jAPI) Context() *middleware.Context
- func (o *T2jAPI) DefaultConsumes() string
- func (o *T2jAPI) DefaultProduces() string
- func (o *T2jAPI) Formats() strfmt.Registry
- func (o *T2jAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *T2jAPI) Init()
- func (o *T2jAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *T2jAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *T2jAPI) Serve(builder middleware.Builder) http.Handler
- func (o *T2jAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *T2jAPI) SetDefaultConsumes(mediaType string)
- func (o *T2jAPI) SetDefaultProduces(mediaType string)
- func (o *T2jAPI) SetSpec(spec *loads.Document)
- func (o *T2jAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type T2jAPI ¶
type T2jAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implemention 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 implemention 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 implemention 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 a "application/json" mime type
JSONConsumer runtime.Consumer
// JSONProducer registers a producer for a "application/json" mime type
JSONProducer runtime.Producer
// ProjectsDeleteProjectByIDHandler sets the operation handler for the delete project by ID operation
ProjectsDeleteProjectByIDHandler projects.DeleteProjectByIDHandler
// TasksDeleteTaskByIDHandler sets the operation handler for the delete task by ID operation
TasksDeleteTaskByIDHandler tasks.DeleteTaskByIDHandler
// UsersDeleteUserByIDHandler sets the operation handler for the delete user by ID operation
UsersDeleteUserByIDHandler users.DeleteUserByIDHandler
// ProjectsGetProjectByIDHandler sets the operation handler for the get project by ID operation
ProjectsGetProjectByIDHandler projects.GetProjectByIDHandler
// ProjectsGetProjectsHandler sets the operation handler for the get projects operation
ProjectsGetProjectsHandler projects.GetProjectsHandler
// TasksGetTaskByIDHandler sets the operation handler for the get task by ID operation
TasksGetTaskByIDHandler tasks.GetTaskByIDHandler
// TasksGetTasksHandler sets the operation handler for the get tasks operation
TasksGetTasksHandler tasks.GetTasksHandler
// UsersGetUserByIDHandler sets the operation handler for the get user by ID operation
UsersGetUserByIDHandler users.GetUserByIDHandler
// UsersGetUsersHandler sets the operation handler for the get users operation
UsersGetUsersHandler users.GetUsersHandler
// ProjectsPostProjectHandler sets the operation handler for the post project operation
ProjectsPostProjectHandler projects.PostProjectHandler
// TasksPostTaskHandler sets the operation handler for the post task operation
TasksPostTaskHandler tasks.PostTaskHandler
// UsersPostUserHandler sets the operation handler for the post user operation
UsersPostUserHandler users.PostUserHandler
// GeneralVersionHandler sets the operation handler for the version operation
GeneralVersionHandler general.VersionHandler
// 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)
// 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, ...interface{})
// contains filtered or unexported fields
}
T2jAPI Pivotal Tracker to JIRA synchronization service.
func (*T2jAPI) AuthenticatorsFor ¶
func (o *T2jAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*T2jAPI) Authorizer ¶
func (o *T2jAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*T2jAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types
func (*T2jAPI) Context ¶
func (o *T2jAPI) Context() *middleware.Context
Context returns the middleware context for the t2j API
func (*T2jAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*T2jAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*T2jAPI) Formats ¶
Formats returns the registered string formats
func (*T2jAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*T2jAPI) Init ¶
func (o *T2jAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middelware as you see fit
func (*T2jAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types
func (*T2jAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*T2jAPI) Serve ¶
func (o *T2jAPI) 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 (*T2jAPI) ServeErrorFor ¶
ServeErrorFor gets a error handler for a given operation id
func (*T2jAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*T2jAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
func (*T2jAPI) SetSpec ¶
SetSpec sets a spec that will be served for the clients.
Source Files
¶
- t2j_api.go