.. Toast Operations API documentation master file, created by
   sphinx-quickstart on Tue Feb  3 13:17:10 2026.

Welcome to RSBBQ's Operations API's documentation!
==================================================

Operations API is a RESTful API for analyzing real-time restaurant sales and inventory data.It pulls data from `Toast POS API <https://doc.toasttab.com/openapi/>`__ and 
stores it in a MySQL database hosted on Google Cloud Platform. Data is then used to generate reports and insights for the business and their GM's.

.. warning::
   To get started, please request access to the `github repository <https://github.com/chavezMac/toast>`__ to view the code. There are links to source code throughout the documentation,
   and without permission, the code will not be visible.


.. note::

   This documentation is a work in progress.
   It is intended to guide users through the custom API endpoints for RSBBQ.

Contents
========

.. toctree::
   :maxdepth: 2

   Home <self>
   Project Overview <project-overview>
   Getting Started <getting-started>
   Github <github>
   Toast API Examples <toast-examples>

.. toctree::
   :hidden:
   :caption: (referenced from other pages)

   api-reference