Referencia

Referencia generada de styx: API HTTP, SDK, Zig, bus, protocolos y configuración.

ImplementadoSin versión del tren todavía· generada desde scripts/docs/gen-reference-index.ts
track/docsdec-0124track/docs:DC2track/docs:DC3track/docs:DC4track/docs:DC5track/docs:DC6

Página generada desde scripts/docs/gen-reference-index.ts. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Todo lo de esta sección se genera de su fuente canónica con bun run docs:gen; bun run docs:check falla si algo se desvía (dec-0124 §7). Ninguna página se edita a mano.

SecciónQué contieneGate item
API HTTPOpenAPI 3.1 de cada servicio desde su app de capturatrack/docs:DC2
SDK y paquetesTSDoc de los paquetes públicos y de @spire/bustrack/docs:DC3
Referencia Zig/// de los módulos del data plane y de zkit, spire y conduittrack/docs:DC4
Bussubjects de BUS_ROUTES con allowlist, rate y JSON Schematrack/docs:DC5
Protocolosspecs de protocols/* y sus vectorestrack/docs:DC5
Configuraciónvariables de entorno del esquema únicotrack/docs:DC6

Pendiente

  • CLI: el CLI styx no existe aún (dec-0123, w7/release-eng); su referencia la emitirá styx docs --format mdx (dec-0124 §7.6).
  • Errores: generador de problem types y códigos (dec-0124 §7.8), no incluido en esta tanda.
  • Permisos: generador de roles × permisos de @styx/authz (dec-0124 §7.9), no incluido en esta tanda.

API HTTP

Referencia HTTP de cada servicio, generada de sus rutas Elysia 2 y los contratos TypeBox.

Pendiente