Implement Search mentor endpoint (Admin)

janithlahirukariyawasam commented 1 year ago

Description: This issue involves implementing an API to search mentors. The endpoint should allow clients to make a GET request to {{baseUrl}}/api/admin/mentors?q={{query}}.

[
    {
        "mentorId": 1,
        "category": "Computer Science",
        "profile": {
            "contact_email": "thomas@gmail.com",
            "first_name": "John",
            "last_name": "Daniel",
            "image_url": "https://www.linkedin.com/thomas",
            "linkedin_url": "https://www.linkedin.com/thomas"
        },
        "application": {
            "position": "Software Engineer",
            "bio": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "additonalLinks": [
                "https://www.linkedin.com",
                "https://www.google_scholar.com"
            ],
            "slots": 10
        }
    },
    {
        "mentorId": 2,
        "category": "Data Science",
        "profile": {
            "contact_email": "mandy@gmail.com",
            "first_name": "Mandy",
            "last_name": "John",
            "image_url": "https://www.linkedin.com/mandy",
            "linkedin_url": "https://www.linkedin.com/mandy"
        },
        "appilcation": {
            "position": "Senior Software Engineer",
            "bio": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "additonalLinks": [
                "https://www.linkedin.com",
                "https://www.google_scholar.com"
            ],
            "slots": 10
        }
    }
]

Tasks:

Create a controller for the /controllers/mentor endpoint in the backend (create the route mentor if not created).
Parse and validate the request body to ensure it matches the expected format.
Implement appropriate error handling and response status codes for different scenarios (e.g., validation errors, database errors).
Write unit tests to validate the functionality and correctness of the endpoint.

API documentation: https://documenter.getpostman.com/view/27421496/2s93m1a4ac#8744a3ee-970f-489a-853d-8b23fdee8de3

ER diagram: https://drive.google.com/file/d/11KMgdNu2mSAm0Ner8UsSPQpZJS8QNqYc/view

Acceptance Criteria:

The profile API endpoint /controllers/mentor is implemented via a GET request.
The request body is properly parsed and validated for the required format.
Appropriate error handling is implemented, providing meaningful error messages and correct response status codes.
Unit tests are written to validate the functionality and correctness of the endpoint.

Additional Information: No

Related Dependencies or References: No

sathudeva7 commented 1 year ago

@anjula-sack I'd love to work on this issue, Can u explain what are the query parameters need to pass here

anjula-sack commented 1 year ago

https://github.com/sef-global/scholarx-backend/pull/75

sef-global / scholarx-backend

Implement Search mentor endpoint (Admin) #25