front_ponto_eletronico/docs/reports/list.yml
2025-03-27 17:38:08 -03:00

107 lines
3.5 KiB
YAML

tags:
- Relatórios de Horários
summary: Consulta de relatórios de ponto eletrônico
description: Recupera lista de todos os relatórios de horários dos colaboradores
security:
- bearerAuth: []
parameters:
- in: query
name: start_date
schema:
type: string
format: date
description: Data inicial para filtro de relatórios
- in: query
name: end_date
schema:
type: string
format: date
description: Data final para filtro de relatórios
- in: query
name: status
schema:
type: array
items:
type: string
enum: ['Regular', 'Atrasado', 'Saída Antecipada']
description: Filtro por status do relatório
responses:
'200':
description: Lista de relatórios recuperada com sucesso
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
description: ID do relatório
example: 1
employee_name:
type: string
description: Nome do colaborador
example: "João Silva"
group:
type: string
description: Grupo/Departamento
example: "Drogasil"
contract_type:
type: string
description: Tipo de contrato
example: "Interno"
date:
type: string
format: date
description: Data do relatório
example: "2024-03-27"
entry_time:
type: string
description: Horário de entrada
example: "08:05"
exit_time:
type: string
description: Horário de saída
example: "17:10"
status:
type: string
description: Status do relatório
enum: ['Regular', 'Atrasado', 'Saída Antecipada']
example: "Atrasado"
'400':
description: Requisição inválida
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Parâmetros de filtro inválidos"
'401':
description: Não autorizado
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Token de autenticação inválido"
'500':
description: Erro interno do servidor
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Erro ao processar a solicitação"
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT