Implement Endpoints for CRUD Operations of FAQ

[Horlarhyinka]

Description

Develop API endpoints to handle CRUD (Create, Read, Update, Delete) operations for Frequently Asked Questions (FAQs). This will allow admins to manage FAQ entries through the backend.

Purpose

To provide admins with the ability to manage FAQ entries efficiently, improving the overall user experience by keeping the FAQ section up-to-date.

Requirements

• Admin must be authenticated and authorized.
• Error handling
• Develop server-side logic to handle CRUD operations for FAQs.

Expected Outcome

The backend should handle CRUD operations for FAQ entries efficiently and log responses and errors properly.

Endpoints

1. Create FAQ Entry:

   • Endpoint: HTTP POST /api/v1/faqs
   • Request Body:

     {
     "question": "String",
     "answer": "String",
     "category": "String"
     }

   • Response (Success):

     {
     "id": "String",
     "question": "String",
     "answer": "String",
     "category": "String"
     }

   • Response (Error - Invalid Request):

     {
     "message": "Invalid request data",
     "status_code": 400
     }

   • Response (Authorization Error):

     {
     "message": "Unauthorized access",
     "status_code": 403
     }

2. Read FAQ Entries:

   • Endpoint: HTTP GET /api/v1/faqs
   • Response (Success):

     [
     {
      "id": "String",
      "question": "String",
      "answer": "String",
      "category": "String"
     }
     ]

   • Response (Error - Invalid Request):

     {
     "message": "Invalid request",
     "status_code": 400
     }

3. Update FAQ Entry:

   • Endpoint: HTTP PUT /api/v1/faqs/{id}
   • Request Body:

     {
     "question": "String",
     "answer": "String",
     "category": "String"
     }

   • Response (Success):

     {
     "id": "String",
     "question": "String",
     "answer": "String",
     "category": "String"
     }

   • Response (Error - Invalid Request):

     {
     "message": "Invalid request data",
     "status_code": 400
     }

   • Response (Authorization Error):

     {
     "message": "Unauthorized access",
     "status_code": 403
     }

4. Delete FAQ Entry:

   • Endpoint: HTTP DELETE /api/v1/faqs/{id}
   • Response (Success):

     {
     "message": "FAQ entry deleted successfully"
     }

   • Response (Error - Invalid Request):

     {
     "message": "Invalid request",
     "status_code": 400
     }

   • Response (Authorization Error):

     {
     "message": "Unauthorized access",
     "status_code": 403
     }

Acceptance Criteria

• [ ] Implement endpoints for creating, reading, updating, and deleting FAQ entries.
• [ ] Validate input data for each operation.
• [ ] Creating and updating FAQs should require admin authorization.
• [ ] Error Handling:
  • Log errors for invalid requests.
  • Display clear error messages for invalid inputs.
• [ ] Security Measures:
  • Validate user input on the server side.
  • Ensure only authenticated and authorized users can perform CRUD operations on FAQs.

[markessien]

This is not a supported feature

[Shullyd7]

Specify the errors and their status_code

[Shullyd7]

You have to specify the error message that required that status_code