testes/docs/contratos/workspace-routes.json

84 lines
3.1 KiB
JSON

{
"ambiente": "workspace",
"label": "Workspace",
"rotas": [
{
"id": "extrato-listar",
"recurso": "extrato",
"operations": [
{
"method": "GET",
"path": "/extrato/apresentar",
"descricao": "Extrato bancário; filtrar por tipoOperacao C=receitas, D=despesas",
"responseShape": [
{ "field": "idextrato", "type": "number", "description": "ID transação" },
{ "field": "data", "type": "string", "description": "Data" },
{ "field": "descricao", "type": "string", "description": "Descrição" },
{ "field": "valor", "type": "number", "description": "Valor" },
{ "field": "tipoOperacao", "type": "string", "description": "C ou D" },
{ "field": "beneficiario_pagador", "type": "string", "description": "Beneficiário/Pagador" }
],
"suggestedColumns": [
{ "field": "data", "header": "Data", "width": "120px" },
{ "field": "descricao", "header": "Descrição", "width": "400px" },
{ "field": "valor", "header": "Valor", "width": "150px" },
{ "field": "tipo", "header": "Tipo", "width": "120px" }
]
}
]
},
{
"id": "categorias-listar",
"recurso": "categorias",
"operations": [
{
"method": "GET",
"path": "/categorias/apresentar",
"descricao": "Lista categorias para conciliação",
"responseShape": [
{ "field": "id", "type": "number", "description": "ID categoria" },
{ "field": "nome", "type": "string", "description": "Nome" },
{ "field": "descricao", "type": "string", "description": "Descrição" },
{ "field": "tipoMovimento", "type": "string", "description": "Entrada/Saída" }
]
}
]
},
{
"id": "caixinhas-listar",
"recurso": "caixinhas",
"operations": [
{
"method": "GET",
"path": "/caixinhas/apresentar",
"descricao": "Lista caixinhas",
"responseShape": [
{ "field": "id", "type": "number", "description": "ID" },
{ "field": "nome", "type": "string", "description": "Nome" },
{ "field": "banco", "type": "string", "description": "Banco" },
{ "field": "agencia", "type": "string", "description": "Agência" },
{ "field": "conta", "type": "string", "description": "Conta" }
]
}
]
},
{
"id": "contas_a_pagar-listar",
"recurso": "contas_a_pagar",
"operations": [
{
"method": "GET",
"path": "/contas_a_pagar/apresentar",
"descricao": "Contas a pagar planejadas",
"responseShape": [
{ "field": "id", "type": "number", "description": "ID" },
{ "field": "categoria", "type": "string", "description": "Categoria" },
{ "field": "valor", "type": "number", "description": "Valor" },
{ "field": "data", "type": "string", "description": "Data" }
]
}
]
}
]
}