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

Complete reference documentation for all endpoints, schemas, and models.

.. contents:: Table of Contents
   :local:
   :depth: 2

Overview
--------

The API reference provides comprehensive documentation of:

* **Endpoints**: All HTTP endpoints with request/response formats
* **Schemas**: Pydantic models for validation
* **Models**: Database models from ops-db package

.. toctree::
   :maxdepth: 2

   endpoints
   schemas
   models

Interactive Documentation
--------------------------

The API provides interactive documentation at ``/docs`` (Swagger UI):

.. code-block:: bash

   # Start API
   uvicorn ccat_ops_db_api.main:app --reload
   
   # Visit in browser
   http://localhost:8000/docs

Features:

* Try endpoints directly
* See request/response schemas
* Authenticate with tokens
* Auto-generated from code

Alternative Documentation
-------------------------

ReDoc alternative view at ``/redoc``:

.. code-block:: bash

   http://localhost:8000/redoc

Next Steps
----------

* :doc:`endpoints` - Complete endpoint listing
* :doc:`schemas` - Pydantic schemas
* :doc:`models` - Database models
* :doc:`../tutorials/index` - Usage tutorials