Reference

Reference states what the engine is: every setting, every part of a request and a response, and every code an error carries.

All pages

• API conventions

  The rules every endpoint shares - versioning, media types, conditional requests, forwarding, and what each status code means.

• Configuration

  Every environment variable.

• Object storage requirements

  The operations, conditional requests, and consistency a node expects of the bucket.

• Storage layout

  Every object a node writes under the prefix, what a delete removes, and what the local directory holds.

• Metrics

  Every meter a node registers, what it is tagged with, and the settings that decide what is exported.

• Authentication

  Keys, permissions, roles, and the keys API.

• Admin API

  Defining, inspecting, and removing indexes; index states.

• Documents API

  Putting documents into an index, taking them out again, and the shape they are written in.

• Search API

  The request and response, every clause, matcher, and sort.

• Change paths

  The syntax that names a place to change, shared by the document and search settings endpoints.

• Field types

  The types a field can have and the ways each can be used.

• Analysis

  Presets, tokenizers, char filters, and token filters.

• Locales

  The languages with rules, and what each one gets.

• Errors

  The error body, the grammar every code follows, and the codes a client acts on.

• Glossary

  The terms the other pages use, each with the page that explains it.