[FEAT]: Get Waitlist Endpoint (admin) - BACKEND

[Afeh]

Description

Create a backend API endpoint to return emails of users that register on the waitlist signup form on the website.

Acceptance Criteria

• The endpoint should be accessible at api/v1/waitlist/users.
• The endpoint should accept GET requests to retrieve user information.
• Return a 200 OK status with a dictionary containing all the emails of users that signup for the waitlist.
• Only a user with admin permissions can successfully retrieve emails on the waitlist.

METHOD

GET 

URL

api/v1/waitlist/users

RESPONSE

Successful Response (status code: 200)

{
"message": "waitlist retrieved successfully", 
"status_code": 200,
"data": ["usermail@example.com", "usermail2@example.com"]
}

Error Response (status_code: 401)

{
"message": "user does not have admin privileges"
"status_code": 401,
"data": {}
}

Purpose

To allow admin to retrieve users that registered on the waitlist form.

Requirements

• [ ] Develop a RESTful API endpoint to handle GET requests.
• [ ] Verify that the user trying to access the endpoint has admin privileges.
• [ ] Retrieve and display user information from the database.

Expected Outcome

A secure and efficient endpoint that can retrieve user waitlist information stored in the database.

Testing

• Test that the endpoint returns a 200 OK status code with a success message on authorized retrieval.
• Test that the endpoint retrieves user waitlist information stored in the database.
• Test that the endpoint returns a 401 Unauthorized status code on unauthorized access.

[Nifilat]

Hi Afeh, I think your endpoint should be api/v1/waitlist/users not /join

[Afeh]

Hi. Noted. I'd make the change

On Tue, Jul 23, 2024, 4:40 PM OLUWANIFEMI @.***> wrote:

Hi Afeh, I think your endpoint should be api/v1/waitlist/users not /join

— Reply to this email directly, view it on GitHub https://github.com/hngprojects/hng_boilerplate_python_fastapi_web/issues/235#issuecomment-2245592658, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQR6ZOMCKHMAO6OGN2MVAM3ZNZ2QNAVCNFSM6AAAAABLKVZORSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENBVGU4TENRVHA . You are receiving this because you authored the thread.Message ID: <hngprojects/hng_boilerplate_python_fastapi_web/issues/235/2245592658@ github.com>