front_ponto_eletronico/docs/records/create.yml
2025-04-16 19:48:09 -03:00

98 lines
2.7 KiB
YAML

Criar um novo registro de reconhecimento facial
---
tags:
- Registros
parameters:
- name: body
in: body
required: true
schema:
type: object
required:
- user_id
- camera_id
- space_id
- schedule_id
- shift_id
- service_instance_id
- image_path
properties:
user_id:
type: integer
description: ID do usuário associado ao registro
example: 1
camera_id:
type: integer
description: ID da câmera que capturou o registro
example: 1
space_id:
type: integer
description: ID do espaço onde o registro foi capturado
example: 1
schedule_id:
type: integer
description: ID do horário associado ao registro
example: 1
shift_id:
type: integer
description: ID do turno durante o qual o registro foi capturado
example: 1
service_instance_id:
type: integer
description: ID da instância de serviço associada ao registro
example: 1
image_path:
type: string
description: Caminho para a imagem do reconhecimento facial armazenada
example: "/storage/faces/user1/2024-01-20/image1.jpg"
record_count:
type: integer
description: Número de reconhecimentos neste registro (opcional)
example: 1
responses:
201:
description: Registro criado com sucesso
schema:
type: object
properties:
message:
type: string
example: "Registro criado com sucesso"
record:
type: object
properties:
id:
type: integer
example: 1
user_id:
type: integer
example: 1
camera_id:
type: integer
example: 1
space_id:
type: integer
example: 1
schedule_id:
type: integer
example: 1
shift_id:
type: integer
example: 1
service_instance_id:
type: integer
example: 1
image_path:
type: string
example: "/storage/faces/user1/2024-01-20/image1.jpg"
record_count:
type: integer
example: 1
400:
description: Dados da requisição inválidos
schema:
type: object
properties:
error:
type: string
example: "Campo obrigatório ausente: user_id"