Skip to content

Add documentation route for /search endpoints#694

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/add-documentation-route-search
Draft

Add documentation route for /search endpoints#694
Copilot wants to merge 3 commits intomainfrom
copilot/add-documentation-route-search

Conversation

Copy link
Contributor

Copilot AI commented Feb 5, 2026

The /places/search/<lat>/<lon> and /places/search/communities endpoints lacked user-facing documentation. Added a /search/ route that documents both endpoints with parameters, outputs, and examples.

Changes

  • /templates/documentation/search.html - Documentation page covering:

    • Geographic search by coordinates: lat, lon, tags parameters; 15 area types in output (communities, HUCs, protected areas, boroughs, census areas, etc.)
    • Community search by name: extent, substring parameters; fuzzy matching via Jaro-Winkler algorithm
    • JSON output examples and use cases
  • /routes/vectordata.py - Added /search/ route following existing documentation pattern

  • /tests/test_search_documentation.py - Verifies documentation page loads correctly

Screenshot

Search Documentation

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • zeus.snap.uaf.edu
    • Triggering command: /usr/bin/python3 python3 -m pytest tests/test_search_documentation.py -v (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Create a PR that adds a new documentation route to the user interface of the API that fully describes all parameters and outputs in the /search endpoint. Model the documentation on existing templates, such as the /fire_weather endpoint.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 5, 2026 01:36
Co-authored-by: brucecrevensten <525049+brucecrevensten@users.noreply.github.com>
Co-authored-by: brucecrevensten <525049+brucecrevensten@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for /search endpoint parameters and outputs Add documentation route for /search endpoints Feb 5, 2026
Copilot AI requested a review from brucecrevensten February 5, 2026 01:41
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