AttachRoutes attaches the API routes to the router group that is passed in Separating this from RouterConfig() allows us to attach it to different paths for different use cases, e.g.

Config sets up the router, returns a teardown function and an error.

GetRoot returns the link list for the API root @Summary API root @Description Entrypoint for the API, listing all endpoints @Tags General @Success 200 {object} RootResponse @Router / [get].

GetV1 returns the link list for v1 @Summary v1 API @Description Returns general information about the v1 API @Tags v1 @Success 200 {object} V1Response @Router /v1 [get] @Deprecated true.

GetV2 returns the link list for v2 @Summary v2 API @Description Returns general information about the v2 API @Tags v2 @Success 200 {object} V2Response @Router /v2 [get] @Deprecated true.

GetV3 returns the link list for v3 @Summary v3 API @Description Returns general information about the v3 API @Tags v3 @Success 200 {object} V3Response @Router /v3 [get].

GetVersion returns the API version object @Summary API version @Description Returns the software version of the API @Tags General @Success 200 {object} VersionResponse @Router /version [get].

MetricsMiddleware updates Prometheus metrics.

OptionsRoot returns the allowed HTTP methods @Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags General @Success 204 @Router / [options].

OptionsV1 returns the allowed HTTP methods @Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags v1 @Success 204 @Router /v1 [options] @Deprecated true.

OptionsV2 returns the allowed HTTP methods @Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags v2 @Success 204 @Router /v2 [options] @Deprecated true.

OptionsV3 returns the allowed HTTP methods @Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags v3 @Success 204 @Router /v3 [options].

OptionsVersion returns the allowed HTTP methods @Summary Allowed HTTP verbs @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs @Tags General @Success 204 @Router /version [options].