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

77 lines
2.0 KiB
YAML

tags:
- Contacts
summary: Cria um novo contato associado a um usuário específico.
parameters:
- name: body
in: body
required: true
schema:
type: object
required:
- phone
- contact_type
- user_id
properties:
phone:
type: string
description: "Número de telefone do contato, apenas dígitos. (Obrigatório)"
example: "123456789"
contact_type:
type: string
description: "Tipo de contato (pessoal, comercial, emergência). (Obrigatório)"
example: "pessoal"
description:
type: string
description: "Descrição adicional do contato (opcional)."
example: "João Silva"
user_id:
type: integer
description: "ID do usuário associado ao contato. (Obrigatório)"
example: 1
responses:
201:
description: Contato criado com sucesso.
schema:
type: object
properties:
msg:
type: string
example: "Contato criado com sucesso."
400:
description: Dados inválidos ao criar o contato. Todos os campos obrigatórios devem ser preenchidos.
schema:
type: object
properties:
msg:
type: string
example: "Erro ao criar o contato. Os campos 'phone', 'contact_type', 'description' e 'user_id' são obrigatórios."
401:
description: Token de autenticação inválido ou ausente.
schema:
type: object
properties:
msg:
type: string
example: "Token de autenticação inválido."
404:
description: Usuário associado ao contato não encontrado.
schema:
type: object
properties:
msg:
type: string
example: "Usuário não encontrado."
500:
description: Erro interno no servidor ao criar o contato.
schema:
type: object
properties:
msg:
type: string
example: "Erro interno no servidor."