Esquema
1 função do TermoWebhook para esquema.
// npm install termo_core --save-exact
import * as webhook from "termo_core/webhook";
// ou: import { webhook } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_paginador_esquema | GET /esquemas.json | Catálogo dos esquemas de evento vigentes |
buscar_paginador_esquema
GET/esquemas.json Pública
Catálogo dos esquemas de evento vigentes
Pública, sem token. Lista todas as versões de esquema que não estão desligadas (ativas e descontinuadas), com o aplicativo dono, o tipo de evento e o JSON Schema dos dados, em ordem de aplicativo, tipo e versão. É a fonte de onde o gerador do TermoCore cria os contratos tipados do crate termo_webhook. Pode guardar em cache por 1 minuto.
function buscar_paginador_esquema(
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.CatalogoDeEsquemas>import { buscar_paginador_esquema } from "termo_core/webhook";
const resposta = await buscar_paginador_esquema();Argumentos
Nome
Tipo
Retorno: Promise<tipos.CatalogoDeEsquemas> · Rust: Result<tipos::CatalogoDeEsquemas, ErroAoChamarServico> · veja CatalogoDeEsquemas.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
CatalogoDeEsquemas
import type { CatalogoDeEsquemas } from "termo_core/webhook";
export interface CatalogoDeEsquemas {
esquemas: Array<EsquemaPublicado>;
}EsquemaPublicado
import type { EsquemaPublicado } from "termo_core/webhook";
export interface EsquemaPublicado {
aplicativo: string;
descricao: string;
esquema_dos_dados: Record<string, unknown>;
situacao: string;
tipo: string;
versao: number;
}