Skip to main content

Introspecção de schema

# Todos os produtos e os métodos de cada recurso
kobana schema --list

# O schema de um endpoint
kobana schema banking.bank-billets.create
kobana schema banking.charge.pix.create
kobana schema banking.financial.accounts.statement-transactions.get

O caminho segue a forma do comando, com pontos no lugar dos espaços: <produto>.<recurso>[.<sub-recurso>…].<metodo>.

A resposta é JSON, tirada da spec OpenAPI embutida no binário, e traz:

CampoConteúdo
method, pathO método e o caminho HTTP
path_paramsOs nomes dos parâmetros de caminho, que vão em --params
parametersOs parâmetros de query, com tipo e descrição
descriptionA descrição do endpoint
request_bodyO corpo como está na spec. Muitas vezes é só uma referência ($ref) a um schema, sem a lista de campos
responsesAs respostas, com exemplos
# Os parâmetros de query de uma listagem
kobana schema banking.bank-billets.list | jq -r '.parameters[].name'

Para os campos do corpo, quando request_body traz só a referência, use a Referência da API.

É o primeiro passo recomendado para um agente de IA que não conhece o formato exato de um pedido: inspecione o schema antes de disparar uma chamada que altera dados, em vez de adivinhar, e confira o resultado com --dry-run.

Próximos passos​

  • Flags globais: --params, --json, --dry-run e as demais.
  • Uso: sintaxe, recursos e exemplos.