api

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Jul 16, 2025 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func InitializeEngine

func InitializeEngine(ctxManager cluster.ContextManager) (*gin.Engine, error)

InitializeEngine initializes the gin engine and sets up the routes. All routes (aside from routes.Health) are protected by authentication and authorization middleware. The engine is configured to use the cluster.ContextManager to assign the context to the request.

func RunEngine

func RunEngine(e *gin.Engine) error

RunEngine starts the API server with the given Gin engine. It will listen on the address specified in the configuration file values [config.State.API.Port] and will use TLS if enabled by

Types

This section is empty.

Directories

Path Synopsis
Package client is a package that provides a client for making HTTP requests to the Ocular API.
Package client is a package that provides a client for making HTTP requests to the Ocular API.
Package middleware provides middleware for the Ocular API.
Package middleware provides middleware for the Ocular API.
Package routes (and sub-packages) provides the API routes for the Ocular application.
Package routes (and sub-packages) provides the API routes for the Ocular application.
v1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL