Skip to content

Document self-managed Search requirement and refresh checkout action#146

Open
dex-the-ai wants to merge 2 commits into
mainfrom
deps/update-2026-05-26
Open

Document self-managed Search requirement and refresh checkout action#146
dex-the-ai wants to merge 2 commits into
mainfrom
deps/update-2026-05-26

Conversation

@dex-the-ai
Copy link
Copy Markdown
Contributor

@dex-the-ai dex-the-ai commented May 26, 2026

Summary

  • refresh the GitHub Actions checkout step from actions/checkout@v3 to actions/checkout@v4
  • document the Search-service requirement for self-managed hotel autocomplete/filter flows and the full pytest walkthrough

Verification

  • cd src && uv venv --python 3.12 --seed --clear .venv && source .venv/bin/activate && uv pip install -r requirements.txt
  • cd src && source .venv/bin/activate && python -m pip list --outdated --format=json[]
  • cd src && source .venv/bin/activate && uvx pip-audit -r requirements.txtNo known vulnerabilities found
  • cd src && source .venv/bin/activate && python -m pytest -q (Capella-backed .env) → 47 passed in 21.99s
  • curl -sS http://127.0.0.1:8080/
  • curl -sS 'http://127.0.0.1:8080/api/v1/airport/list?country=France&limit=2'
  • curl -sS 'http://127.0.0.1:8080/api/v1/hotel/autocomplete?name=sea'
  • curl -sS -X POST 'http://127.0.0.1:8080/api/v1/hotel/filter?limit=2&offset=0' -H 'Content-Type: application/json' -d '{"description":"newly renovated"}'

Evidence

  • requirements.txt was already current: no direct package updates were available and pip-audit reported no known vulnerabilities.
  • Verified the happy path against a Capella-backed .env: pytest passed end to end and the airport + hotel walkthrough requests returned expected travel-sample data.
  • Confirmed the Swagger UI is up at / and captured a screenshot locally at tutorial-maintenance/runs/python-quickstart/2026-05-26/screenshots/swagger-ui.png.
  • Confirmed the README drift this patch fixes: a self-managed local run without Search available still starts, but hotel FTS endpoints return empty results and tests/test_hotel.py fails (6 failed, 41 passed).
  • tutorial-maintenance/runs/python-quickstart/2026-05-26/verification.md
  • tutorial-maintenance/runs/python-quickstart/2026-05-26/walkthrough.txt
  • tutorial-maintenance/runs/python-quickstart/2026-05-26/pytest-capella.txt
Pytest result
47 passed in 21.99s
Hotel walkthrough excerpt
[
  {
    "name": "Seal View"
  },
  {
    "name": "Seal Cove Inn"
  },
  {
    "name": "Seal Rock Inn"
  }
]

Notes

  • No repo code or Python dependency changes were needed in this sweep; the repo was already current from a package/vulnerability standpoint.
  • The README update is based on the self-managed baseline symptom observed locally: the hotel endpoints require Search so the hotel_search index can be created in travel-sample.inventory.

Media evidence

  • Captured the live Swagger UI after the walkthrough and pytest verification completed.
  • Shows the root-page API surface the README and walkthrough now describe for reviewers.

Swagger UI for the Python quickstart

Notes
  • Local artifact path: tutorial-maintenance/runs/python-quickstart/2026-05-26/screenshots/swagger-ui.png
- Short walkthrough video of the root-page Swagger UI after the verified walkthrough and pytest pass. [Short walkthrough video of the Flask Swagger UI](https://res.cloudinary.com/dhwqj0ps2/video/upload/v1779836912/pr-evidence/couchbase-examples/python-quickstart/pr-146/swagger-ui-walkthrough.webm)
Notes
  • Local artifact path: tutorial-maintenance/runs/python-quickstart/2026-05-26/swagger-ui.webm

@dex-the-ai dex-the-ai requested a review from nithishr May 26, 2026 19:48
@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.

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 README.md to add a note about the Full Text Search requirement for the hotel autocomplete and filter endpoints. The review feedback correctly points out that the hotel_search index is a bucket-level index rather than a scope-level index, and provides a suggestion to clarify this for users setting up a self-managed cluster.

Comment thread README.md Outdated
@dex-the-ai
Copy link
Copy Markdown
Contributor Author

Dex update: I pushed follow-up changes.

  • Media evidence

  • Captured the live Swagger surface from the verified Capella-backed walkthrough.
  • This shows the app booted successfully and exposed the documented interactive API docs at /.

@dex-the-ai
Copy link
Copy Markdown
Contributor Author

I pushed two follow-ups on this branch: (1) clarified the README note so hotel_search is described as a bucket-level index on travel-sample that indexes inventory.hotel, matching src/hotel_search_index.json; and (2) updated the Slack notifier workflow to ravsamhq/notify-slack-action@v2 with the report step non-blocking, since the previous red test status was coming from the notifier container rather than the Flask test run.

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