Simple Read Endpoint
====================

Create a basic GET endpoint that queries the database.

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

Goal
----

Build ``GET /instruments/{id}`` endpoint that returns instrument details.

Step 1: Create Router File
---------------------------

Create ``ccat_ops_db_api/routers/my_router.py``:

.. code-block:: python

   from fastapi import APIRouter, Depends, HTTPException
   from sqlalchemy.orm import Session
   from ccat_ops_db import models
   from ..dependencies import get_db
   from ..schemas import InstrumentResponse
   
   router = APIRouter(prefix="/my-endpoint", tags=["my-endpoint"])
   
   @router.get("/{instrument_id}", response_model=InstrumentResponse)
   async def get_instrument(
       instrument_id: int,
       db: Session = Depends(get_db)
   ):
       """Get instrument by ID"""
       instrument = db.query(models.Instrument).filter(
           models.Instrument.id == instrument_id
       ).first()
       
       if not instrument:
           raise HTTPException(status_code=404, detail="Instrument not found")
       
       return instrument

Step 2: Define Schema
---------------------

In ``schemas.py``:

.. code-block:: python

   from pydantic import BaseModel
   
   class InstrumentResponse(BaseModel):
       id: int
       name: str
       description: str
       is_active: bool
       
       class Config:
           from_attributes = True

Step 3: Register Router
------------------------

In ``main.py``:

.. code-block:: python

   from .routers import my_router
   
   app.include_router(my_router.router)

Step 4: Test
------------

.. code-block:: bash

   curl http://localhost:8000/my-endpoint/1

Expected response:

.. code-block:: json

   {
     "id": 1,
     "name": "CCAT-prime",
     "description": "Prime-Cam instrument",
     "is_active": true
   }

Next: :doc:`simple-write-endpoint`