hubvault.server.routes.refs

Reference route factory for hubvault.server.

This module exposes read-only git-reference listings over HTTP.

The module contains:

• create_refs_router() - Build the /api/v1/refs router

create_refs_router

hubvault.server.routes.refs.create_refs_router(*, api=None, api_factory=None, authorizer)

Build the reference router for the server app.

Parameters:

• api (Optional[hubvault.api.HubVaultApi]) – Optional repository API reused by the router

• api_factory (Optional[Callable[[], hubvault.api.HubVaultApi]]) – Optional zero-argument factory returning one fresh repository API per request

• authorizer (hubvault.server.auth.TokenAuthorizer) – Shared token authorizer

Returns:

Router exposing git-reference endpoints

Return type:

fastapi.APIRouter

Raises:

• hubvault.optional.MissingOptionalDependencyError – Raised when the API extra is not installed.

• TypeError – Raised when both api and api_factory are provided or when neither input is provided.