From 03b18fdc1ae9c37a79c0ea79c493b1206b442431 Mon Sep 17 00:00:00 2001
From: Nicolas Mowen <nickmowen213@gmail.com>
Date: Tue, 15 Jul 2025 15:37:41 -0600
Subject: [PATCH] Add description to snapshot api

---
 frigate/api/media.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/frigate/api/media.py b/frigate/api/media.py
index 9cb00ae0b..b4db46d38 100644
--- a/frigate/api/media.py
+++ b/frigate/api/media.py
@@ -800,7 +800,10 @@ def vod_event(event_id: str):
     )
 
 
-@router.get("/events/{event_id}/snapshot.jpg")
+@router.get(
+    "/events/{event_id}/snapshot.jpg",
+    description="Returns a snapshot image for the specified object id. NOTE: The query params only take affect while the event is in-progress. Once the event has ended the snapshot configuration is used.",
+)
 def event_snapshot(
     request: Request,
     event_id: str,