Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-44204: minor handler doc improvements #4

Merged
merged 2 commits into from
May 3, 2024
Merged

DM-44204: minor handler doc improvements #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52f06a3
Improve API docs
athornton May 3, 2024
ef965da
Add changelog fragment for handler doc improvements
athornton May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions changelog.d/20240503_102318_athornton_DM_44204.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Delete the sections that don't apply -->

### Other changes

Minor improvements to handler docs.
2 changes: 1 addition & 1 deletion src/fastapibootcamp/handlers/astroplan/endpoints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
8 changes: 4 additions & 4 deletions src/fastapibootcamp/handlers/external.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down