Prepare to document or remove "pipeline search" endpoints

nmdc_runtime/api/endpoints/find.py

@@ -460,18 +460,20 @@ def search_page(
     return HTMLResponse(content=html_content, status_code=200)
 
 
+# TODO: Confirm with endpoint's author whether they meant for it to receive data via query params, not the request body.
 @router.post(
     "/pipeline_search",
     response_model=PipelineFindResponse,
     response_model_exclude_unset=True,
 )
 def pipeline_search(
-    req: PipelineFindRequest = Depends(),
+    req: Annotated[PipelineFindRequest, Query()],
     mdb: MongoDatabase = Depends(get_mongo_db),
 ):
     return pipeline_find_resources(req, mdb)
 
 
+# TODO: Exclude this endpoint from Swagger UI by including the `include_in_schema=False` kwarg in the router decorator.
 @router.post(
     "/pipeline_search_form",
     response_model=PipelineFindResponse,
@@ -486,6 +488,7 @@ def pipeline_search(
     return pipeline_find_resources(req, mdb)
 
 
+# TODO: Exclude this endpoint from Swagger UI by including the `include_in_schema=False` kwarg in the router decorator.
 @router.get("/pipeline_search", response_class=HTMLResponse)
 def pipeline_search(
     mdb: MongoDatabase = Depends(get_mongo_db),

nmdc_runtime/api/models/util.py

@@ -154,8 +154,17 @@ class PipelineFindRequest(BaseModel):
     TODO: Document this class and its attributes.
     """
 
-    pipeline_spec: str
-    description: str
+    # TODO: Add real descriptions and examples to these parameter definitions.
+    pipeline_spec: str = Field(
+        title="Pipeline specification",
+        description="",
+        examples=[],
+    )
+    description: str = Field(
+        title="Pipeline description",
+        description="",
+        examples=[],
+    )
 
 
 class FindResponse(BaseModel):

nmdc_runtime/templates/pipeline_search.html

@@ -26,7 +26,15 @@
 <h1>NMDC Runtime Pipeline-Search Form</h1>
 <p><a href="#examples">Examples below</a></p>
 
-
+<!--
+    TODO: Clean this up.
+          1. Remove stray comma from `textarea` HTML element.
+          2. Display names of input fields on UI.
+          3. Explain the example(s)—what is `| part_of->id`?
+          4. The topmost example doesn't work (HTTP 500 Internal Server Error).
+          5. If this page is obsolete (or its author never meant for it to be in production),
+             deprecate it and then delete it to save maintenance cost.
+-->
 <form action="pipeline_search_form" method="post">
     <textarea name="pipeline_spec" rows="5", cols="40">
     </textarea>