Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Magmusacy wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4a8917
Add the Room History API reference
Magmusacy Oct 20, 2026
4bda8a8
Copy the Room History API spec from the cloud submodule
Magmusacy Oct 20, 2026
7eafe89
Update the Room History API spec
Magmusacy Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@
[submodule "packages/react-native-worklets"]
path = packages/react-native-worklets
url = https://github.com/fishjam-cloud/fishjam-react-native-worklets.git
[submodule "api/cloud"]
path = api/cloud
url = git@github.com:fishjam-cloud/cloud.git
1 change: 1 addition & 0 deletions api/cloud
Open in desktop
Submodule cloud added at 1f5ab0
24 changes: 24 additions & 0 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ const config: Config = {
items: [
{ to: "/api/rest", label: "Server API" },
{ to: "/api/compositions", label: "Composition API" },
{ to: "/api/room-history", label: "Room History API" },
],
},
{
Expand Down Expand Up @@ -410,6 +411,11 @@ const config: Config = {
slug: "composition",
url: "/docs/api/composition-openapi.json",
},
{
title: "Room History API",
slug: "room-history",
url: "/docs/api/room-history-openapi.json",
},
],
hideSearch: true,
persistAuth: true,
Expand Down Expand Up @@ -438,6 +444,24 @@ const config: Config = {
},
} as ScalarOptions,
],
[
"@scalar/docusaurus",
{
id: "room-history-api",
label: "Room History API",
route: "/api/room-history",
showNavLink: false,
configuration: {
url: "/docs/api/room-history-openapi.json",
hideSearch: true,
persistAuth: true,
defaultOpenFirstTag: false,
authentication: {
preferredSecurityScheme: "ManagementTokenAuth",
},
},
} as ScalarOptions,
],
[
"docusaurus-plugin-typedoc",
{
Expand Down
8 changes: 8 additions & 0 deletions scripts/update_api.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ copy_composition_openapi() {
echo "Copied openapi.json of composition to the assets directory."
}

copy_room_history_openapi() {
cp backend/openapi/diagnostics.json "$ASSETS_DIRECTORY/room-history-openapi.json"
echo "Copied diagnostics.json of cloud to the assets directory."
}

PROTO_FILES="server_notifications agent_notifications notifications/shared"
copy_protos() {
for file in $PROTO_FILES; do
Expand All @@ -74,4 +79,7 @@ copy_protos
checkout_submodule_branch composition $COMPOSITION_BRANCH
copy_composition_openapi

checkout_submodule cloud
copy_room_history_openapi

echo $'\nSubmodule update and copy complete.'
Loading
Loading