# Operations Database API (ops-db-api)

The CCAT Operations Database API provides a RESTful API interface to the operations
database. It handles authentication, authorization, and provides endpoints for managing
observations, instruments, users, and scheduling.

## Features

- RESTful API with FastAPI
- JWT-based authentication
- GitHub OAuth integration
- API token authentication
- Role-based access control
- Buffering system for critical operations

## Documentation Structure

```{toctree}
:caption: Getting Started
:maxdepth: 2

quickstart/index
philosophy/index
```

```{toctree}
:caption: Architecture
:maxdepth: 2

architecture/index
deep-dive/index
```

```{toctree}
:caption: Tutorials
:maxdepth: 2

tutorials/index
```

```{toctree}
:caption: Reference
:maxdepth: 2

api-reference/index
development/index
```

## Quick Links

- {doc}`quickstart/installation` - Get up and running in minutes
- {doc}`philosophy/design-rationale` - Understand the architectural decisions
- {doc}`deep-dive/transaction-buffering/overview` - Learn about the buffering system
- {doc}`tutorials/simple-endpoints/simple-read-endpoint` - Build your first endpoint
- {doc}`development/debugging-buffering` - Troubleshoot buffering issues

## External Resources

- [FastAPI Documentation](https://fastapi.tiangolo.com)
- [ops-db Repository](https://github.com/ccatobs/ops-db) - Database schema and models
- [ops-db-ui Repository](https://github.com/ccatobs/ops-db-ui) - Frontend interface
- {doc}`Interface Definition Documents <interface_definition_docs/Interface_definition_draft_opsdb_instrument_scheduler>` - Observatory scheduler interface

# Indices and tables

- {ref}`genindex`
- {ref}`search`

```{toctree}
:caption: Interface Definitions
:maxdepth: 2

source/interface_definition
```

## API Reference

```{eval-rst}
.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst
   :recursive:

   ccat_ops_db_api
```