Skip to content

Fix hotel OpenAPI source links #228

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

Open
dex-the-ai wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Fix hotel OpenAPI source links #228

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions app/routers/hotel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class Hotel(BaseModel):
@router.get(
"/autocomplete",
response_model=List[HotelName],
description="Search for hotels based on their name. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to search for a specific name using the fts index.\n\n Code: [`api/hotel.py`](https://github.com/couchbase-examples/python-quickstart/blob/main/src/api/hotel.py) \n Method: `get`",
description="Search for hotels based on their name. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to search for a specific name using the fts index.\n\n Code: [`routers/hotel.py`](https://github.com/couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py) \n\n Method: `hotel_autocomplete`",
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The file path in the description text (routers/hotel.py) is inconsistent with the actual repository structure and the provided GitHub link (app/routers/hotel.py). It is recommended to use the full path app/routers/hotel.py for clarity and consistency. Additionally, the trailing double quote after the comma appears to be a typo and has been removed in the suggestion.

Suggested change
description="Search for hotels based on their name. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to search for a specific name using the fts index.\n\n Code: [`routers/hotel.py`](https://github.com/couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py) \n\n Method: `hotel_autocomplete`",
description="Search for hotels based on their name. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to search for a specific name using the fts index.\n\n Code: [`app/routers/hotel.py`](https://github.com/couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py) \n\n Method: `hotel_autocomplete`",

responses={
200: {
"description": "List of Hotel Names",
Expand Down Expand Up @@ -72,7 +72,7 @@ def hotel_autocomplete(
@router.post(
"/filter",
response_model=List[Hotel],
description="Filter hotels using various filters such as name, title, description, country, state and city. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to filter documents using the fts index.\n\n Code: [`api/hotel.py`](https://github.com/couchbase-examples/python-quickstart/blob/main/src/api/hotel.py) \n Method: `post`",
description="Filter hotels using various filters such as name, title, description, country, state and city. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to filter documents using the fts index.\n\n Code: [`routers/hotel.py`](https://github.com/couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py) \n\n Method: `hotel_filter`",
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The file path in the description text (routers/hotel.py) should be updated to app/routers/hotel.py to match the actual file location and the link provided in the description. The trailing double quote after the comma has also been removed.

Suggested change
description="Filter hotels using various filters such as name, title, description, country, state and city. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to filter documents using the fts index.\n\n Code: [`routers/hotel.py`](https://github.com/couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py) \n\n Method: `hotel_filter`",
description="Filter hotels using various filters such as name, title, description, country, state and city. \n\n This provides an example of using [Search operations](https://docs.couchbase.com/python-sdk/current/howtos/full-text-searching-with-sdk.html#search-queries) in Couchbase to filter documents using the fts index.\n\n Code: [`app/routers/hotel.py`](https://github.com/couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py) \n\n Method: `hotel_filter`",

responses={
200: {
"description": "List of Hotel",
Expand Down
Loading