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

Getting Started

• Quick Start Guide
  • What You’ll Learn
  • Prerequisites
  • Time Estimate
  • Next Steps
  • After the Quick Start
• Design Philosophy
  • Core Principles
  • The Challenge
  • Why This Architecture?
  • Who This API Serves
  • Evolution and Future
  • Navigation
  • Related Sections

Architecture

• Architecture Overview
  • Introduction
  • Key Architectural Features
  • Architecture Diagram
  • Component Responsibilities
  • Request Flow Examples
  • Section Contents
  • Related Sections
  • Key Takeaways
• Deep Dive
  • Overview
  • Deep Dive Sections
  • Prerequisites
  • Code References
  • Conventions
  • Testing Deep Dive Concepts
  • Debugging Tips
  • Next Steps

Tutorials

• Tutorials
  • Overview
  • Tutorial Path
  • Prerequisites
  • Next Steps

Reference

• API Reference
  • Overview
  • Interactive Documentation
  • Alternative Documentation
  • Next Steps
• Development Guide
  • Testing
  • Debugging Transaction Buffering
  • Redis Inspection
  • Contributing
  • Overview
  • Development Environment
  • Quick Start
  • Development Tokens
  • Next Steps

Quick Links

• Installation - Get up and running in minutes

• Design Rationale - Understand the architectural decisions

• Transaction Buffering Overview - Learn about the buffering system

• Simple Read Endpoint - Build your first endpoint

• Debugging Transaction Buffering - Troubleshoot buffering issues

External Resources

• FastAPI Documentation

• ops-db Repository - Database schema and models

• ops-db-ui Repository - Frontend interface

• Interface Definition Documents - Observatory scheduler interface

Indices and tables

• Index

• Search Page

Interface Definitions

• Interface Definitions

API Reference

ccat_ops_db_api