[FEAT] NOTIFICATION API ENDPOINT

[kennie-larkson]

Description

This issue provides a set of API endpoints needed to manage Notifications. These are CRUD endpoints to manage the creation, retrieval and delete operations on Notifications records in the database.

Acceptance Criteria

• Notifications can be created
• Records of Notifications can be retrieved
• Specific Notifications can be updated or deleted by filtering with their Ids

Purpose

Implement a Notification API endpoint to manage user notifications. This endpoint will handle creating, retrieving, and deleting notifications, ensuring users receive timely and relevant updates within the application.

Requirements

• [ ] Endpoint creation

  • Create a new endpoint /api/v1/notifications.
  • Implement methods for CRUD operations: GET, POST, DELETE.

• [ ] Notification Model

  • Define a Notification model with the following properties:
    • id (string, unique, required)
    • user_id (string, required)
    • title (string, required)
    • message (string, required)
    • type (string, e.g., 'info', 'warning', 'error', required)
    • isRead (boolean, default: false)
    • createdAt (timestamp, default: current time)
    • updatedAt (timestamp, default: current time)

• [ ] Endpoints

  • GET /api/v1/notifications: Retrieve all notifications for the authenticated user.
  • GET /api/v1/notifications/:id: Retrieve a single notification by its ID.
  • POST /api/v1/notifications: Create a new notification.
  • DELETE /api/v1/notifications/:id: Delete a notification by its ID.

• [ ] Validation

  • Ensure all required fields are validated
  • Return appropriate error messages for validation failures with HTTP status code 422.

• [ ] Authentication and Authorization

  • Ensure all endpoints are protected and only accessible to authenticated users.
  • Implement checks to ensure users can only access their own notifications.

Expected Outcome

• A fully functional Notification API endpoint that allows users to create, retrieve, and delete their notifications.
• A proper validation to ensure data integrity.
• Secure endpoints that are only accessible to authenticated users.

Database Schema

Table name: notifications_table

- id: 
     - constraints: string(uuid), unique, primary-key, not null
- user_id:
     - constraints: string(uuid), unique
- title:
     - constraints: string
-  message:
    - constraints: string, not null, text
- type:
    - constraints: (string, e.g., 'info', 'warning', 'error', required)
- isRead:
    - constraints: (boolean, e.g 'true')
- createdAt:
    - constraints: datetime
- updatedAt:
    - constraints: datetime  

Database Diagram

An image of the database model

[kennie-larkson]

TEAM Backenders @KennieLarkson

[markessien]

how do you mark notifications as read

[markessien]

what about the ticket to send notification emails (in aggregate and singly)? How does one bulk notify all users in an org?