summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/StreamsApi.md
diff options
context:
space:
mode:
authorMax Nanis2026-02-18 20:42:03 -0500
committerMax Nanis2026-02-18 20:42:03 -0500
commit3eaa56f0306ead818f64c3d99fc6d230d9b970a4 (patch)
tree9fecc2f1456e6321572e0e65f57106916df173e2 /jb-ui/src/api_fsb/docs/StreamsApi.md
downloadamt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.tar.gz
amt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.zip
HERE WE GO, HERE WE GO, HERE WE GO
Diffstat (limited to 'jb-ui/src/api_fsb/docs/StreamsApi.md')
-rw-r--r--jb-ui/src/api_fsb/docs/StreamsApi.md104
1 files changed, 104 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/StreamsApi.md b/jb-ui/src/api_fsb/docs/StreamsApi.md
new file mode 100644
index 0000000..77826e6
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/StreamsApi.md
@@ -0,0 +1,104 @@
+# StreamsApi
+
+All URIs are relative to *https://fsb.generalresearch.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**websocketDebugPageWsDebugGet**](#websocketdebugpagewsdebugget) | **GET** /ws/debug/ | Websocket Debug Page|
+|[**websocketEventsDocsWsEventsDocsGet**](#websocketeventsdocswseventsdocsget) | **GET** /ws/events/docs/ | Websocket Events Docs|
+
+# **websocketDebugPageWsDebugGet**
+> string websocketDebugPageWsDebugGet()
+
+
+### Example
+
+```typescript
+import {
+ StreamsApi,
+ Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let productId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.websocketDebugPageWsDebugGet(
+ productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **productId** | [**string**] | | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/html, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response | - |
+|**422** | Validation Error | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **websocketEventsDocsWsEventsDocsGet**
+> ResponseWebsocketEventsDocsWsEventsDocsGet websocketEventsDocsWsEventsDocsGet()
+
+WebSocket endpoint: `/ws/events/` Protocol: - Client connects - Client sends a SubscribeMessage `{ kind: \"subscribe\", product_id: \"{product_id}\" }` - Server sends a PingMessage `{ kind: \"ping\" }` - Client must reply a PongMessage: `{ kind: \"pong\" }` - Other messages are EventMessage or StatsMessage Close on missing pong after 20s.
+
+### Example
+
+```typescript
+import {
+ StreamsApi,
+ Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+const { status, data } = await apiInstance.websocketEventsDocsWsEventsDocsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ResponseWebsocketEventsDocsWsEventsDocsGet**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+