HTTP API docs: an OpenAPI 3.1 description and a reference to try it
- github
- github/openchronology/timeline-app
- commit
- main
- github/athanclark
The server's HTTP API is described in OpenAPI 3.1 (#178): server/openapi/, one module for each area (timelines, collaboration, accounts, community) sharing common.mjs, 92 operations and 97 schemas. It is served at /api/openapi.json, for Swagger UI, Postman or code generators, and the reference at /docs/api reads it: operations by tag, who may call each, parameters, bodies and responses, a filter, and Try it, which sends a request as the signed-in account or with an API key. It runs under the site's content security policy with no third-party code. - openapi.test.mjs: the description is well formed and complete, and every route server/http.mjs names (paths, patterns, timeline actions, account steps, administration) is described. - openapi-postgres.mjs: every described operation reaches a route of the running server. Describing browser-fork found that guests could not copy a public timeline into their browser: the check for accounts that supply data refused them with 401. It no longer applies to that copy, which only reads. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_011fFY8eruEi1xAkkMBni13B https://github.com/openchronology/timeline-app/commit/14071ff139c5a55e976b666f45802dfd34ddf6d5
Related
Open HTTP API docs: an OpenAPI 3.1 description and a reference to try it in the timeline