API Documentation - IP-2025/waves-of-the-fallen GitHub Wiki

This document describes the REST API available for the system.

Base URL

The base URL for all endpoints is: /api/v1

---

Health Check Endpoint

GET /api/v1/healthz

This endpoint is used to check the health status of the application. It checks the overall system health, including the database.

Response:

• 200 OK: The system and database are healthy.

{
  "status": "ok"
}

• 500 Internal Server Error: The system or database is not healthy.

{
  "status": "error",
  "message": "Database is not healthy"
}

---

Authentication Endpoints

POST /api/v1/auth/login

This endpoint allows users to log in by providing their username and password.

Request Body:

{
  "username": "string",
  "password": "string"
}

• username: The username of the user.

• password: The password of the user.

Response: 200 OK: Login was successful.

{
  "message": "Login successful for username"
}

POST /api/v1/auth/register

This endpoint allows new users to register by providing a username and password.

Request Body:

{
  "username": "string",
  "password": "string"
}

• username: The username of the user to be registered.
• password: The password of the user to be registered.

Response:

201 Created: User was successfully registered.

{
  "message": "User username registered"
}