[api] Criar o endpoint de inscrição em uma oportunidade

[henriquelopeslima]

WHAT

Desenvolver um endpoint de API para inscrição em uma oportunidade específica. Cada inscrição deve estar associada a uma oportunidade existente, e um agente existente, mantendo essas relações como obrigatórias.

Exemplo de rota: POST /opportunities/{id}/inscriptions

DESCRIPTION

Este endpoint permitirá realizar uma incrição de um agente em uma oportunidade, com todas as validações necessárias para garantir integridade e coerência dos dados. Além disso, deverá ser acompanhado de testes e documentação para garantir que a funcionalidade esteja de acordo com os padrões do projeto.

ADDITIONAL INFO

1. Rota: Definir a rota do endpoint de inscrição na oportunidade.

2. Regras de Negócio:

   • A inscrição deve ser obrigatoriamente associadas a uma oportunidade válida e existente.
   • A inscrição deve ser obrigatoriamente associadas a um agente válido e existente.

3. Validações:

   • Garantir que a inscrição só possa ser realizada se houver uma oportunidade com o {id} fornecido.
   • Garantir que a inscrição só possa ser realizada uma vez

4. Resposta de Sucesso: O endpoint deve retornar:

   • Status: 201 Created ao se inscrever com sucesso.
   • Corpo: Dados da inscrição registrada.

CHECKLIST

• [ ] Definir a rota do endpoint: configurar o caminho para a inscrição do agente na oportunidades.
• [ ] Implementar a lógica inscrição: desenvolver a funcionalidade para inscrição, respeitando as regras de negócio e validações definidas.
• [ ] Implementar Testes Automatizados: para cobrir os casos de sucesso e erro.
• [ ] Documentar o Endpoint: adicionar à documentação da API uma seção para o endpoint de inscrição, com exemplos de requisição, resposta, e códigos de erro.