Goophr Librarian is the actual maintainer of the index for a set of documents, and its responsibilities are to add terms to the index and to return query results for the search terms based on the terms available in the index.
Informally, we can define the API as follows:
- /api/index: Goophr Concierge calls this API endpoint to add terms to the actual index
- The POST request adds terms to index
- /api/query: Goophr Concierge calls this endpoint to query search terms submitted by the user
- The POST request returns results for search terms
The following is the OpenAPI definition for Goophr Librarian:
# openapi/librarian.yamlopenapi: 3.0.0 servers: - url: /api info: title: Goophr Librarian API version: '1.0' ...