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

99 lines
3.0 KiB
YAML

tags:
- Relatórios de Horários
summary: Criar novo relatório de ponto
description: Registra um novo relatório de horário para um colaborador
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- employee_id
- entry_time
- exit_time
properties:
employee_id:
type: integer
description: ID do colaborador
example: 1
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"
date:
type: string
format: date
description: Data do relatório (opcional, padrão é data atual)
example: "2024-03-27"
status:
type: string
description: Status do relatório
enum: ['Regular', 'Atrasado', 'Saída Antecipada']
example: "Regular"
responses:
'201':
description: Relatório criado com sucesso
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Relatório criado com sucesso"
report_id:
type: integer
example: 10
'400':
description: Requisição inválida
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Dados do relatório inválidos"
'401':
description: Não autorizado
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Token de autenticação inválido"
'404':
description: Colaborador não encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Colaborador não encontrado"
'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