front_ponto_eletronico/docs/contacts/get_by_user_id.yml
2025-03-17 15:00:51 -03:00

52 lines
1.2 KiB
YAML

Contatos do usuário
---
tags:
- Contacts
summary: Este endpoint permite recuperar todos os contatos de um usuário específico pelo seu ID de usuário.
parameters:
- name: user_id
in: path
required: true
type: integer
description: O ID do usuário cujos contatos serão recuperados.
responses:
200:
description: Contatos recuperados com sucesso
schema:
type: object
properties:
contacts:
type: array
items:
type: object
properties:
id:
type: integer
phone:
type: integer
contact_type:
type: string
description:
type: string
examples:
application/json:
contacts:
- id: 1
phone: 123456789
contact_type: "pessoal"
description: "Maria"
- id: 2
phone: 987654321
contact_type: "comercial"
description: "João"
404:
description: Usuário não encontrado ou sem contatos
schema:
type: object
properties:
msg:
type: string
examples:
application/json:
msg: "Usuário não encontrado ou sem contatos"