Skip to content
moxon home

6.1.0

API

API v6.1.0 — New @moxon/api name, experimental manifest export, security fixes.

  • The @20syldev/api package becomes @moxon/api, under the @moxon npm organization, and the repository now lives at moxondev/api. The old package no longer evolves; 6.1.0 is the first stable release published under the new name. The /v6 HTTP API is unchanged: to migrate, run npm uninstall @20syldev/api && npm install @moxon/api, then rename your imports — the sub-paths are identical. The details are in the migration guide.
  • New @moxon/api/manifest export, experimental: it exposes manifest, a typed ManifestEntry[] array that describes the endpoints as data — name, method, path, category, the first version that serves it (since), parameters and a request example — without the function that runs them. It is meant for tools that document or call the API. Only hash is listed for now, and its shape may still change in a minor version. See the Manifest page. Experimental
  • POST /hash is the first endpoint declared as a contract: the same declaration builds its HTTP route and its manifest entry, so the two can no longer drift apart. Its behaviour does not change: same parameters, same errors, same results from v4 to v6.
  • /favicon.ico is no longer served by the API: the file also leaves the package, which gets about 250 kB lighter.
  • Dependencies are updated for security fixes: proxy-addr, used by Express (a critical IP spoofing flaw through an IPv4-mapped IPv6 trust subnet), and brace-expansion, present only in the development tooling. These versions are pinned in the repository's package-lock.json: they protect clones and deployments done with npm ci.

Documentation

  • The documentation is now hosted on moxon.dev.
  • New documentation site, rebuilt with Next.js: a catalog of 49 endpoints in 7 categories, a keyboard search palette with the post: and get: filters, a dark theme and a layout made for phones.
  • Page addresses change: /v6/hash in English and /fr/v6/hash in French. The old addresses (/v6/fr/hash, /v6/en/hash) redirect automatically to the new ones.
  • Heading anchors are now the same in both languages (#response-fields); the old French fragments are redirected.
  • The home page example no longer calls the API on every visit.
  • The home page no longer shows the version cards: the version picker of the header replaces them.
  • Added the Manifest page, which presents the experimental @moxon/api/manifest export. Experimental
  • Added an installation section to the Getting Started page, with npm install @moxon/api and the package entry points.
  • Added a migration guide from @20syldev/api to the Changelog page: the commands, the import renaming table and the note on v1–v3.
  • Corrected the Tic-Tac-Toe documentation: POST /tic-tac-toe has answered 404 in v6 since 6.0.0, yet it was still presented as the game's main endpoint. The page, the sidebar and the Playground now rely on the /tic-tac-toe/play, /tic-tac-toe/forfeit, /tic-tac-toe/fetch and /tic-tac-toe/list routes. The migration table of the Changelog page now also lists the move of POST /tic-tac-toe to POST /tic-tac-toe/play.
  • Clarified on the Infos page what the endpoints field counts: the distinct paths of the requested version, so GET /chat and POST /chat count as one.
  • Added the encoding field to the response fields of POST /hash.