Skip to content

Coverage

Edit page

The documentation site is the end-to-end suite: every request block on a page runs against a fresh node, in sidebar order, and the pm.test assertions under it check its answer (docs_to_postman.py builds the collection, the e2e and tls layers of harness/run_all.sh run it over HTTP and HTTPS). This page maps each feature the node serves to the page that documents it and the tests that check it, and lists what no request covers, with the reason.

“Docs E2E” means the page’s own requests and assertions. Unit tests are under tests/, the harness checks under harness/.

FeaturePageTests
PUT, POST of a document, minted IDs, IDs 0 and "0"IndexDocs E2E; tests/test_node.cc (test_document_ids_are_themselves); harness/strata_write_check.sh, harness/id_terms_check.py
GET of a document, selector, commentsGetDocs E2E
HEAD of a documentExistsDocs E2E (an existing document)
UPDATE, PATCH, UPSERTUpdateDocs E2E; tests/test_node.cc
INFO of a documentInfoDocs E2E
DELETE of a documentDeleteDocs E2E; tests/test_node.cc (test_a_versioned_delete_checks_the_document_its_key_names)
STORE, blobs by content typeStoreDocs E2E
Lua scripts on writesScriptingDocs E2E; tests/test_lua.cc, tests/fuzz_lua.cc; harness/lua_bounds.py
?version on every write, 409 with _versionVersioningDocs E2E; tests/test_node.cc (test_a_version_is_a_precondition_of_every_write, test_writers_expecting_one_version_apply_once, test_versioned_writers_match_a_sequential_model); tests/test_engine_strata.cc
FeaturePageTests
PUT of an index, settings, shards, name rulesCreateDocs E2E; harness/path_boundary_check.sh; tests/fuzz_index_path.cc
GET, HEAD, INFO of an indexGet, Exists, InfoDocs E2E
DELETE, CLOSE, OPEN of an index (501)Delete, CloseDocs E2E; harness/removed_features_check.sh
DUMP, RESTOREBackupsDocs E2E; Restore; harness/restore_schema_check.sh, harness/restore_stream_check.sh, harness/cli_roundtrip_check.sh
WAL, replay after a crashWALDocs E2E; tests/test_wal_replay.cc, tests/test_engine_replay.cc; harness/wal_recovery_check.sh, harness/wal_replay_check.sh, harness/wal_replay_agg_check.sh, harness/engine_crash_check.sh
Index patterns over several indexesAPIDocs E2E (SEARCH, COUNT); tests/test_index_pattern.cc, tests/fuzz_index_pattern.cc, tests/test_wide_search.cc; harness/wide_search_check.py
FeaturePageTests
The verbs, OPTIONS, 405 and 400 answers, statusesAPIDocs E2E
COMMIT, CHECK; FLUSH and QUIT without --admin-commands (405)APIDocs E2E
The limits (patterns, aggregation depth, body nesting)APIDocs E2E; harness/query_depth_check.py, harness/terms_cap_check.py
GET /, GET /:metricsAPI, OptionsDocs E2E; tests/test_root_routes.cc
HTTPSOptionsthe tls layer (the whole E2E over HTTPS); harness/tls_check.sh
Graceful stop, signalsOptionstests/test_node.cc; harness/graceful_shutdown_check.sh, harness/signal_check.sh
Refused options and data directories of earlier releasesUpgradingharness/removed_options_check.sh, harness/xapian_data_guard_check.sh; tests/test_xapian_data_guard.cc
FeaturePageTests
Field types (boolean, keyword, text, numeric, date and time, geospatial, UUID)Field Types and its pagesDocs E2E; Check Datatypes, Check DateType, UUID Field; tests/test_serialize.cc, tests/test_geospatial.cc, tests/test_engine_fields.cc
Dynamic typing and detectionDynamic TypingDocs E2E; harness/datetime_detection_check.py
Explicit and cast typesExplicit Types, Casting TypesDocs E2E
Namespaces, dynamic field namesNamespaces, Dynamic Field NamesDocs E2E; Namespace
Foreign schemasForeign SchemasDocs E2E; harness/restore_schema_check.sh
Accuracy, indexing mode, meta-dataAccuracy, Indexing Mode, Meta-dataDocs E2E; Global terms, Define Prefix, Define Slot; harness/numeric_range_check.py; tests/test_range_terms.cc, tests/test_generate_terms.cc
Null and empty values, arrays, objectsthe field type pagesNull type, Replace Value by Null, Empty Value, Arrays, Objects
FeaturePageTests
SEARCH, COUNT, limit, offset, sort, q, selector, collapseSearch APIDocs E2E; harness/strata_search_check.sh; tests/test_engine_search_strata.cc, tests/test_engine_sort.cc
The query DSL: leaf, compound and logical queries, ranges, castsQuery DSL and its pagesDocs E2E; Range Search, Fuzzy, Partial, Wildcard; tests/test_engine_query.cc; harness/query_depth_check.py
The query string grammarText QueriesDocs E2E; harness/boolean_query_check.py; tests/test_fieldparser.cc, tests/test_text.cc, tests/fuzz_text.cc
Metrics and bucket aggregationsAggregations and its pagesDocs E2E; harness/agg_buckets_check.py, harness/terms_cap_check.py; tests/test_metric_serialize.cc
Spatial searchSpatial SearchDocs E2E; tests/test_geospatial.cc
FeatureReason
FLUSH and QUIT with --admin-commandsThe E2E node runs without the option, and QUIT would stop it; their 405 is covered.
HEAD of a missing documentIt answers 404 with a JSON body, which newman cannot parse; the page states the 404.
A body over 16 MiB (413), streamed blobs up to 4 GiBToo large for a docs request.
4,096 clauses or 100 levels of a queryThe request would be pages long; harness/query_depth_check.py covers the depth.
Retry-After with 503 and 429Needs a loaded node.
check_at_least, volatile, spelling, synonyms, icaseNo effect a request can observe; the last three are read and ignored.
--max-search-indexes and the other startup optionsThe harness starts the node with its own options; Options documents them.