Skip to content

FCE-3915: Add the Room History API reference - #294

Open
Magmusacy wants to merge 3 commits into
mainfrom
FCE-3915
Open

Magmusacy wants to merge 3 commits into
mainfrom
FCE-3915

Conversation

@Magmusacy

@Magmusacy Magmusacy commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adds the Room History API reference at /api/room-history, rendered with Scalar like the other API references.

  • Page: a new Scalar instance in docusaurus.config.ts, plus a "Room History API" entry in the API Reference navbar menu
  • Spec: static/api/room-history-openapi.json, with descriptions for fields and enum values
  • Updates: yarn update-api now also copies this spec from its source submodule (.gitmodules, api/cloud)

Draft until

  • A release of the source repository includes the spec. Before that, yarn update-api fails.

@linear

linear Bot commented Oct 20, 2026

Copy link
Copy Markdown

FCE-3915

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The required upstream release containing the specification still needs confirmation before the API update workflow can be considered ready.

No open issues 🎉

What changed in this PR

Adds a Scalar-based Room History API reference alongside the existing API documentation.

Changes:

  • Adds the OpenAPI specification for room history and peer diagnostics.
  • Exposes /api/room-history through Scalar and API navigation.
  • Extends the API update script to copy the specification from the cloud submodule.
File Description
static/​api/​room-history-openapi.json Defines Room History endpoints, schemas, and authentication.
scripts/​update_api.sh Copies the Room History specification from cloud.
docusaurus.config.ts Registers the Scalar page and navigation entries.
.gitmodules Registers the cloud source submodule.

Review effort: Balanced

@Magmusacy
Magmusacy marked this pull request as ready for review October 20, 2026 18:17

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants