{ "openapi": "3.0.0", "info": { "version": "v1.0.0", "title": "Paulo Gustavo System API Documentation", "description": "Product documentation" }, "servers": [ { "url": "http://localhost:3000/api/v1", "description": "Development enviroment" } ], "tags": [ { "name": "Sessões" }, { "name": "Usuários" }, { "name": "Prefeituras" } ], "paths": { "/status": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/users/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "senha": { "example": "any" }, "tipo_usuario": { "example": "any" }, "cpf_cnpj": { "example": "any" }, "bairro": { "example": "any" }, "cep": { "example": "any" }, "cidade": { "example": "any" }, "complemento": { "example": "any" }, "comunidade": { "example": "any" }, "cpf_representante": { "example": "any" }, "data_nascimento": { "example": "any" }, "endereco": { "example": "any" }, "estado": { "example": "any" }, "etnia": { "example": "any" }, "genero": { "example": "any" }, "grau_escolaridade": { "example": "any" }, "nome": { "example": "any" }, "nome_razao_social": { "example": "any" }, "nome_representante": { "example": "any" }, "nome_social_fantasia": { "example": "any" }, "num_representantes": { "example": "any" }, "orgao_expedidor": { "example": "any" }, "pcd": { "example": "any" }, "renda_mensal": { "example": "any" }, "rg": { "example": "any" }, "telefone": { "example": "any" }, "zona_residencia": { "example": "any" }, "cnpj_ano": { "example": "any" }, "tipo_deficiencia": { "example": "any" }, "tipo_comunidade": { "example": "any" }, "beneficio_social": { "example": "any" }, "tipo_beneficio_social": { "example": "any" } } } } } } } }, "/users/prefeituras": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/users/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/users/pdf/{pastaAnexo}/{pdfUrl}": { "get": { "description": "", "parameters": [ { "name": "pastaAnexo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pdfUrl", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/users/find/cpf_cnpj": { "post": { "description": "", "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cpf_cnpj": { "example": "any" } } } } } } } }, "/users/change-password/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "example": "any" } } } } } } } }, "/login/": { "post": { "description": "", "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "example": "any" }, "senha": { "example": "any" } } } } } } } }, "/editais/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/editais/listar": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/editais/listar/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/editais/listar/prefeitura/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/editais/editar/edital/{edital_id}": { "patch": { "description": "", "parameters": [ { "name": "edital_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/evento/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/evento/listar": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/evento/listar/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/evento/{pdfUrl}": { "get": { "description": "", "parameters": [ { "name": "pdfUrl", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/evento/deletar/{id}": { "delete": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/evento/atualizar/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/inscricoes/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "edital_id": { "example": "any" }, "usuario_id": { "example": "any" }, "acoes_comunidade": { "example": "any" }, "acoes_vulnerabilidade": { "example": "any" }, "anexo_comprovante_residencia": { "example": "any" }, "anexo_projeto_cultural": { "example": "any" }, "categoria": { "example": "any" }, "descricao_trajetoria_cultural": { "example": "any" }, "iniciativa_inovadora": { "example": "any" }, "projeto_comunidade": { "example": "any" }, "acoes_trajetoria_cultural": { "example": "any" }, "trajetoria": { "example": "any" }, "trajetoria_cultural": { "example": "any" }, "coletivo": { "example": "any" }, "tipo_cota": { "example": "any" }, "ano_criacao_coletivo": { "example": "any" }, "num_pessoas_coletivo": { "example": "any" }, "nome_coletivo": { "example": "any" }, "pessoas_coletivo": { "example": "any" } } } } } } } }, "/inscricoes/update/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "edital_id": { "example": "any" }, "usuario_id": { "example": "any" }, "acoes_comunidade": { "example": "any" }, "acoes_vulnerabilidade": { "example": "any" }, "anexo_comprovante_residencia": { "example": "any" }, "anexo_projeto_cultural": { "example": "any" }, "categoria": { "example": "any" }, "descricao_trajetoria_cultural": { "example": "any" }, "iniciativa_inovadora": { "example": "any" }, "projeto_comunidade": { "example": "any" }, "acoes_trajetoria_cultural": { "example": "any" }, "trajetoria": { "example": "any" }, "trajetoria_cultural": { "example": "any" }, "coletivo": { "example": "any" }, "tipo_cota": { "example": "any" }, "ano_criacao_coletivo": { "example": "any" }, "num_pessoas_coletivo": { "example": "any" }, "nome_coletivo": { "example": "any" }, "pessoas_coletivo": { "example": "any" } } } } } } } }, "/inscricoes/create/recurso/{id}": { "post": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "texto_recurso": { "example": "any" }, "edital_id": { "example": "any" } } } } } } } }, "/inscricoes/documento-complementar/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/listar/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/buscar/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/buscar/gerenciar-inscricao/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/atualizar/avaliacao/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/inscricoes/buscar/minha-inscricao/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/edital/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/buscar/edital/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "nome_usuario", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/edital/{id}/status/{status}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/edital/cassificacao/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/edital/dashboard/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/buscar/inscritos/avaliados/{edital_id}/{status}": { "get": { "description": "", "parameters": [ { "name": "edital_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/aceitam/recursos/{usuario_id}": { "get": { "description": "", "parameters": [ { "name": "usuario_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/inscricoes/recursos/solicitados": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/inscricoes/prestacao-contas/habilitados": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/inscricoes/iniciar/financeiro/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/inscricoes/pdf/{pastaAnexo}/{pdfUrl}": { "get": { "description": "", "parameters": [ { "name": "pastaAnexo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pdfUrl", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/listar": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/listar/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/listar/todas/usuario": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/{pdfUrl}": { "get": { "description": "", "parameters": [ { "name": "pdfUrl", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/deletar/{id}": { "delete": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/prestacao-contas/atualizar/{id}": { "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/criterios/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/criterios/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/criterios/listar/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/criterio-item/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/criterio-item/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } }, "/avaliacao/create": { "post": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/avaliacao/listar": { "get": { "description": "", "responses": { "200": { "description": "OK" } } } }, "/avaliacao/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/avaliacao/listar/inscricao/{id}": { "get": { "description": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/avaliacao/editar/{edital_id}": { "patch": { "description": "", "parameters": [ { "name": "edital_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "example": "any" } } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }