Skip to content

Fix hotel OpenAPI source links#228

Merged
nithishr merged 2 commits intomainfrom
deps/update-2026-04-29
May 5, 2026
Merged

Fix hotel OpenAPI source links#228
nithishr merged 2 commits intomainfrom
deps/update-2026-04-29

Conversation

@dex-the-ai
Copy link
Copy Markdown
Contributor

Summary

  • re-ran the maintenance workflow from current origin/main on a fresh deps/update-2026-04-29 branch
  • confirmed the pinned requirements are already current (pip list --outdated --format=json returned []) and the app/test flow is healthy on main
  • fixed the hotel OpenAPI descriptions so they point to the correct FastAPI repo/path and actual handler names

Verification

  • uv venv --seed --python /usr/bin/python3.14 .venv
  • python -m pip install -r requirements.txt
  • python -m pip list --outdated --format=json[]
  • python -m pytest47 passed
  • uvicorn app.main:app --host 127.0.0.1 --port 8000
  • curl -i http://127.0.0.1:8000/307 redirect to /docs
  • curl -s "http://127.0.0.1:8000/api/v1/airport/list?country=France&limit=2"
  • curl -s "http://127.0.0.1:8000/api/v1/hotel/autocomplete?name=Seal"
  • curl -s -X POST "http://127.0.0.1:8000/api/v1/hotel/filter?limit=2" -H "Content-Type: application/json" -d {country:United States}
  • live airport CRUD walkthrough against a temporary document (create/read/update/delete) succeeded
  • post-fix python -m pytest re-run → 47 passed

Evidence

  • Current main was already healthy: tests passed and no pinned dependency updates were available.
  • The fixable drift I found was in the generated OpenAPI docs for the hotel endpoints:
    • /api/v1/hotel/autocomplete
    • /api/v1/hotel/filter
  • Before this change, both descriptions linked to couchbase-examples/python-quickstart/blob/main/src/api/hotel.py, which is the wrong repo/path for this project.
  • After this change, /openapi.json points both hotel endpoints at couchbase-examples/python-quickstart-fastapi/blob/main/app/routers/hotel.py and shows the actual handler names hotel_autocomplete / hotel_filter.
pytest output
============================= test session starts ==============================
platform linux -- Python 3.14.4, pytest-9.0.3, pluggy-1.6.0
rootdir: /home/elliot/.openclaw/state/tutorial-maintenance/repos/python-quickstart-fastapi
plugins: anyio-4.13.0
collected 47 items

app/tests/test_airline.py ...............                                [ 31%]
app/tests/test_airport.py ...............                                [ 63%]
app/tests/test_hotel.py ........                                         [ 80%]
app/tests/test_route.py .........                                        [100%]

============================= 47 passed in 18.76s ==============================
API walkthrough excerpt
HTTP/1.1 307 Temporary Redirect
location: /docs

GET /api/v1/airport/list?country=France&limit=2
[{"airportname":"Abbeville",...},{"airportname":"Aire Sur L Adour",...}]

GET /api/v1/hotel/autocomplete?name=Seal
[{"name":"Seal View"},{"name":"Seal Rock Inn"},...]

POST /api/v1/hotel/filter?limit=2
[{"city":"Los Angeles","country":"United States","name":"The Carlyle Inn",...},{"city":"Los Angeles","country":"United States","name":"El Tres Inn",...}]

POST /api/v1/airport/airport_walkthrough_20260429_fix2
201 {"airportname":"Walkthrough Airport",...}
DELETE /api/v1/airport/airport_walkthrough_20260429_fix2
204
  • tutorial-maintenance/runs/python-quickstart-fastapi/2026-04-29T20-23-30Z/verification.md
  • tutorial-maintenance/runs/python-quickstart-fastapi/2026-04-29T20-23-30Z/walkthrough.log
  • tutorial-maintenance/runs/python-quickstart-fastapi/2026-04-29T20-23-30Z/walkthrough-after-fix.log

Notes

  • I started from current origin/main; existing PR Update deps and retest quickstart flow #227 was left untouched.
  • I also noted external tutorial-page drift (older working-directory/port details than the current repo), but that content lives outside this repository so this PR only fixes the repo-side OpenAPI link drift.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the API documentation descriptions for the hotel autocomplete and filter endpoints to reflect the correct file paths, repository links, and method names. The feedback suggests using the full file path app/routers/hotel.py instead of routers/hotel.py to maintain consistency with the actual project structure and the provided GitHub links.

Comment thread app/routers/hotel.py Outdated
Comment thread app/routers/hotel.py Outdated
@dex-the-ai dex-the-ai force-pushed the deps/update-2026-04-29 branch from fd12f30 to 820f86c Compare April 30, 2026 19:17
@dex-the-ai dex-the-ai requested review from ejscribner and nithishr May 1, 2026 19:14
@dex-the-ai
Copy link
Copy Markdown
Contributor Author

Owner ping for this maintenance PR: @nithishr

Requesting review from the manifest-listed owner(s) where GitHub does not already show a pending review request.

@nithishr nithishr merged commit 583dbde into main May 5, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants