From 26113e971662570b88ac56dbfa7ba8e0242335f8 Mon Sep 17 00:00:00 2001
From: eecavanna <eecavanna@users.noreply.github.com>
Date: Sat, 30 Nov 2024 17:41:54 -0800
Subject: [PATCH] Add description about `study_id` path parameter

---
 nmdc_runtime/api/endpoints/find.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/nmdc_runtime/api/endpoints/find.py b/nmdc_runtime/api/endpoints/find.py
index 75f1bc9a..4c53bd45 100644
--- a/nmdc_runtime/api/endpoints/find.py
+++ b/nmdc_runtime/api/endpoints/find.py
@@ -58,7 +58,11 @@ def find_studies(
     response_model_exclude_unset=True,
 )
 def find_study_by_id(
-    study_id: str,
+    study_id: Annotated[str, Path(
+        title="Study ID",
+        description="The `id` of the `Study` you want to find.\n\n_Example_: `nmdc:sty-11-abc123`",
+        examples=["nmdc:sty-11-abc123"]
+    )],
     mdb: MongoDatabase = Depends(get_mongo_db),
 ):
     """