routers

Documentation

Overview

Package routers Garm API.

The Garm API generated using go-swagger.

BasePath: /api/v1
Version: 1.0.0
License: Apache 2.0 https://www.apache.org/licenses/LICENSE-2.0

Consumes:
- application/json

Produces:
- application/json

Security:
- Bearer:

SecurityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
    description: >-
      The token with the `Bearer: ` prefix, e.g. "Bearer abcde12345".

swagger:meta

Index

• func NewAPIRouter(han *controllers.APIController, ...) *mux.Router
• func WithDebugServer(parentRouter *mux.Router) *mux.Router
• func WithMetricsRouter(parentRouter *mux.Router, disableAuth bool, metricsMiddlerware auth.Middleware) *mux.Router

Functions

func NewAPIRouter

func NewAPIRouter(han *controllers.APIController, authMiddleware, initMiddleware, instanceMiddleware auth.Middleware, manageWebhooks bool) *mux.Router

func WithDebugServer

func WithDebugServer(parentRouter *mux.Router) *mux.Router

func WithMetricsRouter

func WithMetricsRouter(parentRouter *mux.Router, disableAuth bool, metricsMiddlerware auth.Middleware) *mux.Router