Tutorials

Step-by-step guides for common development tasks with ops-db-api.

Overview

These tutorials cover:

• Simple Endpoints: Basic read/write endpoints with authentication

• Complex Endpoints: Multi-table transactions, buffering, smart queries

• Observatory Integration: Service scripts for telescope operations

• UI Integration: Frontend integration patterns

• Simple Endpoints
  • Simple Read Endpoint
  • Simple Write Endpoint
  • Adding Authentication
• Complex Endpoints
  • Multi-Table Transactions
  • Buffered Critical Operations
  • Smart Queries with Buffering
  • WebSocket Updates
• Observatory Integration
  • Recording Observations
  • Registering Data Files
  • Service Scripts Best Practices
  • Scheduler Interface
• UI Integration
  • Dashboard Endpoints
  • Visibility Calculations
  • Transfer Monitoring

Tutorial Path

New to the API? Start with:

1. Simple Read Endpoint

2. Simple Write Endpoint

3. Adding Authentication

Ready for advanced topics? Continue with:

4. Multi-Table Transactions

5. Buffered Critical Operations

6. Smart Queries with Buffering

Building observatory automation? See:

7. Recording Observations

8. Registering Data Files

9. Service Scripts Best Practices

Building UI features? See:

10. Dashboard Endpoints

11. Visibility Calculations

12. Transfer Monitoring

Prerequisites

Before starting tutorials:

• Completed Installation

• Familiar with FastAPI basics

• Understanding of Architecture Overview

• Local development environment set up

Next Steps

Choose a tutorial category:

• Simple Endpoints - Basic endpoint development

• Complex Endpoints - Advanced patterns

• Observatory Integration - Automation scripts

• UI Integration - Frontend integration