Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth authenticates site users behind one Provider abstraction so the three supported login backends — GitHub (OAuth) and Okta/Keycloak (OIDC discovery) — are configured, not forked.
|
Package auth authenticates site users behind one Provider abstraction so the three supported login backends — GitHub (OAuth) and Okta/Keycloak (OIDC discovery) — are configured, not forked. |
|
Package authhttp serves the four site-user auth endpoints and ties together the provider registry (internal/auth), the Redis session store (internal/session), and the durable users table (internal/store):
|
Package authhttp serves the four site-user auth endpoints and ties together the provider registry (internal/auth), the Redis session store (internal/session), and the durable users table (internal/store): |
|
Package authorize is the authorization seam for docz-api's read endpoints.
|
Package authorize is the authorization seam for docz-api's read endpoints. |
|
Package config loads and validates the docz-api service configuration from the environment.
|
Package config loads and validates the docz-api service configuration from the environment. |
|
Package doczcontract guards docz-api against silent drift in the pinned docz parsing library (github.com/donaldgifford/docz, pinned in go.mod).
|
Package doczcontract guards docz-api against silent drift in the pinned docz parsing library (github.com/donaldgifford/docz, pinned in go.mod). |
|
Package githubapp authenticates to GitHub as the docz-api App and fetches a repo's docz content over the Git Trees API (no checkout).
|
Package githubapp authenticates to GitHub as the docz-api App and fetches a repo's docz content over the Git Trees API (no checkout). |
|
Package httpapi serves the docz-api read endpoints under /api/v1: onboarded repos, repo detail, doc types, and documents.
|
Package httpapi serves the docz-api read endpoints under /api/v1: onboarded repos, repo detail, doc types, and documents. |
|
Package ingest runs the synchronous fetch → parse → map → upsert pipeline that turns a repo's docz content at HEAD into rows in the store.
|
Package ingest runs the synchronous fetch → parse → map → upsert pipeline that turns a repo's docz content at HEAD into rows in the store. |
|
Package queue is the Redis-backed async ingestion layer for docz-api.
|
Package queue is the Redis-backed async ingestion layer for docz-api. |
|
Package search is the Meilisearch access layer for docz-api.
|
Package search is the Meilisearch access layer for docz-api. |
|
Package session issues and resolves Redis-backed site-user sessions.
|
Package session issues and resolves Redis-backed site-user sessions. |
|
Package store is the Postgres access layer for docz-api.
|
Package store is the Postgres access layer for docz-api. |
|
migrations
Package migrations holds the embedded goose SQL migrations for the docz-api Postgres schema.
|
Package migrations holds the embedded goose SQL migrations for the docz-api Postgres schema. |
|
Package telemetry wires the docz-api observability stack (OQ 8): OpenTelemetry tracing exported over OTLP/HTTP, Prometheus metrics on /metrics, and the slog request-logging middleware.
|
Package telemetry wires the docz-api observability stack (OQ 8): OpenTelemetry tracing exported over OTLP/HTTP, Prometheus metrics on /metrics, and the slog request-logging middleware. |
|
Package webhook receives and verifies GitHub App webhooks, then drives onboarding and incremental refresh.
|
Package webhook receives and verifies GitHub App webhooks, then drives onboarding and incremental refresh. |
Click to show internal directories.
Click to hide internal directories.