Merge pull request #4 from lsst-sqre/tickets/DM-44204

changelog.d/20240503_102318_athornton_DM_44204.md

@@ -0,0 +1,5 @@
+<!-- Delete the sections that don't apply -->
+
+### Other changes
+
+Minor improvements to handler docs.

src/fastapibootcamp/handlers/astroplan/endpoints.py

@@ -87,7 +87,7 @@ async def get_observer(
 
 @astroplan_router.get(
     "/observers",
-    summary="Get all observering sites.",
+    summary="Get all observing sites.",
     response_model=list[ObserverModel],
 )
 async def get_observers(

src/fastapibootcamp/handlers/external.py

@@ -132,7 +132,7 @@ class GreetingResponseModel(BaseModel):
 
 @external_router.get(
     "/en-greeting",
-    summary="Get a greeting in engish.",
+    summary="Get a greeting in English.",
     response_model=GreetingResponseModel,
 )
 async def get_english_greeting(
@@ -156,7 +156,7 @@ async def get_english_greeting(
 
 @external_router.get(
     "/greeting",
-    summary="Get a greeting in several languages.",
+    summary="Get a greeting in several languages by using a query parameter.",
     response_model=GreetingResponseModel,
 )
 async def get_multilingual_greeting(
@@ -200,7 +200,7 @@ async def get_multilingual_greeting(
 
 @external_router.get(
     "/greeting/{language}",
-    summary="Get a greeting in several languages.",
+    summary="Get a greeting in several languages by using a path parameter.",
     response_model=GreetingResponseModel,
 )
 async def get_multilingual_greeting_path(
@@ -252,7 +252,7 @@ class GreetingRequestModel(BaseModel):
 
 @external_router.post(
     "/greeting",
-    summary="Get a greeting in several languages.",
+    summary="Get a greeting in several languages using an HTTP POST.",
     response_model=GreetingResponseModel,
 )
 async def post_greeting(