routes

Documentation

Overview

Package routes defines the routes for the echo server.

Package routes defines the routes for the echo server.

Package routes defines the routes for the echo server.

Package routes defines the routes for the echo server.

Package routes defines the routes for the echo server.

Package routes defines the routes for the echo server.

Index

• func LoadRoutes(r *RouteService) error
• func LoadRoutesWithOptions(r *RouteService, startServer bool) error
• func NewEcho() *echo.Echo
• type RouteService
  • func NewRouteService(e *echo.Echo, service models.ServiceInterface, pool *pgxpool.Pool, ...) *RouteService
  • func NewRouteServiceWithTelemetry(e *echo.Echo, service models.ServiceInterface, pool *pgxpool.Pool, ...) *RouteService
  • func (r *RouteService) AdminRoleRoutes()
  • func (r *RouteService) AuthnRoutes()
  • func (r *RouteService) ChannelRoutes()
  • func (r *RouteService) HealthCheckRoutes()
  • func (r *RouteService) UserRegisterRoutes()
  • func (r *RouteService) UserRoutes()

Functions

func LoadRoutes

func LoadRoutes(r *RouteService) error

LoadRoutes loads the routes for the echo server

func LoadRoutesWithOptions

func LoadRoutesWithOptions(r *RouteService, startServer bool) error

LoadRoutesWithOptions loads the routes for the echo server with additional options

func NewEcho

func NewEcho() *echo.Echo

Types

type RouteService

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

RouteService is a struct that holds the echo instance, the echo group, the service, the database pool, and the redis client

func NewRouteService

func NewRouteService(
	e *echo.Echo,
	service models.ServiceInterface,
	pool *pgxpool.Pool,
	rdb *redis.Client,
) *RouteService

NewRouteService creates a new RoutesService

func NewRouteServiceWithTelemetry

func NewRouteServiceWithTelemetry(
	e *echo.Echo,
	service models.ServiceInterface,
	pool *pgxpool.Pool,
	rdb *redis.Client,
	telemetryProvider *telemetry.Provider,
) *RouteService

NewRouteServiceWithTelemetry creates a new RoutesService with telemetry provider

func (*RouteService) AdminRoleRoutes

func (r *RouteService) AdminRoleRoutes()

func (*RouteService) AuthnRoutes

func (r *RouteService) AuthnRoutes()

AuthnRoutes defines the routes for the authentication endpoints

func (*RouteService) ChannelRoutes

func (r *RouteService) ChannelRoutes()

ChannelRoutes defines the routes for the channel endpoints

func (*RouteService) HealthCheckRoutes

func (r *RouteService) HealthCheckRoutes()

HealthCheckRoutes Adds health check endpoint to determine if the service is up (useful for load balancers or k8s)

func (*RouteService) UserRegisterRoutes

func (r *RouteService) UserRegisterRoutes()

MeRoutes defines the routes for the me endpoints

func (*RouteService) UserRoutes

func (r *RouteService) UserRoutes()

UserRoutes defines the routes for the user endpoints