api

Documentation

Index

• type APIHandlers
  • func NewAPIHandlers(ctx context.Context, logger golog.Logger, cfg config.Config) APIHandlers
  • func (a APIHandlers) SetupRouter(router *mux.Router)
• type HealthCheckHandler
  • func NewHealthCheckHandler() HealthCheckHandler
  • func (HealthCheckHandler) Handle(r *http.Request) resp.Responder
• type IssuesHandler
  • func NewIssuesHandler(ctx context.Context, logger golog.Logger, cfg config.Config) IssuesHandler
  • func (h IssuesHandler) Handle(r *http.Request) resp.Responder
• type IssuesRequest
• type ReposHandler
  • func NewReposHandler(ctx context.Context, logger golog.Logger, cfg config.Config) ReposHandler
  • func (h ReposHandler) Handle(r *http.Request) resp.Responder

Types

type APIHandlers

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

APIHandlers sets up the handlers for API endpoints

func NewAPIHandlers

func NewAPIHandlers(ctx context.Context, logger golog.Logger, cfg config.Config) APIHandlers

NewAPIHandlers creates a new APIHandlers

func (APIHandlers) SetupRouter

func (a APIHandlers) SetupRouter(router *mux.Router)

SetupRouter registers API routes with the provided router

type HealthCheckHandler

type HealthCheckHandler struct{}

HealthCheckHandler implements http.ResponderHandler for the health check endpoint

func NewHealthCheckHandler

func NewHealthCheckHandler() HealthCheckHandler

NewHealthCheckHandler creates a new HealthCheckHandler

func (HealthCheckHandler) Handle

func (HealthCheckHandler) Handle(r *http.Request) resp.Responder

Handle implements resp.ResponderHandler.Handle

type IssuesHandler

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

IssuesHandler implements resp.ResponderHandler by returning a list of GitHub issues for a repository

func NewIssuesHandler

func NewIssuesHandler(ctx context.Context, logger golog.Logger, cfg config.Config) IssuesHandler

NewIssuesHandler creates a new IssuesHandler

func (IssuesHandler) Handle

func (h IssuesHandler) Handle(r *http.Request) resp.Responder

Handle implements resp.ResponderHandler.Handle

type IssuesRequest

type IssuesRequest struct {
	// RepositoryOwner is the repository's owner
	RepositoryOwner string `json:"repository_owner" validate:"nonzero"`

	// RepositoryName is the repository's name
	RepositoryName string `json:"repository_name" validate:"nonzero"`
}

IssuesRequest is the format of a issues request

type ReposHandler

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

ReposHandler implements resp.ResponderHandler by returning a list of GitHub repository names for a user

func NewReposHandler

func NewReposHandler(ctx context.Context, logger golog.Logger, cfg config.Config) ReposHandler

NewReposHandler creates a new ReposHandler

func (ReposHandler) Handle

func (h ReposHandler) Handle(r *http.Request) resp.Responder

Handle implements resp.ResponderHandler.Handle