Referencia de @styx/api-contracts generada de su TSDoc.
packages/api-contracts/package.jsonPágina generada desde
el TSDoc de @styx/api-contracts. No se edita a mano:bun run docs:genla regenera ybun run docs:checkfalla si difiere.
Una capacidad de producto con sus superficies (HTTP, SDK, CLI).
readonlyagentSafe:boolean
Sin efectos destructivos sin confirmación.
readonlyoptionalbody?:TSchema
Esquema del cuerpo de la petición (contract-first, TypeBox).
readonlyoptionalbusOnly?:string
Motivo por el que no hay ruta HTTP.
readonlycli:string|null
Comando del CLI styx, o null si aún no existe.
readonlyoptionalcliExempt?:string
Motivo por el que no tiene comando de CLI (revisable).
readonlyoptionalconfirm?:boolean
El CLI pide --yes.
readonlyhttp:IOperationHttp|null
Ruta HTTP, o null si sólo existe por el bus (entonces busOnly lleva el motivo).
readonlyid:string
Id estable; es también el operationId de la ruta en el OpenAPI.
readonlypermission:string
Permiso de @styx/authz que exige la operación.
readonlyoptionalreply?:TSchema
Esquema de la respuesta 200.
readonlysdk:string
Método del SDK de @styx/clients/operations (único).
readonlyservice:string
Servicio dueño (nombre del OpenAPI generado: apps/docs/generated/openapi/<service>.json).