[FEAT] Fetch single user API

[scottandee]

Description

Develop API endpoint to fetch a single user

Acceptance Criteria

• The endpoint should be accessible at api/v1/users/:userId
• The endpoint should accept HTTP GET requests.
• The endpoint should be secured to ensure that only authenticated users can fetch all users
• The endpoint should check that the user has the appropriate permissions
• Requests to the endpoint must include a valid authentication token in the Authorization header. Authorization: Bearer <token>
• Given a request with a valid user ID, when the user is authenticated and authorized, the system should retrieve the user's information with a status code of 200.
• Given a request with an invalid or non-existent user ID, when the user is authenticated and authorized, the system should return a 404 Not Found status.

Request

Endpoint

GET /api/v1/users/:userId

Parameters:

• userId: string

Expected Outcome

• Successful Response

  {
  "status": "success",
  "message": "User retrieved successfully",
  "user": {
  "id": "String",
  "name": "String",
  "email": "String",
  "phoneNumber": "String"
  }
  }

• Error Response:

{
  "status":string,
  "message": string,
  "status_code":int
}

Purpose

Provides a backend service which allows users to fetch a single user

Requirements

• [ ] Develop server-side logic to fetch a single user
• [ ] Ensure compliance with security standards for handling user information.

Tasks

Create User Fetching Logic

• [ ] Implement the GET /api/users/:userId endpoint.
• [ ] Query the database to retrieve user details by user ID.
• [ ] Handle errors and return appropriate responses when the user is not found.

Authorization Checks

• [ ] Ensure that only authorized users (e.g., the user themselves or administrators) can access this endpoint.
• [ ] Implement middleware to check if the requester is authorized to fetch user details.

Database Operations:

• [ ] Create a schema for storing user details if not already existing.
• [ ] Securely retrieve user details from the database.
• [ ] Ensure compliance with data protection standards.

Error Handling and Logging:

• [ ] Implement comprehensive error handling for different failure scenarios (e.g., user not found, unauthorized access).
• [ ] Log errors and access attempts for monitoring and troubleshooting.

Tests

1. Write unit tests for the GET /api/users/:userId endpoint.
2. Write unit tests for validation and error handling logic.
3. Write integration tests for the end-to-end user fetching process.
4. Test the full flow from requesting user details to receiving the response.
5. Ensure the system handles successful and failed requests appropriately.

[markessien]

Retrieval by superadmin is not different from standard retrieval

[King-Mikaelson]

Team Members working on this issue include:

• Essd- Python - Slack_Id - Essd
• Heisienberg - PHP - Slack_Id - Heisienberg

I couldn't assign them directly to the repo since they don't have access to the repo

[buka4rill]

change statusCode to status_code

[King-Mikaelson]

change statusCode to status_code

Done thank you