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

74 lines
1.9 KiB
YAML

tags:
- Contacts
summary: Obtém os detalhes de um contato específico associado a um usuário.
security:
- bearerAuth: []
parameters:
- in: path
name: contact_id
required: true
schema:
type: integer
description: ID do contato que você deseja obter.
responses:
200:
description: Detalhes do contato retornados com sucesso.
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 1
phone:
type: string
description: Número de telefone do contato.
example: "123456789"
contact_type:
type: string
description: Tipo do contato (pessoal, comercial, emergência).
example: "pessoal"
description:
type: string
description: Descrição adicional do contato.
example: "João Silva"
user_id:
type: integer
description: ID do usuário associado ao contato.
example: 1
404:
description: Contato não encontrado no banco de dados.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "Contato com ID 5 não encontrado."
401:
description: Token de autenticação inválido ou ausente.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "Token de autenticação inválido."
500:
description: Erro interno do servidor ao tentar recuperar o contato.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "Erro interno no servidor."