|
| 1 | +# WhiteboardApi |
| 2 | + |
| 3 | +All URIs are relative to *http://server:8080* |
| 4 | + |
| 5 | +|Method | HTTP request | Description| |
| 6 | +|------------- | ------------- | -------------| |
| 7 | +|[**createWhiteboard**](#createwhiteboard) | **POST** /whiteboards | Create whiteboard| |
| 8 | +|[**deleteWhiteboard**](#deletewhiteboard) | **DELETE** /whiteboards/{id} | Delete whiteboard| |
| 9 | +|[**getWhiteboardByIdAndUserId**](#getwhiteboardbyidanduserid) | **GET** /whiteboards/{id} | | |
| 10 | +|[**getWhiteboardsByUserId**](#getwhiteboardsbyuserid) | **GET** /whiteboards | Get whiteboards by user ID| |
| 11 | +|[**updateTitle**](#updatetitle) | **PUT** /whiteboards/{id}/title | Update title| |
| 12 | + |
| 13 | +# **createWhiteboard** |
| 14 | +> Whiteboard createWhiteboard(createWhiteboardRequest) |
| 15 | +
|
| 16 | +Creates a new whiteboard for a user. |
| 17 | + |
| 18 | +### Example |
| 19 | + |
| 20 | +```typescript |
| 21 | +import { |
| 22 | + WhiteboardApi, |
| 23 | + Configuration, |
| 24 | + CreateWhiteboardRequest |
| 25 | +} from './api'; |
| 26 | + |
| 27 | +const configuration = new Configuration(); |
| 28 | +const apiInstance = new WhiteboardApi(configuration); |
| 29 | + |
| 30 | +let createWhiteboardRequest: CreateWhiteboardRequest; // |
| 31 | + |
| 32 | +const { status, data } = await apiInstance.createWhiteboard( |
| 33 | + createWhiteboardRequest |
| 34 | +); |
| 35 | +``` |
| 36 | + |
| 37 | +### Parameters |
| 38 | + |
| 39 | +|Name | Type | Description | Notes| |
| 40 | +|------------- | ------------- | ------------- | -------------| |
| 41 | +| **createWhiteboardRequest** | **CreateWhiteboardRequest**| | | |
| 42 | + |
| 43 | + |
| 44 | +### Return type |
| 45 | + |
| 46 | +**Whiteboard** |
| 47 | + |
| 48 | +### Authorization |
| 49 | + |
| 50 | +No authorization required |
| 51 | + |
| 52 | +### HTTP request headers |
| 53 | + |
| 54 | + - **Content-Type**: application/json |
| 55 | + - **Accept**: */* |
| 56 | + |
| 57 | + |
| 58 | +### HTTP response details |
| 59 | +| Status code | Description | Response headers | |
| 60 | +|-------------|-------------|------------------| |
| 61 | +|**200** | OK | - | |
| 62 | + |
| 63 | +[[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) |
| 64 | + |
| 65 | +# **deleteWhiteboard** |
| 66 | +> deleteWhiteboard() |
| 67 | +
|
| 68 | +Deletes a whiteboard by its ID. |
| 69 | + |
| 70 | +### Example |
| 71 | + |
| 72 | +```typescript |
| 73 | +import { |
| 74 | + WhiteboardApi, |
| 75 | + Configuration |
| 76 | +} from './api'; |
| 77 | + |
| 78 | +const configuration = new Configuration(); |
| 79 | +const apiInstance = new WhiteboardApi(configuration); |
| 80 | + |
| 81 | +let id: number; // (default to undefined) |
| 82 | + |
| 83 | +const { status, data } = await apiInstance.deleteWhiteboard( |
| 84 | + id |
| 85 | +); |
| 86 | +``` |
| 87 | + |
| 88 | +### Parameters |
| 89 | + |
| 90 | +|Name | Type | Description | Notes| |
| 91 | +|------------- | ------------- | ------------- | -------------| |
| 92 | +| **id** | [**number**] | | defaults to undefined| |
| 93 | + |
| 94 | + |
| 95 | +### Return type |
| 96 | + |
| 97 | +void (empty response body) |
| 98 | + |
| 99 | +### Authorization |
| 100 | + |
| 101 | +No authorization required |
| 102 | + |
| 103 | +### HTTP request headers |
| 104 | + |
| 105 | + - **Content-Type**: Not defined |
| 106 | + - **Accept**: Not defined |
| 107 | + |
| 108 | + |
| 109 | +### HTTP response details |
| 110 | +| Status code | Description | Response headers | |
| 111 | +|-------------|-------------|------------------| |
| 112 | +|**200** | OK | - | |
| 113 | + |
| 114 | +[[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) |
| 115 | + |
| 116 | +# **getWhiteboardByIdAndUserId** |
| 117 | +> Whiteboard getWhiteboardByIdAndUserId() |
| 118 | +
|
| 119 | + |
| 120 | +### Example |
| 121 | + |
| 122 | +```typescript |
| 123 | +import { |
| 124 | + WhiteboardApi, |
| 125 | + Configuration |
| 126 | +} from './api'; |
| 127 | + |
| 128 | +const configuration = new Configuration(); |
| 129 | +const apiInstance = new WhiteboardApi(configuration); |
| 130 | + |
| 131 | +let id: number; // (default to undefined) |
| 132 | +let userId: number; // (default to undefined) |
| 133 | + |
| 134 | +const { status, data } = await apiInstance.getWhiteboardByIdAndUserId( |
| 135 | + id, |
| 136 | + userId |
| 137 | +); |
| 138 | +``` |
| 139 | + |
| 140 | +### Parameters |
| 141 | + |
| 142 | +|Name | Type | Description | Notes| |
| 143 | +|------------- | ------------- | ------------- | -------------| |
| 144 | +| **id** | [**number**] | | defaults to undefined| |
| 145 | +| **userId** | [**number**] | | defaults to undefined| |
| 146 | + |
| 147 | + |
| 148 | +### Return type |
| 149 | + |
| 150 | +**Whiteboard** |
| 151 | + |
| 152 | +### Authorization |
| 153 | + |
| 154 | +No authorization required |
| 155 | + |
| 156 | +### HTTP request headers |
| 157 | + |
| 158 | + - **Content-Type**: Not defined |
| 159 | + - **Accept**: */* |
| 160 | + |
| 161 | + |
| 162 | +### HTTP response details |
| 163 | +| Status code | Description | Response headers | |
| 164 | +|-------------|-------------|------------------| |
| 165 | +|**200** | OK | - | |
| 166 | + |
| 167 | +[[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) |
| 168 | + |
| 169 | +# **getWhiteboardsByUserId** |
| 170 | +> Array<Whiteboard> getWhiteboardsByUserId() |
| 171 | +
|
| 172 | +Returns a list of whiteboards for the given user ID. |
| 173 | + |
| 174 | +### Example |
| 175 | + |
| 176 | +```typescript |
| 177 | +import { |
| 178 | + WhiteboardApi, |
| 179 | + Configuration |
| 180 | +} from './api'; |
| 181 | + |
| 182 | +const configuration = new Configuration(); |
| 183 | +const apiInstance = new WhiteboardApi(configuration); |
| 184 | + |
| 185 | +let userId: number; // (default to undefined) |
| 186 | + |
| 187 | +const { status, data } = await apiInstance.getWhiteboardsByUserId( |
| 188 | + userId |
| 189 | +); |
| 190 | +``` |
| 191 | + |
| 192 | +### Parameters |
| 193 | + |
| 194 | +|Name | Type | Description | Notes| |
| 195 | +|------------- | ------------- | ------------- | -------------| |
| 196 | +| **userId** | [**number**] | | defaults to undefined| |
| 197 | + |
| 198 | + |
| 199 | +### Return type |
| 200 | + |
| 201 | +**Array<Whiteboard>** |
| 202 | + |
| 203 | +### Authorization |
| 204 | + |
| 205 | +No authorization required |
| 206 | + |
| 207 | +### HTTP request headers |
| 208 | + |
| 209 | + - **Content-Type**: Not defined |
| 210 | + - **Accept**: */* |
| 211 | + |
| 212 | + |
| 213 | +### HTTP response details |
| 214 | +| Status code | Description | Response headers | |
| 215 | +|-------------|-------------|------------------| |
| 216 | +|**200** | OK | - | |
| 217 | + |
| 218 | +[[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) |
| 219 | + |
| 220 | +# **updateTitle** |
| 221 | +> Whiteboard updateTitle() |
| 222 | +
|
| 223 | +Updates the title of an existing whiteboard. |
| 224 | + |
| 225 | +### Example |
| 226 | + |
| 227 | +```typescript |
| 228 | +import { |
| 229 | + WhiteboardApi, |
| 230 | + Configuration |
| 231 | +} from './api'; |
| 232 | + |
| 233 | +const configuration = new Configuration(); |
| 234 | +const apiInstance = new WhiteboardApi(configuration); |
| 235 | + |
| 236 | +let id: number; // (default to undefined) |
| 237 | +let title: string; // (default to undefined) |
| 238 | + |
| 239 | +const { status, data } = await apiInstance.updateTitle( |
| 240 | + id, |
| 241 | + title |
| 242 | +); |
| 243 | +``` |
| 244 | + |
| 245 | +### Parameters |
| 246 | + |
| 247 | +|Name | Type | Description | Notes| |
| 248 | +|------------- | ------------- | ------------- | -------------| |
| 249 | +| **id** | [**number**] | | defaults to undefined| |
| 250 | +| **title** | [**string**] | | defaults to undefined| |
| 251 | + |
| 252 | + |
| 253 | +### Return type |
| 254 | + |
| 255 | +**Whiteboard** |
| 256 | + |
| 257 | +### Authorization |
| 258 | + |
| 259 | +No authorization required |
| 260 | + |
| 261 | +### HTTP request headers |
| 262 | + |
| 263 | + - **Content-Type**: Not defined |
| 264 | + - **Accept**: */* |
| 265 | + |
| 266 | + |
| 267 | +### HTTP response details |
| 268 | +| Status code | Description | Response headers | |
| 269 | +|-------------|-------------|------------------| |
| 270 | +|**200** | OK | - | |
| 271 | + |
| 272 | +[[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) |
| 273 | + |
0 commit comments