API Reference

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

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

• Endpoints Reference
  • UI-Focused Endpoints
  • Operations Endpoints
  • Shared Endpoints
• Schemas Reference
  • Key Schema Categories
• Database Models
  • Key Models

Interactive Documentation

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

# 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:

http://localhost:8000/redoc

Next Steps

• Endpoints Reference - Complete endpoint listing

• Schemas Reference - Pydantic schemas

• Database Models - Database models

• Tutorials - Usage tutorials