Documentar as rotas sob o domínio/contexto de /api/settings/push-notifications

[Felipeness]

Describe the feature Documentar as rotas sob o domínio/contexto de /api/settings/push-notifications PATCH

Description

Documentar o endpoint que permite a atualização das configurações de notificações push. Esse endpoint é utilizado para alterar preferências relacionadas ao envio de notificações, como ativar ou desativar notificações, ajustar a frequência de envio, e definir os tipos de notificações que o usuário deseja receber. A documentação deve incluir uma descrição detalhada dos parâmetros do corpo da requisição, explicando o que cada parâmetro representa e como ele afeta o comportamento das notificações push. Além disso, deve conter o formato esperado da resposta, exemplos práticos de requisições e respostas, e uma lista completa dos status codes que podem ser retornados pelo endpoint.

Acceptance Criteria

A documentação deve conter a estrutura detalhada do corpo da requisição, explicando cada parâmetro.
Exemplo de requisição e resposta, demonstrando diferentes cenários de uso (ativação, desativação, ajuste de preferências).
Explicação clara dos status codes possíveis, com foco em erros comuns e como resolvê-los.

Implementation Details

Está no MakeFiles Issue: #119 swag: swag init -g api/main.go -o swagger/

Visual Concepts

[Include any visual representations or concepts if those are available and applicable.]

Additional Information

Se o sistema utiliza algum middleware específico para validação das configurações de notificações push, isso deve ser mencionado aqui. Além disso, se houver alguma limitação, como o número máximo de notificações que podem ser configuradas ou restrições específicas de dispositivos, essas informações devem ser incluídas.

Impedimentos