Skip to content

Query parameters

Nerthus.Core (until cutover). This page describes the frozen system that runs today and is deleted at cutover. Replaced by: not yet written.

Every query parameter the route table declares, per route, and which of them any example on this site actually sends.

This table is generated. Its population is nerthus.core's tests/doc-params-declared.psd1, which that repository's own suite holds to the live route table and to this reference in both directions. Nothing here is typed:

python3 ci/generate-reference-tables.py          # rewrite the block below
python3 ci/generate-reference-tables.py --check  # what CI runs

Why an unproven parameter is worth counting

The daemon fails open on an unrecognised query name. A parameter renamed in the code and left in the documentation does not produce a refusal; it produces a plausible answer computed without it. Nothing else in the estate would notice, which is what makes the proven column the interesting one.

Proven means one thing exactly: an example on this site sends that name on that route, and the replay in nerthus.core executes it. It does not mean the parameter is proven well - an example sending ?limit=1 proves the name is accepted and not that the limit is applied.

It is a count and not a rate. Every way this reference thins out produces fewer proofs that all still pass, so a percentage would rise as the reference got worse.

The table

155 routes declare 289 parameter slots over 71 distinct names. 49 slots are sent by an example on this site, over 22 names.

Route Declares Proven by an example
DELETE /v1/api/characters/{name} dryRun · type —
DELETE /v1/api/characters/{name}/info dryRun —
DELETE /v1/api/currency/{name} dryRun · type —
DELETE /v1/api/edits/{eid} dryRun —
DELETE /v1/api/edits/{eid}/entries/{n} dryRun —
DELETE /v1/api/entities/{name} dryRun · type —
DELETE /v1/api/moderation/records/{id}/wraps dryRun —
DELETE /v1/api/people/{name} dryRun · type —
DELETE /v1/api/tokens/{id} dryRun —
GET /v1/api/audit/notifications operation —
GET /v1/api/characters/{name} activeOn —
GET /v1/api/characters/{name}/info activeOn —
GET /v1/api/claims/lint fresh fresh
GET /v1/api/currency activeOn —
GET /v1/api/currency/report denomination · owner owner
GET /v1/api/currency/{name} activeOn —
GET /v1/api/discord/deliveries operation —
GET /v1/api/economy/materialization activeOn —
GET /v1/api/economy/snapshot activeOn —
GET /v1/api/economy/timeline from · to —
GET /v1/api/edits/{eid} content —
GET /v1/api/elections/eligibility asOf · gracz —
GET /v1/api/entities activeOn · group · limit · location · name · offset · status · type type
GET /v1/api/entities/links activeOn · withFile —
GET /v1/api/entities/search activeOn · limit · name · offset · q · type q
GET /v1/api/entities/{name} activeOn —
GET /v1/api/entities/{name}/dossier asOf —
GET /v1/api/entities/{name}/file activeOn · type —
GET /v1/api/entities/{name}/hits from · limit · location · offset · session · speaker · text · to · type text
GET /v1/api/entities/{name}/lines from · limit · location · offset · session · speaker · text · to · type limit
GET /v1/api/entities/{name}/mentions from · limit · offset · to —
GET /v1/api/entities/{name}/path activeOn · type —
GET /v1/api/entities/{name}/scenes from · limit · location · offset · order · radius · session · speaker · text · to · type limit · order · radius
GET /v1/api/entities/{name}/timeline from · to from · to
GET /v1/api/events/journal limit · since —
GET /v1/api/files path path
GET /v1/api/files/content path · section path
GET /v1/api/gitlab/jobs/{id}/trace project · tail project
GET /v1/api/gitlab/pipelines limit limit
GET /v1/api/gitlab/pipelines/{id} project project
GET /v1/api/governance/narrator-signals at —
GET /v1/api/governance/permissions id id
GET /v1/api/governance/pin at —
GET /v1/api/governance/{ref} at —
GET /v1/api/governance/{ref}/held at · subject —
GET /v1/api/governance/{ref}/log since · until —
GET /v1/api/hygiene/orphans limit —
GET /v1/api/locations outerior · parent · region —
GET /v1/api/logs/archive/{log} include —
GET /v1/api/logs/lines entity · from · limit · location · offset · session · speaker · text · to · type —
GET /v1/api/logs/speakers unresolved unresolved
GET /v1/api/maps/layout activeOn —
GET /v1/api/model/evaluation artifact · surface —
GET /v1/api/model/ledger limit · offset · surface —
GET /v1/api/model/runs limit · offset —
GET /v1/api/model/state surface —
GET /v1/api/moderation/records epoch · from · subject · to —
GET /v1/api/normalization/suggestions entity · limit · minConfidence · offset · session · surface limit · surface
GET /v1/api/people/{name} activeOn —
GET /v1/api/people/{name}/characters activeOn —
GET /v1/api/players/resolve margonemid · nick —
GET /v1/api/pu/new-character-count player player
GET /v1/api/pu/timeline character character
GET /v1/api/regions activeOn —
GET /v1/api/regions/{name} activeOn · recurse activeOn
GET /v1/api/regulations/effective at —
GET /v1/api/regulations/{doc}/{version} diff —
GET /v1/api/regulations/{doc}/{version}/points podstawa —
GET /v1/api/search asOf · diegesis · from · kind · limit · offset · q · scope · to —
GET /v1/api/search/zero-results limit —
GET /v1/api/sejf/blob path · ref —
GET /v1/api/sejf/inventory ref —
GET /v1/api/sessions entity · fields · from · limit · narrator · offset · to narrator
GET /v1/api/sessions/divergence beyondWhitespace —
GET /v1/api/sessions/integrity month —
GET /v1/api/sessions/open narrator narrator
GET /v1/api/sessions/summary entity · fields · from · limit · narrator · offset · to fields · narrator
GET /v1/api/sessions/{header}/logs include · speaker —
GET /v1/api/training/finetune/export evalShare · format · grade · seed · set · split —
GET /v1/api/training/finetune/samples grade · limit · offset · origin · project · set —
GET /v1/api/training/samples class · entity · grade · label · limit · offset · project · scope —
PATCH /v1/api/characters/{name} dryRun · type —
PATCH /v1/api/config/schedules/{workload} dryRun —
PATCH /v1/api/currency/{name} dryRun · type —
PATCH /v1/api/entities/{name} dryRun · type —
PATCH /v1/api/governance/permissions/{nick} dryRun dryRun
PATCH /v1/api/locations/{name} dryRun · type —
PATCH /v1/api/maps/{name} dryRun · type —
PATCH /v1/api/people/{name} dryRun · type —
PATCH /v1/api/regions/{name} dryRun · type —
PATCH /v1/api/sessions/{header} dryRun —
POST /v1/api/api-keys dryRun —
POST /v1/api/auth/link dryRun —
POST /v1/api/capabilities/grant dryRun dryRun
POST /v1/api/capabilities/revoke dryRun dryRun
POST /v1/api/characters dryRun —
POST /v1/api/characters/{name}/info dryRun —
POST /v1/api/currency dryRun dryRun
POST /v1/api/edits dryRun —
POST /v1/api/edits/{eid}/publish dryRun —
POST /v1/api/entities dryRun dryRun
POST /v1/api/entities/{name}/name dryRun —
POST /v1/api/gitlab/jobs/{id}/play project —
POST /v1/api/gitlab/pipelines/{id}/retry project project
POST /v1/api/keyrings/{name}/epochs dryRun —
POST /v1/api/keys/claims dryRun —
POST /v1/api/locations dryRun dryRun
POST /v1/api/locations/reindex dryRun dryRun
POST /v1/api/logs/archive/reparse async · dryRun · force dryRun
POST /v1/api/logs/fetch dryRun —
POST /v1/api/logs/import dryRun dryRun
POST /v1/api/logs/index/rebuild async —
POST /v1/api/maps dryRun dryRun
POST /v1/api/maps/dimensions dryRun —
POST /v1/api/maps/layout dryRun · force —
POST /v1/api/maps/traversal dryRun —
POST /v1/api/model/promote dryRun —
POST /v1/api/model/rollback dryRun —
POST /v1/api/model/runs dryRun —
POST /v1/api/moderation/disclosures dryRun —
POST /v1/api/moderation/exports dryRun —
POST /v1/api/moderation/records dryRun —
POST /v1/api/normalization/aliases/accept dryRun dryRun
POST /v1/api/people dryRun —
POST /v1/api/recovery/documents dryRun —
POST /v1/api/regions dryRun —
POST /v1/api/regulations/{doc}/versions dryRun —
POST /v1/api/search/index/rebuild async —
POST /v1/api/session-registry/regenerate dryRun dryRun
POST /v1/api/sessions dryRun dryRun
POST /v1/api/sessions/hash dryRun —
POST /v1/api/sessions/report dryRun —
POST /v1/api/sessions/{header}/bindings dryRun —
POST /v1/api/sessions/{header}/logs/refresh dryRun · include —
POST /v1/api/sessions/{header}/rebaseline dryRun —
POST /v1/api/tokens dryRun —
POST /v1/api/training/finetune/samples/confirm dryRun —
POST /v1/api/training/finetune/samples/confirmations dryRun —
POST /v1/api/training/samples/confirm dryRun —
POST /v1/api/training/samples/confirmations dryRun —
POST /v1/api/workflows/apply-transfers dryRun dryRun
POST /v1/api/workflows/award-pu async · dryRun async · dryRun
POST /v1/api/workflows/close-session dryRun dryRun
POST /v1/api/workflows/close-session-by-discord dryRun —
POST /v1/api/workflows/distribute-session dryRun dryRun
POST /v1/api/workflows/finalize-close dryRun —
POST /v1/api/workflows/map-checkup dimensions · dryRun dryRun
POST /v1/api/workflows/open-session dryRun dryRun
POST /v1/api/workflows/assign-by-discord dryRun —
POST /v1/api/workflows/register-by-discord dryRun —
POST /v1/api/workflows/report-session-by-discord dryRun —
POST /v1/api/workflows/settle dryRun dryRun
PUT /v1/api/characters/{name}/info dryRun —
PUT /v1/api/edits/{eid}/entries dryRun —
PUT /v1/api/people/{name}/discord-channel dryRun —

Every declared name, and whether any example sends it:

activeOn · artifact · asOf · async · at · beyondWhitespace · character · class · content · denomination · diegesis · diff · dimensions · dryRun · entity · epoch · evalShare · fields · force · format · fresh · from · gracz · grade · group · id · include · kind · label · limit · location · margonemid · minConfidence · month · name · narrator · nick · offset · operation · order · origin · outerior · owner · parent · path · player · podstawa · project · q · radius · recurse · ref · region · scope · section · seed · session · set · since · speaker · split · status · subject · surface · tail · text · to · type · unresolved · until · withFile

See also