Help us shape the future of Go! Take the 2026 Go Developer Survey

docs

package
v0.19.1254 Latest Latest
Warning

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

Go to latest
Published: Oct 20, 2026 License: AGPL-3.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LoadPublicOAPI2Spec

func LoadPublicOAPI2Spec() (*openapi2.T, error)

LoadPublicOAPI2Spec loads the public Swagger 2.0 spec without requiring a server context This is used for offline spec generation

Types

type Docs

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

func New

func New(cfg *internal.Config) *Docs

func (*Docs) RegisterAdminDashboardRoutes

func (s *Docs) RegisterAdminDashboardRoutes(api *gin.Engine) error

func (*Docs) RegisterAuthRoutes

func (s *Docs) RegisterAuthRoutes(api *gin.Engine) error

func (*Docs) RegisterInternalRoutes

func (r *Docs) RegisterInternalRoutes(g *gin.Engine) error

func (*Docs) RegisterPublicRoutes

func (r *Docs) RegisterPublicRoutes(g *gin.Engine) error

func (*Docs) RegisterRunnerRoutes

func (r *Docs) RegisterRunnerRoutes(g *gin.Engine) error

func (*Docs) RegisterSlackRoutes added in v0.19.927

func (s *Docs) RegisterSlackRoutes(api *gin.Engine) error

Jump to

Keyboard shortcuts

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