SDK y paquetes@styx/api-contractsoperationsinterfaces

Interface: IOperation

Referencia de @styx/api-contracts generada de su TSDoc.

ImplementadoSin versión del tren todavía· generada desde packages/api-contracts/package.json

Página generada desde el TSDoc de @styx/api-contracts. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Interface: IOperation

Una capacidad de producto con sus superficies (HTTP, SDK, CLI).

Properties

agentSafe

readonly agentSafe: boolean

Sin efectos destructivos sin confirmación.


body?

readonly optional body?: TSchema

Esquema del cuerpo de la petición (contract-first, TypeBox).


busOnly?

readonly optional busOnly?: string

Motivo por el que no hay ruta HTTP.


cli

readonly cli: string | null

Comando del CLI styx, o null si aún no existe.


cliExempt?

readonly optional cliExempt?: string

Motivo por el que no tiene comando de CLI (revisable).


confirm?

readonly optional confirm?: boolean

El CLI pide --yes.


http

readonly http: IOperationHttp | null

Ruta HTTP, o null si sólo existe por el bus (entonces busOnly lleva el motivo).


id

readonly id: string

Id estable; es también el operationId de la ruta en el OpenAPI.


permission

readonly permission: string

Permiso de @styx/authz que exige la operación.


reply?

readonly optional reply?: TSchema

Esquema de la respuesta 200.


sdk

readonly sdk: string

Método del SDK de @styx/clients/operations (único).


service

readonly service: string

Servicio dueño (nombre del OpenAPI generado: apps/docs/generated/openapi/<service>.json).