HTTP API routes and admin web UI handlers for wagoe-search.
API Endpoints (mounted under /api/v1): POST /search/:index-id — search POST /search/:index-id/suggest — trigram suggestions POST /search/documents — index a document DELETE /search/documents/:type/:id — remove a document
Admin Web UI (mounted under /web/admin): GET /search — list all indices GET /search/:index-id — index detail + live search form POST /search/:index-id/search — HTMX search results fragment
Searching takes a signed-in user; indexing, removing and the admin pages take the admin role (BOU-568).
An index whose definition lists :tenant-id among its :filters is
tenant-scoped. A search of one reads the request's resolved tenant, and only
when the caller is an active member of it; a tenant_id the caller sends is
dropped. With no tenant resolved, only a global admin may search it, with
whatever filters they send. Anyone else gets 403.
HTTP API routes and admin web UI handlers for wagoe-search. API Endpoints (mounted under /api/v1): POST /search/:index-id — search POST /search/:index-id/suggest — trigram suggestions POST /search/documents — index a document DELETE /search/documents/:type/:id — remove a document Admin Web UI (mounted under /web/admin): GET /search — list all indices GET /search/:index-id — index detail + live search form POST /search/:index-id/search — HTMX search results fragment Searching takes a signed-in user; indexing, removing and the admin pages take the admin role (BOU-568). An index whose definition lists `:tenant-id` among its `:filters` is tenant-scoped. A search of one reads the request's resolved tenant, and only when the caller is an active member of it; a `tenant_id` the caller sends is dropped. With no tenant resolved, only a global admin may search it, with whatever filters they send. Anyone else gets 403.
(handle-get-index-web engine request)GET /web/admin/search/:index-id
GET /web/admin/search/:index-id
(handle-index-document engine request)POST /api/v1/search/documents
POST /api/v1/search/documents
(handle-list-indices-web engine request)GET /web/admin/search
GET /web/admin/search
(handle-remove-document engine request)DELETE /api/v1/search/documents/:entity-type/:entity-id
DELETE /api/v1/search/documents/:entity-type/:entity-id
(handle-search engine request)POST /api/v1/search/:index-id
POST /api/v1/search/:index-id
(handle-search-fragment engine request)POST /web/admin/search/:index-id/search — HTMX fragment
POST /web/admin/search/:index-id/search — HTMX fragment
(handle-suggest engine request)POST /api/v1/search/:index-id/suggest
POST /api/v1/search/:index-id/suggest
(search-routes engine)Reitit route data for the search API. Mounted under /api/v1.
Args: engine - SearchService (ISearchEngine)
Reitit route data for the search API. Mounted under /api/v1. Args: engine - SearchService (ISearchEngine)
(search-web-routes engine)Reitit route data for the search Admin web UI.
Mounted under /web/admin by the HTTP handler — see this module's
:web-prefix.
Args: engine - SearchService (ISearchEngine)
Reitit route data for the search Admin web UI. Mounted under /web/admin by the HTTP handler — see this module's `:web-prefix`. Args: engine - SearchService (ISearchEngine)
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |