Spec de uma Function
O contrato executável de uma Function: sujeito aceito, `input_schema`, `output_schema`, forma temporal e corte, paginação, autoridade, estabilidade, host e o binding legado enquanto existir. Function de cobertura parcial traz `coverage`: quantos sujeitos aceitos já têm o dado, contados na carga do serving.
In: header
Path Parameters
Id da Function em dominio.capitulo.verbo (ex.: funds.profile.get).
Response Body
curl -X GET "https://api.databolsa.com/v1/functions/string"{
"id": "string",
"type": "function",
"module": "string",
"domain": "string",
"title": "string",
"description": "string",
"criterio": "string",
"subject": {
"mode": "object",
"kinds": [
"company"
],
"subkinds": [
"string"
],
"grain": "object"
},
"lifecycle": "default",
"stability": "stable",
"scopes": [
"string"
],
"execute": {
"method": "GET",
"path": "string"
},
"describe": "string",
"legacy_operation": "string",
"version": 1,
"temporal": {
"shape": "series",
"cut": "at"
},
"pagination": "cursor",
"authority": "canonical",
"host": "core",
"input_schema": {
"property1": null,
"property2": null
},
"output_schema": {
"property1": null,
"property2": null
},
"orcamento": {
"calls": 0
},
"example": {
"subject": {
"resolve": "string",
"entity_id": "string",
"kind": "string"
},
"input": {
"property1": null,
"property2": null
},
"series": "string",
"at": "string"
},
"prefer_objects_when": "string",
"nota": "string",
"coverage": {
"covered": 0,
"eligible": 0,
"as_of": "string"
}
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"details": {
"property1": null,
"property2": null
}
}Executa uma Function
Executa QUALQUER Function pelo id — do core (`funds.profile.get`) ou de um módulo instalado no workspace (`wallet.portfolio.get`, `wallet.suitability.get`): esta é a porta única, e o id diz quem responde. Function com sujeito recebe `subject` (`entity_id` ou `resolve`); Function de módulo sem sujeito executa com `input` só. `at` aplica o corte temporal no campo que o spec declara; `series` escolhe o papel quando o grão é por papel. Recusas trazem `details.code`: `subject_required`, `subject_ambiguous` com `candidates`, `function_not_applicable` com `kinds`, `series_required` com `options`, `temporal_cut_unsupported`, `invalid_input`.
Catálogo de Functions
Lista as Functions do core e dos módulos instalados no workspace como descritores curtos: id, título, critério de uso, sujeito, scopes e a rota de execução. `query` casa com id, título, descrição e critério; `domain` recorta (market, credit, wallet…); `subject_kind` recorta às que aceitam um tipo de objeto. Quando nada casa, `meta.hint` diz por onde responder. O spec completo, com `example`, está em `getFunction`.