m0rph3us1987/HIPCTF2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation to OKF v0.1 format

Browse Source
This commit is contained in:
OpenVelo Agent
2026-07-22 16:16:20 +00:00
parent 4656a5b082
commit ae159f4f73
4 changed files with 45 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/system.md
+11 -3
View File
@@ -1,9 +1,9 @@
---
type: api
title: System Endpoints
description: Bootstrap payload, public event status, public/authenticated SSE streams, and public event-window timestamps.
tags: [api, system, bootstrap, event, sse, settings]
timestamp: 2026-07-22T13:40:00Z
description: Bootstrap payload, public event status, public/authenticated SSE streams, and public event-window timestamps; the public `event/stream` also forwards `general` topic frames carrying `registrationsEnabled`.
tags: [api, system, bootstrap, event, sse, settings, registrations]
timestamp: 2026-07-22T16:15:00Z
---
# Endpoints
@@ -130,6 +130,14 @@ Public, flattened event stream that emits the legacy payload shape
1-second tick and on hub pushes. Preserved for backward compatibility
with the original landing page status badge.
`admin/general` updates are also broadcast on this stream as
`{ topic: 'general', themeKey, registrationsEnabled }` so the public
landing page can refresh its cached bootstrap whenever an admin toggles
the registrations flag (or any other general setting) without forcing
the user to hard-refresh. The frame is interleaved with the legacy
event-status frames. The legacy event-status frames are still emitted
on the 1-second tick so existing consumers are unaffected.
# `GET /api/v1/scoreboard/stream`
Public SSE stream that pushes a flattened solve payload whenever a new