refactor: makefile revision

Author: ivanskv2000

Makefile

@@ -4,8 +4,11 @@ up:
 down:
 	docker compose down
 
-migrate:
+migrate: # e. g. make revision name="add auth"
 	docker compose exec backend alembic upgrade head
 
+revision:
+	docker compose exec backend alembic revision -m "$(name)"
+
 dev:
 	docker compose -f docker-compose.dev.yaml up --build -d

backend/app/api/v1/routes/events.py

@@ -1,9 +1,19 @@
-from fastapi import APIRouter, Depends, HTTPException, status
+import yaml
+from fastapi import (
+    APIRouter,
+    Depends,
+    HTTPException,
+    Query,
+    Response,
+    status,
+)
+from fastapi.responses import JSONResponse
 from sqlalchemy.orm import Session
 
 from app.core.database import get_db
 from app.modules.events import crud as event_crud
 from app.modules.events.schemas import EventCreate, EventOut
+from app.modules.events.service import generate_json_schema_for_event
 from app.modules.fields.crud import get_fields_by_ids
 from app.modules.tags.crud import get_or_create_tags
 
@@ -111,3 +121,48 @@ def delete_event_route(event_id: int, db: Session = Depends(get_db)):
     if db_event is None:
         raise HTTPException(status_code=404, detail="Event not found")
     return db_event
+
+
+@router.get("/events/{event_id}/schema.json", response_class=JSONResponse)
+def get_event_json_schema(
+    event_id: int,
+    include_descriptions: bool = Query(True),
+    include_examples: bool = Query(True),
+    additional_properties: bool = Query(True),
+    db: Session = Depends(get_db),
+):
+    db_event = event_crud.get_event(db=db, event_id=event_id)
+    if not db_event:
+        raise HTTPException(status_code=404, detail="Event not found")
+
+    event = EventOut.model_validate(db_event)
+    schema = generate_json_schema_for_event(
+        event,
+        include_descriptions=include_descriptions,
+        include_examples=include_examples,
+        additional_properties=additional_properties,
+    )
+    return schema
+
+
+@router.get("/events/{event_id}/schema.yaml")
+def get_event_yaml_schema(
+    event_id: int,
+    include_descriptions: bool = Query(True),
+    include_examples: bool = Query(True),
+    additional_properties: bool = Query(True),
+    db: Session = Depends(get_db),
+):
+    db_event = event_crud.get_event(db=db, event_id=event_id)
+    if not db_event:
+        raise HTTPException(status_code=404, detail="Event not found")
+
+    event = EventOut.model_validate(db_event)
+    schema = generate_json_schema_for_event(
+        event,
+        include_descriptions=include_descriptions,
+        include_examples=include_examples,
+        additional_properties=additional_properties,
+    )
+    yaml_data = yaml.dump(schema, sort_keys=False)
+    return Response(content=yaml_data, media_type="application/x-yaml")

backend/app/modules/events/service.py

@@ -0,0 +1,51 @@
+from app.modules.events.schemas import EventOut
+
+
+def map_field_type_to_openapi(field_type: str) -> dict:
+    return {
+        "string": {"type": "string"},
+        "integer": {"type": "integer", "format": "int32"},
+        "number": {"type": "number", "format": "float"},
+        "boolean": {"type": "boolean"},
+        "object": {"type": "object"},
+        "array": {"type": "array"},
+    }.get(field_type, {"type": "string"})
+
+
+def generate_json_schema_for_event(
+    event: EventOut,
+    *,
+    additional_properties: bool = True,
+    include_descriptions: bool = True,
+    include_examples: bool = True,
+) -> dict:
+    schema = {
+        "type": "object",
+        "additionalProperties": additional_properties,
+        "properties": {},
+        "required": [],
+    }
+
+    for field in event.fields:
+        field_type_info = map_field_type_to_openapi(field.field_type)
+
+        field_schema = {"type": field_type_info["type"]}
+        if "format" in field_type_info:
+            field_schema["format"] = field_type_info["format"]
+
+        if include_descriptions and field.description:
+            field_schema["description"] = field.description
+
+        if include_examples and field.example is not None:
+            field_schema["example"] = field.example
+
+        schema["properties"][field.name] = field_schema
+
+        # if not field.optional:
+        if True:
+            schema["required"].append(field.name)
+
+    if not schema["required"]:
+        del schema["required"]
+
+    return schema