Dan Albert b7439cbd17 Add metadata to FastAPI endpoints for OpenAPI.
operation_ids give us better function names when generating the
typescript API from the openapi.json. BaseModel.Config.title does the
same for type names. Response models (or 204 status codes) need to be
explicit or the API will be declared as returning any.
2022-03-06 17:12:00 -08:00

81 lines
2.4 KiB
Python

from uuid import UUID
from dcs.mapping import LatLng, Point
from fastapi import APIRouter, Depends, HTTPException, status
from game import Game
from game.ato import Flight
from game.ato.flightwaypoint import FlightWaypoint
from game.ato.flightwaypointtype import FlightWaypointType
from game.server import GameContext
from game.server.leaflet import LeafletPoint
from game.server.waypoints.models import FlightWaypointJs
from game.sim import GameUpdateEvents
from game.utils import meters
router: APIRouter = APIRouter(prefix="/waypoints")
def waypoints_for_flight(flight: Flight) -> list[FlightWaypointJs]:
departure = FlightWaypointJs.for_waypoint(
FlightWaypoint(
"TAKEOFF",
FlightWaypointType.TAKEOFF,
flight.departure.position,
meters(0),
"RADIO",
),
flight,
0,
)
return [departure] + [
FlightWaypointJs.for_waypoint(w, flight, i)
for i, w in enumerate(flight.flight_plan.waypoints, 1)
]
@router.get(
"/{flight_id}",
operation_id="list_all_waypoints_for_flight",
response_model=list[FlightWaypointJs],
)
def all_waypoints_for_flight(
flight_id: UUID, game: Game = Depends(GameContext.require)
) -> list[FlightWaypointJs]:
return waypoints_for_flight(game.db.flights.get(flight_id))
@router.post(
"/{flight_id}/{waypoint_idx}/position",
operation_id="set_waypoint_position",
status_code=status.HTTP_204_NO_CONTENT,
)
def set_position(
flight_id: UUID,
waypoint_idx: int,
position: LeafletPoint,
game: Game = Depends(GameContext.require),
) -> None:
from game.server import EventStream
flight = game.db.flights.get(flight_id)
if waypoint_idx == 0:
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
waypoint = flight.flight_plan.waypoints[waypoint_idx - 1]
waypoint.position = Point.from_latlng(
LatLng(position.lat, position.lng), game.theater.terrain
)
package_model = (
GameContext.get_model()
.ato_model_for(flight.blue)
.find_matching_package_model(flight.package)
)
if package_model is None:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Could not find PackageModel owning {flight}",
)
package_model.update_tot()
EventStream.put_nowait(GameUpdateEvents().update_flight(flight))