blob: 77826e6a8a55d0de361858710a104f736a03f8ae (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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)
|
