.. _api-reference:

API Reference
=============

This page contains the complete API reference for all custom endpoints that are running on the backend server. Once you have the server running locally, you can 
access the API via the following url: http://localhost:3001/api. 

.. openapi:: ../openapi.json

Source Code Links
-----------------

.. note::

   **View Source Code**: Each API endpoint is implemented in `server.js <https://github.com/chavezMac/toast/blob/main/report/backend/server.js>`_.
   Click on any endpoint below to see its implementation details.

All API endpoints are defined in the following file:

- `server.js <https://github.com/chavezMac/toast/blob/main/report/backend/server.js>`_ - Main API server with all route handlers

Quick Reference - Endpoint Locations in server.js:

- `GET / <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L107>`_ - Line 107
- `GET /api/health <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L116>`_ - Line 116
- `POST /api/register <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L140>`_ - Line 140 (Admin only)
- `POST /api/login <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L197>`_ - Line 197
- `GET /api/me <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L294>`_ - Line 294
- `GET /api/current-stock <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L315>`_ - Line 315
- `GET /api/daily-summary <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L329>`_ - Line 329
- `GET /api/store-performance <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L356>`_ - Line 356
- `GET /api/item-performance <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L370>`_ - Line 370 
- `GET /api/out-of-stock <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L421>`_ - Line 421
- `GET /api/time-windows <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L448>`_ - Line 448
- `GET /api/weekly-trends <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L495>`_ - Line 495
- `GET /api/stores <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L524>`_ - Line 524
- `GET /api/weekly-sales-stores <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L539>`_ - Line 539 
- `GET /api/weekly-sales-years <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L554>`_ - Line 554
- `GET /api/items <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L569>`_ - Line 569
- `GET /api/daily-sales <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L585>`_ - Line 585
- `GET /api/weekly-sales <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L637>`_ - Line 637
- `GET /api/login-logs <https://github.com/chavezMac/toast/blob/main/report/backend/server.js#L690>`_ - Line 690 (Admin only)