A sample FastAPI route that uses the include_in_schema flag to only include the route in our OpenAPI spec in our staging environment.

pinwheel.routes.py

import uuid

from fastapi import APIRouter, Request

from pinwheel import settings
from pinwheel.models import PrivateModel
from pinwheel.managers import get_private_model

router = APIRouter()


@router.get(
    "/{object_id}",
    response_model=PrivateModel,
    include_in_schema=settings.ENV == "staging"
)
def private_route(
    request: Request,
    object_id: uuid.UUID
):
    return get_private_model(object_id)