Add description about study_id path parameter

microbiomedata · Dec 1, 2024 · 26113e9 · 26113e9
1 parent 36981f5
commit 26113e9
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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),
 ):
     """