memos-api 0.3.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

# \UserServiceApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**user_service_create_user**](UserServiceApi.md#user_service_create_user) | **POST** /api/v1/users | CreateUser creates a new user.
[**user_service_create_user_access_token**](UserServiceApi.md#user_service_create_user_access_token) | **POST** /api/v1/{name}/access_tokens | CreateUserAccessToken creates a new access token for a user.
[**user_service_delete_user**](UserServiceApi.md#user_service_delete_user) | **DELETE** /api/v1/{name} | DeleteUser deletes a user.
[**user_service_delete_user_access_token**](UserServiceApi.md#user_service_delete_user_access_token) | **DELETE** /api/v1/{name}/access_tokens/{accessToken} | DeleteUserAccessToken deletes an access token for a user.
[**user_service_get_user**](UserServiceApi.md#user_service_get_user) | **GET** /api/v1/{name_1} | GetUser gets a user by name.
[**user_service_get_user_avatar_binary**](UserServiceApi.md#user_service_get_user_avatar_binary) | **GET** /file/{name}/avatar | GetUserAvatarBinary gets the avatar of a user.
[**user_service_get_user_setting**](UserServiceApi.md#user_service_get_user_setting) | **GET** /api/v1/{name}/setting | GetUserSetting gets the setting of a user.
[**user_service_list_user_access_tokens**](UserServiceApi.md#user_service_list_user_access_tokens) | **GET** /api/v1/{name}/access_tokens | ListUserAccessTokens returns a list of access tokens for a user.
[**user_service_list_users**](UserServiceApi.md#user_service_list_users) | **GET** /api/v1/users | ListUsers returns a list of users.
[**user_service_search_users**](UserServiceApi.md#user_service_search_users) | **GET** /api/v1/users:search | SearchUsers searches users by filter.
[**user_service_update_user**](UserServiceApi.md#user_service_update_user) | **PATCH** /api/v1/{user_name} | UpdateUser updates a user.
[**user_service_update_user_setting**](UserServiceApi.md#user_service_update_user_setting) | **PATCH** /api/v1/{setting_name} | UpdateUserSetting updates the setting of a user.



## user_service_create_user

> models::V1User user_service_create_user(user)
CreateUser creates a new user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user** | [**V1User**](V1User.md) |  | [required] |

### Return type

[**models::V1User**](v1User.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## user_service_create_user_access_token

> models::V1UserAccessToken user_service_create_user_access_token(name, body)
CreateUserAccessToken creates a new access token for a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the user. Format: users/{id} | [required] |
**body** | [**UserServiceCreateUserAccessTokenBody**](UserServiceCreateUserAccessTokenBody.md) |  | [required] |

### Return type

[**models::V1UserAccessToken**](v1UserAccessToken.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## user_service_delete_user

> serde_json::Value user_service_delete_user(name)
DeleteUser deletes a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the user. Format: users/{id} | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_delete_user_access_token

> serde_json::Value user_service_delete_user_access_token(name, access_token)
DeleteUserAccessToken deletes an access token for a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the user. Format: users/{id} | [required] |
**access_token** | **String** | access_token is the access token to delete. | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_get_user

> models::V1User user_service_get_user(name_1)
GetUser gets a user by name.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name_1** | **String** | The name of the user. Format: users/{id} | [required] |

### Return type

[**models::V1User**](v1User.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_get_user_avatar_binary

> models::ApiHttpBody user_service_get_user_avatar_binary(name, http_body_period_content_type, http_body_period_data)
GetUserAvatarBinary gets the avatar of a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the user. Format: users/{id} | [required] |
**http_body_period_content_type** | Option<**String**> | The HTTP Content-Type header value specifying the content type of the body. |  |
**http_body_period_data** | Option<**String**> | The HTTP request/response body as raw binary. |  |

### Return type

[**models::ApiHttpBody**](apiHttpBody.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_get_user_setting

> models::Apiv1UserSetting user_service_get_user_setting(name)
GetUserSetting gets the setting of a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the user. Format: users/{id} | [required] |

### Return type

[**models::Apiv1UserSetting**](apiv1UserSetting.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_list_user_access_tokens

> models::V1ListUserAccessTokensResponse user_service_list_user_access_tokens(name)
ListUserAccessTokens returns a list of access tokens for a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the user. Format: users/{id} | [required] |

### Return type

[**models::V1ListUserAccessTokensResponse**](v1ListUserAccessTokensResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_list_users

> models::V1ListUsersResponse user_service_list_users()
ListUsers returns a list of users.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::V1ListUsersResponse**](v1ListUsersResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_search_users

> models::V1SearchUsersResponse user_service_search_users(filter)
SearchUsers searches users by filter.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**filter** | Option<**String**> | Filter is used to filter users returned in the list. Format: \"username == 'frank'\" |  |

### Return type

[**models::V1SearchUsersResponse**](v1SearchUsersResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## user_service_update_user

> models::V1User user_service_update_user(user_name, user)
UpdateUser updates a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_name** | **String** | The name of the user. Format: users/{id} | [required] |
**user** | [**UserServiceUpdateUserRequest**](UserServiceUpdateUserRequest.md) |  | [required] |

### Return type

[**models::V1User**](v1User.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## user_service_update_user_setting

> models::Apiv1UserSetting user_service_update_user_setting(setting_name, setting)
UpdateUserSetting updates the setting of a user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**setting_name** | **String** | The name of the user. Format: users/{id} | [required] |
**setting** | [**UserServiceUpdateUserSettingRequest**](UserServiceUpdateUserSettingRequest.md) |  | [required] |

### Return type

[**models::Apiv1UserSetting**](apiv1UserSetting.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)