From c042650382bf3bc7b4618776d7da9bf017ed012d Mon Sep 17 00:00:00 2001 From: Viktor Lofgren Date: Sat, 13 Jan 2024 21:16:45 +0100 Subject: [PATCH] (docs) Improve query service documentation --- code/services-core/query-service/readme.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/code/services-core/query-service/readme.md b/code/services-core/query-service/readme.md index a609f4f7..3ef867da 100644 --- a/code/services-core/query-service/readme.md +++ b/code/services-core/query-service/readme.md @@ -2,11 +2,20 @@ The query service parses search queries and delegates work to the index service. The [index-service](../index-service) speaks a lower level query specification language that is difficult to build an application out of. The query service exists as an interpreter -to that format. +to that format. + +## Web Interface + +The query service also offers a basic web interface for testing queries, or +running the search engine as a white-label service without all the Marginalia Search +specific stuff. This mode of operations is available through a `barebones` install. + +The web interface also offers a JSON API for machine-based queries. ## Main Classes -* [QueryService](src/main/java/nu/marginalia/query/QueryService.java) +* [QueryService](src/main/java/nu/marginalia/query/QueryService.java) - The REST service implementation +* [QueryGRPCService](src/main/java/nu/marginalia/query/QueryGRPCService.java) - The GRPC service implementation ## See Also