diff options
| -rw-r--r-- | guide/src/SUMMARY.md | 2 | ||||
| -rw-r--r-- | guide/src/reference_graph.md | 2 | ||||
| -rw-r--r-- | guide/src/search_api.md | 25 |
3 files changed, 16 insertions, 13 deletions
diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index c7d12cb0..fda17bb0 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -22,7 +22,7 @@ - [Release](./entity_release.md) - [Work](./entity_work.md) - [Public API](./http_api.md) - - [Search API](./search_api.md) + - [Search Index](./search_api.md) - [Bulk Exports](./bulk_exports.md) - [Cookbook](./cookbook.md) - [Contributing](./contributing.md) diff --git a/guide/src/reference_graph.md b/guide/src/reference_graph.md index a38a017b..26eec899 100644 --- a/guide/src/reference_graph.md +++ b/guide/src/reference_graph.md @@ -4,7 +4,7 @@ Since 08/2021 references are available on an "inbound" and "outbound" basis in the web interface. -The backend reference graph is available via the [Search API](./search_api.md) +The backend reference graph is available via the [Search Index](./search_api.md) under the `fatcat_ref` index. ## Background and Mode of Operation diff --git a/guide/src/search_api.md b/guide/src/search_api.md index 91b7c8e9..801a0280 100644 --- a/guide/src/search_api.md +++ b/guide/src/search_api.md @@ -1,27 +1,30 @@ -# Search API +# Search Index The Elasticsearch indices used to power metadata search, statistics, and graphs on the fatcat web interface are exposed publicly at -`https://search.fatcat.wiki`. Third parties can make queries using the -Elasticsearch API, which is well documented online and has client libraries in -many programming languages. +<https://search.fatcat.wiki/>. Third parties can make queries using the +Elasticsearch API, which is [well documented online](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-search.html) +and has client libraries in many programming languages. -A thin proxy (`es-public-proxy`) filters requests to avoid expensive queries -which could cause problems for search queries on the web interface, but most of -the Elasticsearch API is supported, including powerful aggregation queries. +A thin proxy ([`es-public-proxy`](https://gitlab.com/bnewbold/es-public-proxy)) +filters requests to avoid expensive queries which could cause problems for +search queries on the web interface, but most of the Elasticsearch API is +supported, including powerful aggregation queries. CORS headers are supported, +meaning that queries can be made directly from web browsers. There is a short delay between updates to the fatcat catalog (via the main API) and updates to the search index. Notable indices include: -- `fatcat_release`: release entity metadata -- `fatcat_container`: container entity metadata -- `fatcat_ref`: reference graph +- `fatcat_release`: release entity metadata ([schema](https://search.fatcat.wiki/fatcat_release/_mapping)) +- `fatcat_container`: container entity metadata ([schema](https://search.fatcat.wiki/fatcat_container/_mapping)) +- `fatcat_ref`: reference graph ([schema](https://search.fatcat.wiki/fatcat_ref/_mapping)) +- `scholar_fulltext`: [scholar.archive.org](https://scholar.archive.org) full-text index (body text can be queried, but not downloaded or extracted from index) ([schema](https://search.fatcat.wiki/scholar_fulltext/_mapping)) Schemas for these indices can be fetched directly from the index (eg, -`https://search.fatcat.wiki/fatcat_release/_mapping`), and are versioned in the +<https://search.fatcat.wiki/fatcat_release/_mapping>), and are versioned in the fatcat git repository under `fatcat:extra/eleasticsearch/`. They are a simplification and transform of the regular entity schemas, and include some synthesized fields (such as "preservation status" for releases). Note that the |