It's definitely time to write a changelog for "important" changes to the docs.
Date format: [DD.MM.YYYY]
- Documented lightweight WebSocket
ping/pongkeepalive messages (websocket.md, quickInfo.md) - Added client-side WebSocket heartbeat (
ping/pong) to TS/JS client (clients/TypeScript-JavaScript/NeuroInfoAPI-Client.ts) - Fixed Twitch stream
startedAttimestamp format in docs and TS/JS client type (twitch.md; NeuroInfoAPI-Client.ts)
- Corrected
/api/v1/twitch/vodquick reference wording to clearly describe streamId-based lookup (quickInfo.md) - Updated error code of WebSocket handshake (errors.md)
- Added
/schedule/weeksdocumentation(schedule.md; quickInfo.md; needsAuth.md) - Updated schedule cache note for
/schedule/latestto 1 minute (schedule.md) - Updated
/subathon/yearsdocs for optional?detailedmode including response examples (subathon.md; quickInfo.md; needsAuth.md) - Updated TypeScript client signatures/types for
/schedule/weeksand/subathon/yearsdetailed mode (clients/TypeScript-JavaScript/NeuroInfoAPI-Client.ts)
- Added deepwiki badge to README (README.md)
- Added deepwiki steer config (.devin/wiki.json)
- Fixed npm package name mispelling (clients/README.md; clients/TypeScript-JavaScript/README.md)
- Corrected
/twitch/voddocs:streamIdis required; updated error status sections (twitch.md; quickInfo.md) - Corrected
/subathon/currentsuccess response to array format and clarified behavior (subathon.md) - Clarified effective page size behavior for
/schedule/searchlimitparameter (schedule.md) - Added missing schedule search error codes
SC3andSC4to error code reference (errors.md) - Updated response format wording to reflect endpoint-specific success payloads (README.md; errors.md)
- Added full WebSocket
invalid.reasonvalue list (websocket.md) - Synced TypeScript client VOD method to current API (
streamIdrequired, removed latest-VOD shortcut) (clients/TypeScript-JavaScript/NeuroInfoAPI-Client.ts)
- Added
/schedule/searchendpoint docs & JS/TS client method (schedule.md; clients/README.md; NeuroInfoAPI-Client.ts) - Added new NPM package info to clients docs (clients/README.md)
- Updated calendar week of oldest schedule in schedule docs (schedule.md)
- Added WebSocket API docs for ticket flow, handshake auth, events, message format, and errors (websocket.md)
- Updated quick reference with WebSocket endpoints and event overview (quickInfo.md)
- Updated authentication overview with WebSocket ticket/auth requirements (needsAuth.md)
- Updated docs index with WebSocket API section (README.md)
- Updated error documentation with WebSocket handshake/message error behavior (errors.md)
- TS-Client docs: Added WebSocket client usage and event list (clients/README.md)
- TS-Client: Moved client files to new "TypeScript-JavaScript" subfolder (changed structure) (clients/README.md; NeuroInfoAPI-Client.ts)
- Clients: Added Client as JS with type definitions and WebSocket support (NeuroInfoAPI-Client.js, NeuroInfoAPI-Client.d.ts)
- Updated some descriptions & comments in the TS client (NeuroInfoAPI-Client)
- TS-Client: Fixed type of startedAt in TwitchStreamData interface (NeuroInfoAPI-Client)
- TS-Client: Added forgotten method for subathon years endpoint(NeuroInfoAPI-Client)
- TS-Client: Updated method descriptions (NeuroInfoAPI-Client)
- TS-Client: Added better error handling (clients/README.md; NeuroInfoAPI-Client)
- TS-Client: Added event system (clients/README.md; NeuroInfoAPI-Client)
- Added 'hasActiveSubathon' as an get latest schedule property (schedule.md)
- TS-Client: Added 'hasActiveSubathon' (NeuroInfoAPI-Client)
- Added subathon year list endpoint docs (subathons.md)
- Added 'canceled' as an day type value (schedule.md)
- TS-Client: Added 'canceled' to type ScheduleEntry (NeuroInfoAPI-Client)
- Added Schedule response properties + isFinal property (schedule.md)
- TS-Client: Added isFinal property to ScheduleResponse interface (NeuroInfoAPI-Client)
- Added Changelog file (CHANGELOG.md)
- Added Missing endpoint infos (needsAuth.md; schedule.md)
- Added Error testing docs (errors.md)
- Updated schedule docs (schedule.md)
- Added docs for new endpoint for devstream times (quickinfo.md; schedule.md)
- Removed redundant text (schedule.md; subathons.md; twitch.md)
- Fixed examples (twitch.md)
- TS-Client: Fixed typo (NeuroInfoAPI-Client)
- TS-Client: Made Axios Instance public (NeuroInfoAPI-Client)
- Added TS client & docs (NeuroInfoAPI-Client; clients/README.md; README.md)