front_ponto_eletronico/docs/users/hierarchy_without_id.yml
2025-03-17 15:00:51 -03:00

75 lines
2.3 KiB
YAML

Visualização da hierarquia de usuários
---
tags:
- Users
summary: Visualização da hierarquia de usuários
description: >
Este endpoint retorna a hierarquia de subordinados associada a um usuário responsável.
Inclui informações detalhadas sobre os subordinados diretos e seus subordinados, se houver.
responses:
200:
description: Hierarquia retornada com sucesso.
schema:
type: object
properties:
responsible_id:
type: integer
example: 1
responsible_name:
type: string
example: responsible_user
hierarchy:
type: array
items:
type: object
properties:
subordinate_id:
type: integer
example: 42
subordinate_name:
type: string
example: subordinate_user
email:
type: string
example: subordinate@example.com
phone:
type: string
example: 5511999999999
profile_image:
type: string
example: https://example.com/profile.jpg
birth_date:
type: string
format: date
example: 1990-01-01
subordinates:
type: array
items:
type: object
properties:
subordinate_id:
type: integer
example: 101
subordinate_name:
type: string
example: junior_user
email:
type: string
example: junior_user@example.com
400:
description: Erro na solicitação, como ausência de parâmetros obrigatórios.
schema:
type: object
properties:
error:
type: string
example: O parâmetro `responsible_id` é obrigatório.
401:
description: Não autorizado.
schema:
type: object
properties:
error:
type: string
example: Token inválido ou expirado.