web

Documentation

Index

• Constants
• Variables
• func Home(ctx *context.Context)
• func HomeSitemap(ctx *context.Context)
• func Metrics(resp http.ResponseWriter, req *http.Request)
• func NodeInfoLinks(ctx *context.Context)
• func OpenAPI3Json(ctx *context.Context)
• func Routes() *web.Router
• func SwaggerV1Json(ctx *context.Context)
• func WebfingerQuery(ctx *context.Context)
• type AuthMiddleware

Constants

const RouterMockPointBeforeWebRoutes = "before-web-routes"

Variables

var GzipMinSize = 1400 // min size to compress for the body size of response

Functions

func Home

func Home(ctx *context.Context)

Home render home page

func HomeSitemap

func HomeSitemap(ctx *context.Context)

HomeSitemap renders the main sitemap

func Metrics

func Metrics(resp http.ResponseWriter, req *http.Request)

Metrics validate auth token and render prometheus metrics

func NodeInfoLinks

func NodeInfoLinks(ctx *context.Context)

NodeInfoLinks returns links to the node info endpoint

func OpenAPI3Json

func OpenAPI3Json(ctx *context.Context)

OpenAPI3Json render OpenAPI 3.0 json (auto-converted from Swagger 2.0)

func Routes

func Routes() *web.Router

Routes returns all web routes

func SwaggerV1Json

func SwaggerV1Json(ctx *context.Context)

SwaggerV1Json render swagger v1 json

func WebfingerQuery

func WebfingerQuery(ctx *context.Context)

WebfingerQuery returns information about a resource https://datatracker.ietf.org/doc/html/rfc7565

Types

type AuthMiddleware

type AuthMiddleware struct {
	AllowOAuth2       types.PreMiddlewareProvider
	AllowBasic        types.PreMiddlewareProvider
	MiddlewareHandler func(*context.Context)
}