swagger.json

{
    "openapi": "3.0.0",
    "info": {
        "title": "ENA Map Server API",
        "description": "Este projeto é uma API do Servidor de Mapas do ENA",
        "version": "1.0.0"
    },

    "paths": {
        "tags": ["Usuários", "Mapas", "Grupos"],

        "/v1/users": {
            "post": {
                "description": "Criação de um usuário. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "requestBody": {
                    "description": "Dados necessários para cadastrar um usuário",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Request_CreateUser"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Usuário cadastrado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_User"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados de usuário incorretos ou e-mail já existe"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            },
            "get": {
                "description": "Retorna uma lista paginada e filtrada de usuários. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "query",
                        "name": "search",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "John",
                            "description": "Busca pelo nome do usuário"
                        }
                    },
                    {
                        "in": "query",
                        "name": "page",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "1",
                            "description": "Número da página"
                        }
                    },
                    {
                        "in": "query",
                        "name": "perPage",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "10",
                            "description": "Número de itens por página"
                        }
                    },
                    {
                        "in": "query",
                        "name": "userTypes",
                        "required": false,
                        "schema": {
                            "type": "array",
                            "example": [3],
                            "description": "Filtragem de usuários pelo campo 'Tipo'"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Response_User"
                                            }
                                        },
                                        "limit": {
                                            "type": "number",
                                            "example": 10,
                                            "description": "Limite de dados por página"
                                        },
                                        "page": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Número da página atual"
                                        },
                                        "count": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Contagem do total de usuários compatíveis com estes filtros, exceto os parâmetros: 'page' e 'perPage'"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados de usuário incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/users/{id}": {
            "get": {
                "description": "Retorna um usuário pelo campo Id. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do usuário",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_User"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados de usuário incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Usuário não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            },
            "put": {
                "description": "Atualização de um usuário. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do usuário",
                        "required": true,
                        "type": "string"
                    }
                ],
                "requestBody": {
                    "description": "Dados necessários para atualizar um usuário",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Request_UpdateUser"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Usuário atualizado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_CreateUser"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados de usuário incorretos ou e-mail já existe"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Usuário não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/users/group_id/{id}": {
            "get": {
                "description": "Retorna uma lista de usuários que pertence ao campo de Id do Grupo. Obs: Ação permitida apenas para -> Administrador, Professor, Aluno",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "group_id",
                        "description": "Id do grupo",
                        "required": true,
                        "type": "number"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_User"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/users/listAll": {
           "get": {
                "description": "Retorna todos os usuários. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_User"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados de usuário incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/users/file": {
            "post": {
                "description": "Cadastro de usuários via arquivo .csv. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Usuários"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "formData",
                        "name": "tb_users",
                        "type": "file",
                        "description": "Arquivo CSV contendo os usuários a serem cadastrados"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Usuários cadastrados com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_User"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados de usuário incorretos ou e-mail já existe"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/users/auth": {
            "post": {
                "description": "Autenticação de um usuário",
                "tags": [ "Usuários"],
                "requestBody": {
                    "description": "Dados necessários para autenticar um usuário",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "email": {
                                        "type": "string",
                                        "example": "johndoe@email.com",
                                        "description": "Email do usuário"
                                    },
                                    "password": {
                                        "type": "string",
                                        "example": "Johndoe!123",
                                        "description": "Senha do usuário"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Usuário autenticado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "access_token": {
                                            "type": "string",
                                            "description": "Token de acesso"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Login incorreto"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },

        "/v1/maps": {
            "post": {
                "description": "Criação de um Mapa. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "formData",
                        "name": "file",
                        "type": "file",
                        "description": "Arquivo do Mapa"
                    }
                ],
                "requestBody": {
                    "description": "Dados necessários para cadastrar um Mapa",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Request_CreateMap"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Mapa cadastrado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Map"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            },
            "get": {
                "description": "Retorna uma lista paginada e filtrada de Mapas. Obs: O usuário precisa estar autenticado",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "query",
                        "name": "search",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "John",
                            "description": "Busca pelo nome do Mapa"
                        }
                    },
                    {
                        "in": "query",
                        "name": "page",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "1",
                            "description": "Número da página"
                        }
                    },
                    {
                        "in": "query",
                        "name": "perPage",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "10",
                            "description": "Número de itens por página"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Response_Map_Paged"
                                            }
                                        },
                                        "limit": {
                                            "type": "number",
                                            "example": 10,
                                            "description": "Limite de dados por página"
                                        },
                                        "page": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Número da página atual"
                                        },
                                        "count": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Contagem do total de Mapas compatíveis com estes filtros, exceto os parâmetros: 'page' e 'perPage'"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/maps/{id}": {
            "get": {
                "description": "Retorna um Mapa pelo campo Id. Obs: O usuário precisa estar autenticado",
                "tags": [ "Mapas" ],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Mapa",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Map"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Mapa não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            },
            "put": {
                "description": "Atualização de um Mapa. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Mapa",
                        "required": true,
                        "type": "string"
                    }
                ],
                "requestBody": {
                    "description": "Dados necessários para atualizar um Mapa",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Request_UpdateMap"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Mapa atualizado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Map"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Mapa não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/maps/group_id/{id}": {
            "get": {
                "description": "Retorna uma Lista de Mapas, filtrando pelo Id do Grupo. Obs: Ação permitida apenas para -> Administrador, Professor, Aluno",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Grupo",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Map"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Mapa não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/maps/{id}/download/public": {
            "get": {
                "description": "Baixa um Mapa através do campo Id. Obs: O usuário precisa estar autenticado",
                "tags": [ "Mapas" ],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Mapa",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Arquivo de Mapa baixado com sucesso!"
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Mapa não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/maps/search": {
            "get": {
                "description": "Retorna uma lista filtrada de Mapas pelo nome. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "query",
                        "name": "query",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "John",
                            "description": "Busca pelo nome do Mapa"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Map_Paged"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/maps/convert_xml": {
            "post": {
                "description": "Este Script converte arquivos de Mapas em formato XML, que é lido pelo jogo ENA, para o formato JSON, que é registrado e lido pelo Servidor de Mapas. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "formData",
                        "name": "file",
                        "type": "array",
                        "description": "Arquivo do Mapa XML"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Mapa convertido com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Map"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/maps/listAll": {
            "get": {
                "description": "Retorna todos os Mapas. Obs: O usuário precisa estar autenticado",
                "tags": [ "Mapas"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Map"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },

        "/v1/groups": {
            "post": {
                "description": "Criação de um grupo. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "requestBody": {
                    "description": "Dados necessários para cadastrar um Grupo",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Request_CreateGroup"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Grupo cadastrado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Group"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            },
            "get": {
                "description": "Retorna uma lista paginada e filtrada de Grupos. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "query",
                        "name": "search",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "John",
                            "description": "Busca pelo nome do Grupo"
                        }
                    },
                    {
                        "in": "query",
                        "name": "page",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "1",
                            "description": "Número da página"
                        }
                    },
                    {
                        "in": "query",
                        "name": "perPage",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "10",
                            "description": "Número de itens por página"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Response_Group_List"
                                            }
                                        },
                                        "limit": {
                                            "type": "number",
                                            "example": 10,
                                            "description": "Limite de dados por página"
                                        },
                                        "page": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Número da página atual"
                                        },
                                        "count": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Contagem do total de Grupos compatíveis com estes filtros, exceto os parâmetros: 'page' e 'perPage'"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/groups/{id}": {
            "get": {
                "description": "Retorna um Grupo pelo campo Id. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Grupo",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Group"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Grupo não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            },
            "put": {
                "description": "Atualização de um Grupo. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Grupo",
                        "required": true,
                        "type": "string"
                    }
                ],
                "requestBody": {
                    "description": "Dados necessários para atualizar um Grupo",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Request_UpdateGroup"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Grupo atualizado com sucesso!",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Response_Group"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Grupo não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/groups/{id}/maps": {
            "get": {
                "description": "Retorna os mapas de um Grupo, através do Id do Grupo. Obs: O usuário precisa estar autenticado",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "id",
                        "description": "Id do Grupo",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Group_Map"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Grupo não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/groups/users/{userId}/groups": {
            "get": {
                "description": "Retorna uma lista paginada e filtrada de Grupos de um Usuário através do User Id. Obs: O usuário precisa estar autenticado",
                "tags": ["Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "userId",
                        "description": "Id do Usuário",
                        "required": true,
                        "type": "number"
                    },
                    {
                        "in": "query",
                        "name": "search",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "John",
                            "description": "Busca pelo nome do Grupo"
                        }
                    },
                    {
                        "in": "query",
                        "name": "page",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "1",
                            "description": "Número da página"
                        }
                    },
                    {
                        "in": "query",
                        "name": "perPage",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "10",
                            "description": "Número de itens por página"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Response_Group_List"
                                            }
                                        },
                                        "limit": {
                                            "type": "number",
                                            "example": 10,
                                            "description": "Limite de dados por página"
                                        },
                                        "page": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Número da página atual"
                                        },
                                        "count": {
                                            "type": "number",
                                            "example": 1,
                                            "description": "Contagem do total de Grupos compatíveis com estes filtros, exceto os parâmetros: 'page' e 'perPage'"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/groups/{idGroup}/user/{idUser}": {
            "get": {
                "description": "Retorna uma lista paginada e filtrada de Mapas através do Id do Usuário e o Id do Grupo. Obs: O usuário precisa estar autenticado",
                "tags": ["Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "idUser",
                        "description": "Id do Usuário",
                        "required": true,
                        "type": "number"
                    },
                    {
                        "in": "path",
                        "name": "idGroup",
                        "description": "Id do Grupo",
                        "required": true,
                        "type": "number"
                    },
                    {
                        "in": "query",
                        "name": "offset",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "example": "1",
                            "description": "Número do índice que o banco irá iniciar a recuperação dos dados"
                        }
                    },
                    {
                        "in": "query",
                        "name": "limit",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "example": "10",
                            "description": "Número de itens por página"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Map"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/groups/next-map/{email}": {
            "get": {
                "description": "Retorna o próximo mapa de um usuário pertencente a um grupo, através do próprio email. Obs: O usuário precisa estar autenticado",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "email",
                        "description": "Email do usuário",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Map_NextMap"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "404": {
                        "description": "Grupo não encontrado"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        },
        "/v1/groups/listAll": {
            "get": {
                "description": "Retorna todos os grupos. Obs: Ação permitida apenas para -> Administrador, Professor",
                "tags": [ "Grupos"],
                "security": [
                    { "bearerAuth": [] }
                ],
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/Response_Group_List"
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Dados incorretos"
                    },
                    "401": {
                        "description": "Usuário não autorizado para executar esta ação"
                    },
                    "500": {
                        "description": "Erro interno do Servidor"
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "description": "Autenticação utilizando JWT",
                "type": "http",
                "scheme": "bearer",
                "bearerFormat": "JWT"
            }
        },
        "schemas": {
            "Request_CreateUser": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "example": "John Doe",
                        "required": true,
                        "description": "Nome do usuário"
                    },
                    "email": {
                        "type": "string",
                        "example": "johndoe@email.com",
                        "required": true,
                        "description": "Email do usuário"
                    },
                    "password": {
                        "type": "string",
                        "example": "Password!123",
                        "required": true,
                        "description": "Senha do usuário"
                    },
                    "type": {
                        "required": true,
                        "description": "Tipo do usuário. 1=Admin, 2=Professor, 3=Aluno",
                        "enum": [1, 2, 3]
                    }
                }
            },
            "Request_UpdateUser": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "example": "John Doe",
                        "required": true,
                        "description": "Nome do usuário"
                    },
                    "email": {
                        "type": "string",
                        "example": "johndoe@email.com",
                        "required": true,
                        "description": "Email do usuário"
                    },
                    "password": {
                        "type": "string",
                        "example": "Password!123",
                        "required": false,
                        "description": "Senha do usuário"
                    },
                    "type": {
                        "required": true,
                        "description": "Tipo do usuário. 1=Admin, 2=Professor, 3=Aluno",
                        "enum": [1, 2, 3]
                    }
                }
            },
            "Response_User": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do usuário"
                    },
                    "name": {
                        "type": "string",
                        "example": "John Doe",
                        "description": "Nome do usuário"
                    },
                    "email": {
                        "type": "string",
                        "example": "johndoe@email.com",
                        "description": "Email do usuário"
                    },
                    "type": {
                        "required": true,
                        "description": "Tipo do usuário. 1=Admin, 2=Professor, 3=Aluno",
                        "enum": [1, 2, 3]
                    },
                    "created_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de criação do usuário"
                    },
                    "updated_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de atualização do usuário"
                    },
                    "sub": {
                        "type": "string",
                        "format": "uuid",
                        "example": "2441398a-060c-45e1-be8f-4080858a24f2",
                        "description": "Campo registrado pelo JWT"
                    }
                }
            },

            "Request_CreateGroup": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "example": "ENA Test",
                        "required": true,
                        "description": "Nome do Grupo"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "required": true,
                        "description": "Id do proprietário do Grupo"
                    },
                    "users": {
                        "required": false,
                        "description": "Id dos Usuários pertencentes ao Grupo",
                        "example": [1, 2, 3]
                    },
                    "maps": {
                        "required": false,
                        "description": "Id dos Mapas pertencentes ao Grupo",
                        "example": [1, 2, 3]
                    }
                }
            },
            "Request_UpdateGroup": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "example": "ENA Test",
                        "required": true,
                        "description": "Nome do Grupo"
                    },
                    "users": {
                        "required": false,
                        "description": "Id dos Usuários pertencentes ao Grupo",
                        "example": [1, 2, 3]
                    },
                    "maps": {
                        "required": false,
                        "description": "Id dos Mapas pertencentes ao Grupo",
                        "example": [1, 2, 3]
                    }
                }
            },
            "Response_Group": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Grupo"
                    },
                    "name": {
                        "type": "string",
                        "example": "ENA Test",
                        "description": "Nome do Grupo"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do proprietário do grupo"
                    },
                    "created_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de criação do usuário"
                    },
                    "updated_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de atualização do usuário"
                    },
                    "users": {
                        "description": "Lista de Usuários pertencentes ao Grupo",
                        "type": "array",
                        "example": [
                            {
                                "id": 6,
                                "email": "johndoe@email.com",
                                "type": 3,
                                "sub": "37445106-b4cb-49b8-8334-634a0b835c58",
                                "name": "john Doe",
                                "created_at": "2023-05-12T23:56:07.639Z",
                                "updated_at": "2023-10-26T23:07:45.698Z"
                            }
                        ]
                    },
                    "maps": {
                        "description": "Lista de Mapas pertencentes ao Grupo",
                        "type": "array",
                        "example": [
                            {
                                "id": 2,
                                "id_owner": 11,
                                "name": "Pavilhão 2",
                                "thumb_url": "https://www.url_da_thumb.com/thumb.jpg",
                                "tag": "",
                                "url": "www.url_do_mapa.com",
                                "created_at": "2023-05-13T07:26:46.966Z",
                                "updated_at": "2023-05-13T07:26:46.966Z"
                            }
                        ]
                    }
                }
            },
            "Response_Group_List": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Grupo"
                    },
                    "name": {
                        "type": "string",
                        "example": "ENA Test",
                        "description": "Nome do Grupo"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do proprietário do grupo"
                    },
                    "created_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de criação do usuário"
                    },
                    "updated_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de atualização do usuário"
                    }
                }
            },
            "Response_Group_Map": {
                "type": "object",
                "properties": {
                    "id_professor": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Professor proprietário do Mapa"
                    },
                    "id_mapa": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Mapa"
                    },
                    "mapa_json": {
                        "type": "object",
                        "description": "Metadados do Mapa",
                        "example": { "tag": "" }
                    }
                }
            },

            "Request_CreateMap": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "example": "ENA Test",
                        "required": true,
                        "description": "Nome do Grupo"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "required": true,
                        "description": "Id do proprietário do Mapa"
                    }
                }
            },
            "Request_UpdateMap": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "example": "ENA Test",
                        "required": true,
                        "description": "Nome do Grupo"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "required": true,
                        "description": "Id do proprietário do Mapa"
                    },
                    "new_file": {
                        "type": "string",
                        "example": "",
                        "required": true,
                        "description": "Novo arquivo do Mapa"
                    },
                    "last_file_name": {
                        "type": "string",
                        "example": "last_filename.json",
                        "required": true,
                        "description": "Nome do Ultimo arquivo inserido"
                    }
                }
            },
            "Response_Map": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Mapa"
                    },
                    "name": {
                        "type": "string",
                        "example": "Pavilhao 1",
                        "description": "Nome do Mapa"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do proprietário do Mapa"
                    },
                    "url": {
                        "type": "string",
                        "example": "https://www.url_do_mapa.com/mapa/123",
                        "description": "Url do Mapa"
                    },
                    "thumb_url": {
                        "type": "string",
                        "example": "https://www.url_da_thumb_do_mapa.com/mapa/123",
                        "description": "Url da Thumbnail do Mapa"
                    },
                    "tag": {
                        "type": "string",
                        "example": "",
                        "description": "Metadados do Mapa"
                    },
                    "created_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de criação do usuário"
                    },
                    "updated_at": {
                        "type": "datetime",
                        "example": "2023-12-07T00:51:24.280Z",
                        "description": "Data de atualização do usuário"
                    }
                }
            },
            "Response_Map_Paged": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Mapa"
                    },
                    "name": {
                        "type": "string",
                        "example": "Pavilhao 1",
                        "description": "Nome do Mapa"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do proprietário do Mapa"
                    },
                    "thumb_url": {
                        "type": "string",
                        "example": "https://www.url_da_thumb_do_mapa.com/mapa/123",
                        "description": "Url da Thumbnail do Mapa"
                    },
                    "tag": {
                        "type": "string",
                        "example": "",
                        "description": "Metadados do Mapa"
                    }
                }
            },
            "Response_Map_NextMap": {
                "type": "object",
                "properties": {
                    "id_map": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Mapa"
                    },
                    "id_user": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do Usuário"
                    },
                    "id_owner": {
                        "type": "number",
                        "example": 1,
                        "description": "Id do proprietário do Mapa"
                    },
                    "name": {
                        "type": "string",
                        "example": "Pavilhao 1",
                        "description": "Nome do Mapa"
                    },
                    "json": {
                        "type": "string",
                        "example": "",
                        "description": "Metadados do Mapa"
                    }
                }
            }
        }
    }
}